Class TouchHolographicButtonV3
Hierarchy
- TouchButton3D
- TouchHolographicButtonV3
Index
Constructors
Properties
- back
Glow Offset - back
Plate Depth - flat
Plane Depth - front
Plate Depth - height
- image
Size In Pixels - inner
Quad Color - inner
Quad Hover Color - inner
Quad Radius - inner
Quad Toggled Color - inner
Quad Toggled Hover Color - name
- on
Pointer Click Observable - on
Pointer Down Observable - on
Pointer Enter Observable - on
Pointer Move Observable - on
Pointer Out Observable - on
Pointer Up Observable - on
Toggle Observable - parent
- plate
Material Color - pointer
Down Animation - pointer
Enter Animation - pointer
Out Animation - pointer
Up Animation - radius
- text
Size In Pixels - width
- BACKGLOW_
MODEL_ FILENAME - BACKPLATE_
MODEL_ FILENAME - FRONTPLATE_
MODEL_ FILENAME - INNERQUAD_
MODEL_ FILENAME - MRTK_
ASSET_ BASE_ URL
Accessors
- back
Glow Material - back
Material - behaviors
- collidable
Front Direction - collision
Mesh - content
- content
Resolution - front
Material - image
Url - inner
Quad Material - is
Active Near Interaction - is
Backplate Visible - is
Toggle Button - is
Toggled - is
Visible - mesh
- node
- plate
Material - position
- rendering
Group Id - scaling
- share
Materials - subtext
- text
- tooltip
Text - type
Name
Methods
Constructors
constructor
Creates a new button
Parameters
Optional name: string
defines the control name
Optional shareMaterials: boolean
Returns TouchHolographicButtonV3
Properties
back Glow OffsetSearch playground for backGlowOffset
Gets or sets the offset value for button's back glow. This variable determines the x, y scaling of the button's meshes.
back Plate DepthSearch playground for backPlateDepth
Gets or sets the depth of the button's back plate. This variable determines the z scaling and z position for some of the button's meshes.
flat Plane DepthSearch playground for flatPlaneDepth
Gets or sets the value that determines the z scaling and z position for the innerQuad and BackGlow meshes.
front Plate DepthSearch playground for frontPlateDepth
Gets or sets the depth of the button's front plate. This variable determines the z scaling and z position for some of the button's meshes.
heightSearch playground for height
Gets or sets the vertical scaling for the button.
image Size In PixelsSearch playground for imageSizeInPixels
Gets or sets the size of the button image in pixels. This is only adjustable for a button with width to height ratio greater than 1.
inner Quad ColorSearch playground for innerQuadColor
Gets or sets the color for innerQuadMaterial.
inner Quad Hover ColorSearch playground for innerQuadHoverColor
Gets or sets the color for innerQuadMaterial for when it is hovered.
inner Quad RadiusSearch playground for innerQuadRadius
Gets or sets the radius for FrontMaterial and innerQuadMaterial.
inner Quad Toggled ColorSearch playground for innerQuadToggledColor
Gets or sets the color for innerQuadMaterial for when it is toggled.
inner Quad Toggled Hover ColorSearch playground for innerQuadToggledHoverColor
Gets or sets the color for innerQuadMaterial for when it is toggled and hovered.
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 Up ObservableSearch 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
plate Material ColorSearch playground for plateMaterialColor
Gets or sets the color of the button plate.
pointer Down AnimationSearch playground for pointerDownAnimation
Callback used to start pointer down animation
Type declaration
Callback used to start pointer down animation
Returns void
pointer Enter AnimationSearch playground for pointerEnterAnimation
Callback used to start pointer enter animation
Type declaration
Callback used to start pointer enter animation
Returns void
pointer Out AnimationSearch playground for pointerOutAnimation
Callback used to start pointer out animation
Type declaration
Callback used to start pointer out animation
Returns void
pointer Up AnimationSearch playground for pointerUpAnimation
Callback used to start pointer up animation
Type declaration
Callback used to start pointer up animation
Returns void
radiusSearch playground for radius
Gets or sets the bevel radius for the button.
text Size In PixelsSearch playground for textSizeInPixels
Gets or sets the font size of the button text in pixels. This is only adjustable for a button with width to height ratio greater than 1.
widthSearch playground for width
Gets or sets the horizontal scaling for the button.
Static BACKGLOW_ MODEL_ FILENAMESearch playground for BACKGLOW_MODEL_FILENAME
File name for the backglow model.
Static BACKPLATE_ MODEL_ FILENAMESearch playground for BACKPLATE_MODEL_FILENAME
File name for the backplate model.
Static FRONTPLATE_ MODEL_ FILENAMESearch playground for FRONTPLATE_MODEL_FILENAME
File name for the frontplate model.
Static INNERQUAD_ MODEL_ FILENAMESearch playground for INNERQUAD_MODEL_FILENAME
File name for the innerquad model.
Static MRTK_ ASSET_ BASE_ URLSearch playground for MRTK_ASSET_BASE_URL
Base Url for the frontplate model.
Accessors
back Glow Material
Gets the back glow material used by this button
Returns MRDLBackglowMaterial
back Material
Gets the back material used by this button
Returns MRDLBackplateMaterial
behaviors
collidable Front Direction
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 void
collision Mesh
Sets the mesh used for testing input collision
Parameters
collisionMesh: Mesh
the new collision mesh for the button
Returns void
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 void
front Material
Gets the front material used by this button
Returns MRDLFrontplateMaterial
image Url
Gets or sets the image url for the button
Returns string
Gets or sets the image url for the button
Parameters
value: string
Returns void
inner Quad Material
Gets the inner quad material used by this button
Returns MRDLInnerquadMaterial
is Active Near Interaction
Whether the current interaction is caused by near interaction or not
Returns boolean
is Backplate Visible
Sets whether the backplate is visible or hidden. Hiding the backplate is not recommended without some sort of replacement
Parameters
isVisible: boolean
Returns void
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 void
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 void
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 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>
plate Material
Gets the plate material used by this button
Returns StandardMaterial
position
rendering Group Id
Rendering ground id of all the mesh in the button
Returns number
Rendering ground id of all the mesh in the button
Parameters
id: number
Returns void
scaling
share Materials
Gets a boolean indicating if this button shares its material with other V3 Buttons
Returns boolean
subtext
Gets or sets subtext for a button with larger width
Returns string
Gets or sets subtext for a button with larger width
Parameters
value: string
Returns void
text
Gets or sets text for the button
Returns string
Gets or sets text for the button
Parameters
value: string
Returns void
tooltip Text
Text to be displayed on the tooltip shown when hovering on the button. When set to null tooltip is disabled. (Default: null) Set this property after adding the button to the GUI3DManager
Returns Nullable<string>
Text to be displayed on the tooltip shown when hovering on the button. When set to null tooltip is disabled. (Default: null) Set this property after adding the button to the GUI3DManager
Parameters
text: Nullable<string>
Returns void
type Name
Gets a string representing the class name
Returns string
Methods
_prepare NodeSearch playground for _prepareNode
Parameters
scene: Scene
Returns void
add BehaviorSearch playground for addBehavior
disposeSearch playground for dispose
Releases all associated resources
Returns void
get Behavior By NameSearch playground for getBehaviorByName
get Class NameSearch playground for getClassName
Get the current class name of the control.
Returns string
current class name
get Press DepthSearch playground for getPressDepth
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 To Transform 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 the mrtkv3 button