Class HolographicButton
Hierarchy (View Summary)
- Button3D
- HolographicButton
Constructors
constructor
-
Creates a new button
Parameters
Optionalname: stringdefines the control name
- shareMaterials: boolean = true
Returns HolographicButton
Properties
Optionalname
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
parent
Gets or sets the parent container
pointer
Callback used to start pointer down animation
pointer
Callback used to start pointer enter animation
pointer
Callback used to start pointer out animation
pointer
Callback used to start pointer up animation
Accessors
back
-
Gets the back material used by this button
Returns FluentMaterial
behaviors
-
Gets the list of attached behaviors
Returns Behavior<Control3D>[]
content
content
-
get contentResolution(): number | { height: number; width: number }
Gets or sets the texture resolution used to render content (512 by default)
Returns number | { height: number; width: number }
-
set contentResolution(value: number | { height: number; width: number }): void
Parameters
- value: number | { height: number; width: number }
Returns void
front
-
Gets the front material used by this button
Returns FluentMaterial
image
-
get imageUrl(): string
Gets or sets the image url for the button
Returns string
-
set imageUrl(value: string): void
Parameters
- value: string
Returns void
is
-
get isVisible(): boolean
Gets or sets a boolean indicating if the control is visible
Returns boolean
-
set isVisible(value: boolean): void
Parameters
- value: boolean
Returns void
mesh
-
get mesh(): Nullable<AbstractMesh>
Gets the mesh used to render this control
Returns Nullable<AbstractMesh>
node
-
get node(): Nullable<TransformNode>
Gets the transform node used by this control
Returns Nullable<TransformNode>
plate
-
get plateMaterial(): StandardMaterial
Gets the plate material used by this button
Returns StandardMaterial
position
-
get position(): Vector3
Gets or sets the control position in world space
Returns Vector3
-
set position(value: Vector3): void
Parameters
- value: Vector3
Returns void
rendering
-
get renderingGroupId(): number
Returns number
-
set renderingGroupId(id: number): void
Rendering ground id of all the mesh in the button
Parameters
- id: number
Returns void
scaling
-
get scaling(): Vector3
Gets or sets the control scaling in world space
Returns Vector3
-
set scaling(value: Vector3): void
Parameters
- value: Vector3
Returns void
share
-
Gets a boolean indicating if this button shares its material with other HolographicButtons
Returns boolean
text
-
get text(): string
Gets or sets text for the button
Returns string
-
set text(value: string): void
Parameters
- value: string
Returns void
tooltip
-
get tooltipText(): Nullable<string>
Returns Nullable<string>
-
set tooltipText(text: Nullable<string>): void
Text to be displayed on the tooltip shown when hovering on the button. When set to null tooltip is disabled. (Default: null)
Parameters
- text: Nullable<string>
Returns void
type
-
get typeName(): string
Gets a string representing the class name
Returns string
Methods
add
dispose
-
Releases all associated resources
Returns void
get
-
Gets an attached behavior by name
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
- name: string
get
-
Get the current class name of the control.
Returns string
current class name
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
- node: Nullable<TransformNode>
Class used to create a holographic button in 3D