Options
All
  • Public
  • Public/Protected
  • All
Menu

Class used to create containers for controls

Hierarchy

Index

Constructors

  • Creates a new container

    Parameters

    • Optional name: string

      defines the container name

    Returns Container3D

Properties

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

Gets or sets the parent container

pointerDownAnimation: (() => void)

Callback used to start pointer down animation

Type declaration

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

      Returns void

pointerEnterAnimation: (() => void)

Callback used to start pointer enter animation

Type declaration

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

      Returns void

pointerOutAnimation: (() => void)

Callback used to start pointer out animation

Type declaration

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

      Returns void

pointerUpAnimation: (() => void)

Callback used to start pointer up animation

Type declaration

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

      Returns void

FACEFORWARDREVERSED_ORIENTATION: 4 = 4

Control will rotate to look at negative z axis (0, 0, -1)

FACEFORWARD_ORIENTATION: 3 = 3

Control will rotate to look at z axis (0, 0, 1)

FACEORIGINREVERSED_ORIENTATION: 2 = 2

Control will rotate to make it look back at sphere central axis

FACEORIGIN_ORIENTATION: 1 = 1

Control will rotate to make it look at sphere central axis

UNSET_ORIENTATION: 0 = 0

Control rotation will remain unchanged

Accessors

  • get blockLayout(): boolean
  • set blockLayout(value: boolean): void
  • Gets or sets a boolean indicating if the layout must be blocked (default is false). This is helpful to optimize layout operation when adding multiple children in a row

    Returns boolean

  • Gets or sets a boolean indicating if the layout must be blocked (default is false). This is helpful to optimize layout operation when adding multiple children in a row

    Parameters

    • value: boolean

    Returns void

  • Gets the list of child controls

    Returns Control3D[]

  • 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

  • Gets or sets the control scaling in world space

    Returns Vector3

  • Gets or sets the control scaling in world space

    Parameters

    Returns void

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

    Returns string

Methods

  • _prepareNode(scene: Scene): void
  • Adds a control to the children of this control

    Parameters

    • control: Control3D

      defines the control to add

    Returns Container3D

    the current container

  • Gets a boolean indicating if the given control is in the children of this control

    Parameters

    • control: Control3D

      defines the control to check

    Returns boolean

    true if the control is in the child list

  • dispose(): void
  • Releases all associated resources

    Returns void

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

    Returns string

    current class name

  • Removes a control from the children of this control

    Parameters

    • control: Control3D

      defines the control to remove

    Returns Container3D

    the current container

  • Force the container to update the layout. Please note that it will not take blockLayout property in account

    Returns Container3D

    the current container

Legend

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

Settings

Theme