Class TouchMeshButton3D
Hierarchy
-
TouchButton3D
- TouchMeshButton3D
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
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
Defines the control name
on Pointer Click ObservableSearch playground for onPointerClickObservable
An event triggered when a control is clicked on (with a mouse)
on Pointer Down ObservableSearch playground for onPointerDownObservable
An event triggered when the pointer taps the control
on Pointer Enter ObservableSearch playground for onPointerEnterObservable
An event triggered when pointer enters the control
on Pointer Move ObservableSearch playground for onPointerMoveObservable
An event triggered when the pointer moves over the control
on Pointer Out ObservableSearch playground for onPointerOutObservable
An event triggered when the pointer moves out of the control
on Pointer UpObservableSearch playground for onPointerUpObservable
An event triggered when pointer is up
on Toggle ObservableSearch playground for onToggleObservable
An event triggered when the button is toggled. Only fired if 'isToggleButton' is true
parentSearch playground for parent
Gets or sets the parent container
pointer Down AnimationSearch playground for pointerDownAnimation
Callback used to start pointer down animation
Type declaration
-
-
Returns void
-
pointer Enter AnimationSearch playground for pointerEnterAnimation
Callback used to start pointer enter animation
Type declaration
-
-
Returns void
-
pointer Out AnimationSearch playground for pointerOutAnimation
Callback used to start pointer out animation
Type declaration
-
-
Returns void
-
pointer UpAnimationSearch playground for pointerUpAnimation
Callback used to start pointer up animation
Type declaration
-
-
Returns void
-
Accessors
behaviors
collidable Front Direction
collision Mesh
-
Sets the mesh used for testing input collision
Parameters
-
collisionMesh: Mesh
the new collision mesh for the button
Returns any
-
content
content Resolution
-
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 any
-
is Toggle Button
-
Setter for if this TouchButton3D should be treated as a toggle button
Returns boolean
-
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
-
is Toggled
-
A public entrypoint to set the toggle state of the TouchHolographicButton. Only works if 'isToggleButton' is true
Returns boolean
-
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
-
is Visible
-
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
-
Gets the mesh used to render this control
Returns Nullable<AbstractMesh>
node
-
Gets the transform node used by this control
Returns Nullable<TransformNode>
position
scaling
type Name
-
Gets a string representing the class name
Returns string
Methods
add BehaviorSearch playground for addBehavior
disposeSearch playground for dispose
-
Releases all associated resources
Returns void
get Behavior ByNameSearch playground for getBehaviorByName
get Class NameSearch playground for getClassName
-
Get the current class name of the control.
Returns string
current class name
link ToTransform NodeSearch playground for linkToTransformNode
-
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
-
Class used to create an interactable object. It's a touchable 3D button using a mesh coming from the current scene
5.0.0