Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HolographicSlate

Class used to create a holographic slate

Hierarchy

Implements

Index

Constructors

constructor

  • Creates a new slate

    Parameters

    • Optional name: string

      defines the control name

    Returns HolographicSlate

Properties

backPlateMarginSearch playground for backPlateMargin

backPlateMargin: number

Margin between backplate and contentplate

backplateDimensionsSearch playground for backplateDimensions

backplateDimensions: Vector3

Dimensions of the backplate

Readonly defaultDimensionsSearch playground for defaultDimensions

defaultDimensions: Vector3

Default dimensions of the slate

dimensionsSearch playground for dimensions

dimensions: Vector3

Dimensions of the slate

minDimensionsSearch playground for minDimensions

minDimensions: Vector3

Minimum dimensions of the slate

Optional nameSearch playground for name

name: string | undefined

Defines the control name

onPointerClickObservableSearch playground for onPointerClickObservable

onPointerClickObservable: Observable<Vector3WithInfo>

An event triggered when a control is clicked on (with a mouse)

onPointerDownObservableSearch playground for onPointerDownObservable

onPointerDownObservable: Observable<Vector3WithInfo>

An event triggered when the pointer taps the control

onPointerEnterObservableSearch playground for onPointerEnterObservable

onPointerEnterObservable: Observable<Control3D>

An event triggered when pointer enters the control

onPointerMoveObservableSearch playground for onPointerMoveObservable

onPointerMoveObservable: Observable<Vector3>

An event triggered when the pointer move over the control

onPointerOutObservableSearch playground for onPointerOutObservable

onPointerOutObservable: Observable<Control3D>

An event triggered when the pointer move out of the control

onPointerUpObservableSearch playground for onPointerUpObservable

onPointerUpObservable: Observable<Vector3WithInfo>

An event triggered when pointer is up

originSearch playground for origin

origin: Vector3

Origin in local coordinates (top left corner)

parentSearch playground for parent

Gets or sets the parent container

pointerDownAnimationSearch playground for pointerDownAnimation

pointerDownAnimation: () => void

Callback used to start pointer down animation

Type declaration

    • (): void
    • Returns void

pointerEnterAnimationSearch playground for pointerEnterAnimation

pointerEnterAnimation: () => void

Callback used to start pointer enter animation

Type declaration

    • (): void
    • Returns void

pointerOutAnimationSearch playground for pointerOutAnimation

pointerOutAnimation: () => void

Callback used to start pointer out animation

Type declaration

    • (): void
    • Returns void

pointerUpAnimationSearch playground for pointerUpAnimation

pointerUpAnimation: () => void

Callback used to start pointer up animation

Type declaration

    • (): void
    • Returns void

Static ASSETS_BASE_URLSearch playground for ASSETS_BASE_URL

ASSETS_BASE_URL: string

Base Url for the assets.

Static CLOSE_ICON_FILENAMESearch playground for CLOSE_ICON_FILENAME

CLOSE_ICON_FILENAME: string

File name for the close icon.

Static FOLLOW_ICON_FILENAMESearch playground for FOLLOW_ICON_FILENAME

FOLLOW_ICON_FILENAME: string

File name for the close icon.

Accessors

behaviors

content

  • Gets or sets the GUI 2D content used to display the button's facade

    Returns Control

  • Gets or sets the GUI 2D content used to display the button's facade

    Parameters

    Returns any

contentResolution

  • get contentResolution(): number
  • set contentResolution(value: number): any
  • Gets or sets the texture resolution used to render content (512 by default)

    Returns number

  • Gets or sets the texture resolution used to render content (512 by default)

    Parameters

    • value: number

    Returns any

defaultBehavior

  • Regroups all mesh behaviors for the slate

    Returns DefaultBehavior

imageUrl

  • get imageUrl(): string
  • set imageUrl(value: string): any
  • Gets or sets the image url for the button

    Returns string

  • Gets or sets the image url for the button

    Parameters

    • value: string

    Returns any

isVisible

  • get isVisible(): boolean
  • set isVisible(value: boolean): any
  • Gets or sets a boolean indicating if the control is visible

    Returns boolean

  • Gets or sets a boolean indicating if the control is visible

    Parameters

    • value: boolean

    Returns any

mesh

node

position

  • Gets or sets the control position in world space

    Returns Vector3

  • Gets or sets the control position in world space

    Parameters

    Returns any

renderingGroupId

  • get renderingGroupId(): number
  • set renderingGroupId(id: number): any
  • Rendering ground id of all the mesh in the button

    Returns number

  • Rendering ground id of all the mesh in the button

    Parameters

    • id: number

    Returns any

scaling

  • Gets or sets the control scaling in world space

    Returns Vector3

  • Gets or sets the control scaling in world space

    Parameters

    Returns any

typeName

  • get typeName(): string
  • Gets a string representing the class name

    Returns string

Methods

addBehaviorSearch playground for addBehavior

disposeSearch playground for dispose

  • dispose(): void

getBehaviorByNameSearch playground for getBehaviorByName

getClassNameSearch playground for getClassName

  • getClassName(): string
  • Get the current class name of the control.

    Returns string

    current class name

linkToTransformNodeSearch playground for linkToTransformNode

removeBehaviorSearch playground for removeBehavior

resetDefaultAspectAndPoseSearch playground for resetDefaultAspectAndPose

  • resetDefaultAspectAndPose(): void
  • Resets the aspect and pose of the slate so it is right in front of the active camera, facing towards it.

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Property
  • Method
  • Static property
  • Static method