Options
All
  • Public
  • Public/Protected
  • All
Menu

Class used to create a holographic slate

since

5.0.0

Hierarchy

Index

Constructors

Properties

defaultDimensions: Vector2

Default dimensions of the slate

minDimensions: Vector2

Minimum dimensions of the slate

name?: string

Defines the control name

onPointerClickObservable: Observable<Vector3WithInfo>

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

onPointerDownObservable: Observable<Vector3WithInfo>

An event triggered when the pointer taps the control

onPointerEnterObservable: Observable<Control3D>

An event triggered when pointer enters the control

onPointerMoveObservable: Observable<Vector3>

An event triggered when the pointer moves over the control

onPointerOutObservable: Observable<Control3D>

An event triggered when the pointer moves out of the control

onPointerUpObservable: Observable<Vector3WithInfo>

An event triggered when pointer is up

origin: Vector3

Origin in local coordinates (top left corner)

Gets or sets the parent container

pointerDownAnimation: () => void

Type declaration

    • (): void
    • Callback used to start pointer down animation

      Returns void

pointerEnterAnimation: () => void

Type declaration

    • (): void
    • Callback used to start pointer enter animation

      Returns void

pointerOutAnimation: () => void

Type declaration

    • (): void
    • Callback used to start pointer out animation

      Returns void

pointerUpAnimation: () => void

Type declaration

    • (): void
    • Callback used to start pointer up animation

      Returns void

titleBarMargin: number

Margin between title bar and contentplate

ASSETS_BASE_URL: string

Base Url for the assets.

CLOSE_ICON_FILENAME: string

File name for the close icon.

FOLLOW_ICON_FILENAME: string

File name for the close icon.

Accessors

  • 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 void

  • get contentResolution(): number
  • set contentResolution(value: number): void
  • 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 void

  • Regroups all mesh behaviors for the slate

    Returns DefaultBehavior

  • 2D dimensions of the slate

    Returns Vector2

  • 2D dimensions of the slate

    Parameters

    Returns void

  • get isVisible(): boolean
  • set isVisible(value: boolean): void
  • 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 void

  • Gets the mesh used to render this control

    Returns Nullable<AbstractMesh>

  • Gets the transform node used by this control

    Returns Nullable<TransformNode>

  • Gets or sets the control position in world space

    Returns Vector3

  • Gets or sets the control position in world space

    Parameters

    Returns void

  • get renderingGroupId(): number
  • set renderingGroupId(id: number): void
  • Rendering ground id of all the meshes

    Returns number

  • Rendering ground id of all the meshes

    Parameters

    • id: number

    Returns void

  • Gets or sets the control scaling in world space

    Returns Vector3

  • Gets or sets the control scaling in world space

    Parameters

    Returns void

  • get title(): string
  • set title(title: string): void
  • The title text displayed at the top of the slate

    Returns string

  • The title text displayed at the top of the slate

    Parameters

    • title: string

    Returns void

  • get titleBarHeight(): number
  • set titleBarHeight(value: number): void
  • Height of the title bar component

    Returns number

  • Height of the title bar component

    Parameters

    • value: number

    Returns void

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

    Returns string

Methods

  • _prepareNode(scene: Scene): void
  • dispose(): void
  • Releases all associated resources

    Returns void

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

    Returns string

    current class name

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

    Parameters

    • Optional resetAspect: boolean

      Should the slate's dimensions/aspect ratio be reset as well

    Returns void

Legend

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

Settings

Theme