Class HolographicSlateSince
Hierarchy
- ContentDisplay3D
- HolographicSlate
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Creates a new slate
Parameters
Optionalname: stringdefines the control name
Returns HolographicSlate
Properties
Readonlydefault
Default dimensions of the slate
fit
If true, the content will be scaled to fit the dimensions of the slate
min
Minimum dimensions of the slate
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
origin
Origin in local coordinates (top left corner)
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
title
Margin between title bar and contentplate
StaticASSETS_
Base Url for the assets.
StaticCLOSE_
File name for the close icon.
StaticFOLLOW_
File name for the close icon.
Accessors
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
default
-
get defaultBehavior(): DefaultBehavior
Regroups all mesh behaviors for the slate
Returns DefaultBehavior
dimensions
-
get dimensions(): any
2D dimensions of the slate
Returns any
-
set dimensions(value: any): void
Parameters
- value: any
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>
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 meshes
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
title
-
get title(): string
Returns string
-
set title(title: string): void
The title text displayed at the top of the slate
Parameters
- title: string
Returns void
title
-
get titleBarHeight(): number
Height of the title bar component
Returns number
-
set titleBarHeight(value: number): void
Parameters
- value: number
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>
remove
reset
-
Resets the aspect and pose of the slate so it is right in front of the active camera, facing towards it.
Parameters
- resetAspect: boolean = true
Should the slate's dimensions/aspect ratio be reset as well
Returns void
- resetAspect: boolean = true
Class used to create a holographic slate 5.0.0