Class TouchButton3D
Hierarchy
-
Button3D
- TouchButton3D
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Creates a new touchable button
Parameters
-
Optional name: string
defines the control name
-
Optional collisionMesh: Mesh
mesh to track collisions with
Returns TouchButton3D
-
Properties
Optional nameSearch playground for name
Defines the control name
on
An event triggered when a control is clicked on (with a mouse)
on
An event triggered when the pointer taps the control
on
An event triggered when pointer enters the control
on
An event triggered when the pointer moves over the control
on
An event triggered when the pointer moves out of the control
on
An event triggered when pointer is up
on
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
Callback used to start pointer down animation
Type declaration
-
-
Returns void
-
pointer
Callback used to start pointer enter animation
Type declaration
-
-
Returns void
-
pointer
Callback used to start pointer out animation
Type declaration
-
-
Returns void
-
pointer
Callback used to start pointer up animation
Type declaration
-
-
Returns void
-
Accessors
behaviors
collidable
-
Returns the front-facing direction of the button, or BABYLON.Vector3.Zero if there is no 'front'
Returns Vector3
-
Sets the front-facing direction of the button. Pass in BABYLON.Vector3.Zero to allow interactions from any direction
Parameters
-
frontWorldDir: Vector3
the forward direction of the button
Returns any
-
collision
-
Sets the mesh used for testing input collision
Parameters
-
collisionMesh: Mesh
the new collision mesh for the button
Returns any
-
content
content
-
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
-
Whether the current interaction is caused by near interaction or not
Returns boolean
is
-
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
-
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
-
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
-
Gets a string representing the class name
Returns string
Methods
_prepare
-
Parameters
-
scene: Scene
Returns void
-
add
disposeSearch playground for dispose
-
Releases all associated resources
Returns void
get
get
-
Get the current class name of the control.
Returns string
current class name
get
-
Get the height of the touchPoint from the collidable part of the button
Parameters
-
touchPoint: Vector3
the point to compare to the button, in absolute position
Returns number
the depth of the touch point into the front of the button
-
link
-
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 a touchable button in 3D