API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HandMenu

Hand menu that displays buttons and floats around the hand.

since

5.0.0

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Creates a hand menu GUI 3D control

    Parameters

    • xr: WebXRExperienceHelper

      the BABYLON.WebXRExperienceHelper used to link this control to the enabled WebXRHandTracking feature

    • Optional name: string

      name of the hand menu

    Returns HandMenu

Properties

marginSearch playground for margin

margin: number

Gets or sets the distance between elements

Optional nameSearch playground for name

name?: string

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 moves over the control

onPointerOutObservableSearch playground for onPointerOutObservable

onPointerOutObservable: Observable<Control3D>

An event triggered when the pointer moves out of the control

onPointerUpObservableSearch playground for onPointerUpObservable

onPointerUpObservable: Observable<Vector3WithInfo>

An event triggered when pointer is up

parentSearch playground for parent

parent: Nullable<Container3D>

Gets or sets the parent container

pointerDownAnimationSearch playground for pointerDownAnimation

pointerDownAnimation: (() => void)

Callback used to start pointer down animation

Type declaration

    • (): void

    • Callback used to start pointer down animation

      Returns void

pointerEnterAnimationSearch playground for pointerEnterAnimation

pointerEnterAnimation: (() => void)

Callback used to start pointer enter animation

Type declaration

    • (): void

    • Callback used to start pointer enter animation

      Returns void

pointerOutAnimationSearch playground for pointerOutAnimation

pointerOutAnimation: (() => void)

Callback used to start pointer out animation

Type declaration

    • (): void

    • Callback used to start pointer out animation

      Returns void

pointerUpAnimationSearch playground for pointerUpAnimation

pointerUpAnimation: (() => void)

Callback used to start pointer up animation

Type declaration

    • (): void

    • Callback used to start pointer up animation

      Returns void

Static Readonly FACEFORWARDREVERSED_ORIENTATIONSearch playground for FACEFORWARDREVERSED_ORIENTATION

FACEFORWARDREVERSED_ORIENTATION: 4 = 4

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

Static Readonly FACEFORWARD_ORIENTATIONSearch playground for FACEFORWARD_ORIENTATION

FACEFORWARD_ORIENTATION: 3 = 3

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

Static Readonly FACEORIGINREVERSED_ORIENTATIONSearch playground for FACEORIGINREVERSED_ORIENTATION

FACEORIGINREVERSED_ORIENTATION: 2 = 2

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

Static Readonly FACEORIGIN_ORIENTATIONSearch playground for FACEORIGIN_ORIENTATION

FACEORIGIN_ORIENTATION: 1 = 1

Control will rotate to make it look at sphere central axis

Static Readonly UNSET_ORIENTATIONSearch playground for UNSET_ORIENTATION

UNSET_ORIENTATION: 0 = 0

Control rotation will remain unchanged

Accessors

backPlateMargin

  • get backPlateMargin(): number
  • set backPlateMargin(value: number): void

  • Gets or sets the margin size of the backplate in button size units. Setting this to 1, will make the backPlate margin the size of 1 button

    Returns number

  • Gets or sets the margin size of the backplate in button size units. Setting this to 1, will make the backPlate margin the size of 1 button

    Parameters

    • value: number

    Returns void

behaviors

blockLayout

  • 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

children

  • Gets the list of child controls

    Returns Control3D[]

columns

  • get columns(): number
  • set columns(value: number): void

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

  • 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

    • value: number

    Returns void

handConstraintBehavior

  • The hand constraint behavior setting the transformation of this node

    Returns HandConstraintBehavior

isVisible

  • 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

mesh

  • Gets the mesh used to render this control

    Returns Nullable<AbstractMesh>

node

  • Gets the transform node used by this control

    Returns Nullable<TransformNode>

orientation

  • get orientation(): number
  • set orientation(value: number): void

  • Gets or sets the orientation to apply to all controls (BABYLON.Container3D.FaceOriginReversedOrientation by default)

    ValueTypeDescription
    0UNSET_ORIENTATIONControl rotation will remain unchanged
    1FACEORIGIN_ORIENTATIONControl will rotate to make it look at sphere central axis
    2FACEORIGINREVERSED_ORIENTATIONControl will rotate to make it look back at sphere central axis
    3FACEFORWARD_ORIENTATIONControl will rotate to look at z axis (0, 0, 1)
    4FACEFORWARDREVERSED_ORIENTATIONControl 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)

    ValueTypeDescription
    0UNSET_ORIENTATIONControl rotation will remain unchanged
    1FACEORIGIN_ORIENTATIONControl will rotate to make it look at sphere central axis
    2FACEORIGINREVERSED_ORIENTATIONControl will rotate to make it look back at sphere central axis
    3FACEFORWARD_ORIENTATIONControl will rotate to look at z axis (0, 0, 1)
    4FACEFORWARDREVERSED_ORIENTATIONControl will rotate to look at negative z axis (0, 0, -1)

    Parameters

    • value: number

    Returns void

position

  • Gets or sets the control position in world space

    Returns Vector3

  • Gets or sets the control position in world space

    Parameters

    Returns void

rows

  • get rows(): number
  • set rows(value: number): void

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

  • 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

    • value: number

    Returns void

scaling

  • Gets or sets the control scaling in world space

    Returns Vector3

  • Gets or sets the control scaling in world space

    Parameters

    Returns void

typeName

  • get typeName(): string

  • Gets a string representing the class name

    Returns string

Methods

_prepareNodeSearch playground for _prepareNode

  • _prepareNode(scene: Scene): void

addBehaviorSearch playground for addBehavior

addButtonSearch playground for addButton

addControlSearch playground for addControl

containsControlSearch playground for containsControl

  • 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

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

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

Settings

Theme