Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VolumeBasedPanel

Abstract class used to create a container panel deployed on the surface of a volume

Hierarchy

Implements

Index

Constructors

constructor

Properties

marginSearch playground for margin

margin: number

Gets or sets the distance between elements

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

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 Readonly FACEFORWARDREVERSED_ORIENTATIONSearch playground for FACEFORWARDREVERSED_ORIENTATION

FACEFORWARDREVERSED_ORIENTATION: number

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

Static Readonly FACEFORWARD_ORIENTATIONSearch playground for FACEFORWARD_ORIENTATION

FACEFORWARD_ORIENTATION: number

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

Static Readonly FACEORIGINREVERSED_ORIENTATIONSearch playground for FACEORIGINREVERSED_ORIENTATION

FACEORIGINREVERSED_ORIENTATION: number

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

Static Readonly FACEORIGIN_ORIENTATIONSearch playground for FACEORIGIN_ORIENTATION

FACEORIGIN_ORIENTATION: number

Control will rotate to make it look at sphere central axis

Static Readonly UNSET_ORIENTATIONSearch playground for UNSET_ORIENTATION

UNSET_ORIENTATION: number

Control rotation will remain unchanged

Accessors

behaviors

blockLayout

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

children

columns

  • get columns(): int
  • set columns(value: int): any
  • Gets or sets the number of columns requested (10 by default). The panel will automatically compute the number of rows based on number of child controls.

    Returns int

  • Gets or sets the number of columns requested (10 by default). The panel will automatically compute the number of rows based on number of child controls.

    Parameters

    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

orientation

  • get orientation(): number
  • set orientation(value: number): any
  • Gets or sets the orientation to apply to all controls (BABYLON.Container3D.FaceOriginReversedOrientation by default) | Value | Type | Description | | ----- | ----------------------------------- | ----------- | | 0 | UNSET_ORIENTATION | Control rotation will remain unchanged | | 1 | FACEORIGIN_ORIENTATION | Control will rotate to make it look at sphere central axis | | 2 | FACEORIGINREVERSED_ORIENTATION | Control will rotate to make it look back at sphere central axis | | 3 | FACEFORWARD_ORIENTATION | Control will rotate to look at z axis (0, 0, 1) | | 4 | FACEFORWARDREVERSED_ORIENTATION | Control will rotate to look at negative z axis (0, 0, -1) |

    Returns number

  • Gets or sets the orientation to apply to all controls (BABYLON.Container3D.FaceOriginReversedOrientation by default) | Value | Type | Description | | ----- | ----------------------------------- | ----------- | | 0 | UNSET_ORIENTATION | Control rotation will remain unchanged | | 1 | FACEORIGIN_ORIENTATION | Control will rotate to make it look at sphere central axis | | 2 | FACEORIGINREVERSED_ORIENTATION | Control will rotate to make it look back at sphere central axis | | 3 | FACEFORWARD_ORIENTATION | Control will rotate to look at z axis (0, 0, 1) | | 4 | FACEFORWARDREVERSED_ORIENTATION | Control will rotate to look at negative z axis (0, 0, -1) |

    Parameters

    • value: number

    Returns any

position

  • Gets or sets the control position in world space

    Returns Vector3

  • Gets or sets the control position in world space

    Parameters

    Returns any

rows

  • get rows(): int
  • set rows(value: int): any
  • Gets or sets a the number of rows requested. The panel will automatically compute the number of columns based on number of child controls.

    Returns int

  • Gets or sets a the number of rows requested. The panel will automatically compute the number of columns based on number of child controls.

    Parameters

    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

addControlSearch playground for addControl

  • Adds a control to the children of this control

    Parameters

    • control: Control3D

      defines the control to add

    Returns Container3D

    the current container

containsControlSearch playground for containsControl

  • containsControl(control: Control3D): boolean
  • 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

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

removeControlSearch playground for removeControl

  • Removes a control from the children of this control

    Parameters

    • control: Control3D

      defines the control to remove

    Returns Container3D

    the current container

updateLayoutSearch playground for updateLayout

  • 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
  • Accessor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Property
  • Method
  • Static method