Class TouchMeshButton3D

Class used to create an interactable object. It's a touchable 3D button using a mesh coming from the current scene

since: 5.0.0

Hierarchy

TouchButton3D
- TouchMeshButton3D

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new TouchMeshButton3D(mesh: Mesh, name?: string): TouchMeshButton3D

Overrides TouchButton3D.constructor
- Defined in .temp/docdirectory/doc.d.ts:100075
Creates a new 3D button based on a mesh

Parameters
- mesh: Mesh
  
  mesh to become a 3D button. By default this is also the mesh for near interaction collision checking
- Optional name: string
  
  defines the control name
Returns TouchMeshButton3D

Properties

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

onToggleObservableSearch playground for onToggleObservable

onToggleObservable: Observable<boolean>

An event triggered when the button is toggled. Only fired if 'isToggleButton' is true

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

Accessors

behaviors

get behaviors(): Behavior<Control3D>[]

Inherited from Container3D.behaviors
- Defined in .temp/docdirectory/doc.d.ts:97737
Gets the list of attached behaviors

see

https://doc.babylonjs.com/features/behaviour

Returns Behavior<Control3D>[]

collidableFrontDirection

get collidableFrontDirection(): Vector3
set collidableFrontDirection(frontWorldDir: Vector3): any

Inherited from TouchButton3D.collidableFrontDirection
- Defined in .temp/docdirectory/doc.d.ts:97643
Returns the front-facing direction of the button, or BABYLON.Vector3.Zero if there is no 'front'

Returns Vector3
Inherited from TouchButton3D.collidableFrontDirection
- Defined in .temp/docdirectory/doc.d.ts:97639
Sets the front-facing direction of the button. Pass in BABYLON.Vector3.Zero to allow interactions from any direction

Parameters
- frontWorldDir: Vector3
Returns any

collisionMesh

set collisionMesh(collisionMesh: Mesh): any

Inherited from TouchButton3D.collisionMesh
- Defined in .temp/docdirectory/doc.d.ts:97648
Sets the mesh used for testing input collision

Parameters
- collisionMesh: Mesh
  
  the new collision mesh for the button
Returns any

content

get content(): Control
set content(value: Control): any

Inherited from Button3D.content
- Defined in .temp/docdirectory/doc.d.ts:97843
Gets or sets the GUI 2D content used to display the button's facade

Returns Control
Inherited from Button3D.content
- Defined in .temp/docdirectory/doc.d.ts:97844
Gets or sets the GUI 2D content used to display the button's facade

Parameters
- value: Control
Returns any

contentResolution

get contentResolution(): number
set contentResolution(value: number): any

Inherited from Button3D.contentResolution
- Defined in .temp/docdirectory/doc.d.ts:97848
Gets or sets the texture resolution used to render content (512 by default)

Returns number
Inherited from Button3D.contentResolution
- Defined in .temp/docdirectory/doc.d.ts:97849
Gets or sets the texture resolution used to render content (512 by default)

Parameters
- value: number
Returns any

isToggleButton

get isToggleButton(): boolean
set isToggleButton(value: boolean): any

Inherited from TouchButton3D.isToggleButton
- Defined in .temp/docdirectory/doc.d.ts:97654
Setter for if this TouchButton3D should be treated as a toggle button

Returns boolean
Inherited from TouchButton3D.isToggleButton
- Defined in .temp/docdirectory/doc.d.ts:97653
Setter for if this TouchButton3D should be treated as a toggle button

Parameters
- value: boolean
  
  If this TouchHolographicButton should act like a toggle button
Returns any

isToggled

get isToggled(): boolean
set isToggled(newState: boolean): any

Inherited from TouchButton3D.isToggled
- Defined in .temp/docdirectory/doc.d.ts:97660
A public entrypoint to set the toggle state of the TouchHolographicButton. Only works if 'isToggleButton' is true

Returns boolean
Inherited from TouchButton3D.isToggled
- Defined in .temp/docdirectory/doc.d.ts:97659
A public entrypoint to set the toggle state of the TouchHolographicButton. Only works if 'isToggleButton' is true

Parameters
- newState: boolean
  
  The new state to set the TouchHolographicButton's toggle state to
Returns any

isVisible

get isVisible(): boolean
set isVisible(value: boolean): any

Inherited from Container3D.isVisible
- Defined in .temp/docdirectory/doc.d.ts:97760
Gets or sets a boolean indicating if the control is visible

Returns boolean
Inherited from Container3D.isVisible
- Defined in .temp/docdirectory/doc.d.ts:97761
Gets or sets a boolean indicating if the control is visible

Parameters
- value: boolean
Returns any

mesh

get mesh(): Nullable<AbstractMesh>

Inherited from Container3D.mesh
- Defined in .temp/docdirectory/doc.d.ts:97786
Gets the mesh used to render this control

Returns Nullable<AbstractMesh>

node

get node(): Nullable<TransformNode>

Inherited from Container3D.node
- Defined in .temp/docdirectory/doc.d.ts:97782
Gets the transform node used by this control

Returns Nullable<TransformNode>

position

get position(): Vector3
set position(value: Vector3): any

Inherited from Container3D.position
- Defined in .temp/docdirectory/doc.d.ts:97691
Gets or sets the control position in world space

Returns Vector3
Inherited from Container3D.position
- Defined in .temp/docdirectory/doc.d.ts:97692
Gets or sets the control position in world space

Parameters
- value: Vector3
Returns any

scaling

get scaling(): Vector3
set scaling(value: Vector3): any

Inherited from Container3D.scaling
- Defined in .temp/docdirectory/doc.d.ts:97694
Gets or sets the control scaling in world space

Returns Vector3
Inherited from Container3D.scaling
- Defined in .temp/docdirectory/doc.d.ts:97695
Gets or sets the control scaling in world space

Parameters
- value: Vector3
Returns any

typeName

get typeName(): string

Inherited from Container3D.typeName
- Defined in .temp/docdirectory/doc.d.ts:97772
Gets a string representing the class name

Returns string

Methods

addBehaviorSearch playground for addBehavior

addBehavior(behavior: Behavior<Control3D>): Control3D

Implementation of IBehaviorAware.addBehavior

Inherited from Container3D.addBehavior
- Defined in .temp/docdirectory/doc.d.ts:97744
Attach a behavior to the control

see

https://doc.babylonjs.com/features/behaviour

Parameters
- behavior: Behavior<Control3D>
  
  defines the behavior to attach
Returns Control3D

the current control

disposeSearch playground for dispose

dispose(): void

Implementation of IDisposable.dispose

Inherited from TouchButton3D.dispose

Overrides Button3D.dispose
- Defined in .temp/docdirectory/doc.d.ts:97671
Releases all associated resources

Returns void

getBehaviorByNameSearch playground for getBehaviorByName

getBehaviorByName(name: string): Nullable<Behavior<Control3D>>

Implementation of IBehaviorAware.getBehaviorByName

Inherited from Container3D.getBehaviorByName
- Defined in .temp/docdirectory/doc.d.ts:97758
Gets an attached behavior by name

see

https://doc.babylonjs.com/features/behaviour

Parameters
- name: string
  
  defines the name of the behavior to look for
Returns Nullable<Behavior<Control3D>>

null if behavior was not found else the requested behavior

getClassNameSearch playground for getClassName

getClassName(): string

Inherited from Container3D.getClassName
- Defined in .temp/docdirectory/doc.d.ts:97777
Get the current class name of the control.

Returns string

current class name

linkToTransformNodeSearch playground for linkToTransformNode

linkToTransformNode(node: Nullable<TransformNode>): Control3D

Inherited from Container3D.linkToTransformNode
- Defined in .temp/docdirectory/doc.d.ts:97792
Link the control as child of the given node

Parameters
- node: Nullable<TransformNode>
  
  defines the node to link to. Use null to unlink the control
Returns Control3D

the current control

removeBehaviorSearch playground for removeBehavior

removeBehavior(behavior: Behavior<Control3D>): Control3D

Implementation of IBehaviorAware.removeBehavior

Inherited from Container3D.removeBehavior
- Defined in .temp/docdirectory/doc.d.ts:97751
Remove an attached behavior

see

https://doc.babylonjs.com/features/behaviour

Parameters
- behavior: Behavior<Control3D>
  
  defines the behavior to attach
Returns Control3D

the current control

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

mesh: Mesh

Optional name: string

Returns TouchMeshButton3D

Properties

Optional nameSearch playground for name

onPointerClickObservableSearch playground for onPointerClickObservable

onPointerDownObservableSearch playground for onPointerDownObservable

onPointerEnterObservableSearch playground for onPointerEnterObservable

onPointerMoveObservableSearch playground for onPointerMoveObservable

onPointerOutObservableSearch playground for onPointerOutObservable

onPointerUpObservableSearch playground for onPointerUpObservable

onToggleObservableSearch playground for onToggleObservable

parentSearch playground for parent

pointerDownAnimationSearch playground for pointerDownAnimation

Type declaration

Returns void

pointerEnterAnimationSearch playground for pointerEnterAnimation

Type declaration

Returns void

pointerOutAnimationSearch playground for pointerOutAnimation

Type declaration

Returns void

pointerUpAnimationSearch playground for pointerUpAnimation

Type declaration

Returns void

Accessors

behaviors

Returns Behavior<Control3D>[]

collidableFrontDirection

Returns Vector3

Parameters

frontWorldDir: Vector3

Returns any

collisionMesh

Parameters

collisionMesh: Mesh

Returns any

content

Returns Control

Parameters

value: Control

Returns any

contentResolution

Returns number

Parameters

value: number

Returns any

isToggleButton

Returns boolean

Parameters

value: boolean

Returns any

isToggled

Returns boolean

Parameters

newState: boolean

Returns any

isVisible

Returns boolean

Parameters

value: boolean

Returns any

mesh

Returns Nullable<AbstractMesh>

node

Returns Nullable<TransformNode>

position

Returns Vector3

Parameters

value: Vector3