Class HolographicSlate

Class used to create a holographic slate

since: 5.0.0

Hierarchy

ContentDisplay3D
- HolographicSlate

Constructors

constructor

new HolographicSlate(name?: string): HolographicSlate

Overrides ContentDisplay3D.constructor
- Defined in .temp/docdirectory/doc.d.ts:126198
Creates a new slate

Parameters
- Optional name: string
  
  defines the control name
Returns HolographicSlate

Properties

Readonly defaultDimensions Search playground for defaultDimensions

defaultDimensions: Vector2

Default dimensions of the slate

minDimensions Search playground for minDimensions

minDimensions: Vector2

Minimum dimensions of the slate

Optional name Search playground for name

name?: string

Defines the control name

onPointerClickObservable Search playground for onPointerClickObservable

onPointerClickObservable: Observable<Vector3WithInfo>

An event triggered when a control is clicked on (with a mouse)

onPointerDownObservable Search playground for onPointerDownObservable

onPointerDownObservable: Observable<Vector3WithInfo>

An event triggered when the pointer taps the control

onPointerEnterObservable Search playground for onPointerEnterObservable

onPointerEnterObservable: Observable<Control3D>

An event triggered when pointer enters the control

onPointerMoveObservable Search playground for onPointerMoveObservable

onPointerMoveObservable: Observable<Vector3>

An event triggered when the pointer moves over the control

onPointerOutObservable Search playground for onPointerOutObservable

onPointerOutObservable: Observable<Control3D>

An event triggered when the pointer moves out of the control

onPointerUpObservable Search playground for onPointerUpObservable

onPointerUpObservable: Observable<Vector3WithInfo>

An event triggered when pointer is up

origin Search playground for origin

origin: Vector3

Origin in local coordinates (top left corner)

parent Search playground for parent

parent: Nullable<Container3D>

Gets or sets the parent container

pointerDownAnimation Search playground for pointerDownAnimation

pointerDownAnimation: (() => void)

Type declaration

- (): void
- Callback used to start pointer down animation
  
  Returns void

pointerEnterAnimation Search playground for pointerEnterAnimation

pointerEnterAnimation: (() => void)

Type declaration

- (): void
- Callback used to start pointer enter animation
  
  Returns void

pointerOutAnimation Search playground for pointerOutAnimation

pointerOutAnimation: (() => void)

Type declaration

- (): void
- Callback used to start pointer out animation
  
  Returns void

pointerUpAnimation Search playground for pointerUpAnimation

pointerUpAnimation: (() => void)

Type declaration

- (): void
- Callback used to start pointer up animation
  
  Returns void

titleBarMargin Search playground for titleBarMargin

titleBarMargin: number

Margin between title bar and contentplate

Static ASSETS_BASE_URL Search playground for ASSETS_BASE_URL

ASSETS_BASE_URL: string

Base Url for the assets.

Static CLOSE_ICON_FILENAME Search playground for CLOSE_ICON_FILENAME

CLOSE_ICON_FILENAME: string

File name for the close icon.

Static FOLLOW_ICON_FILENAME Search playground for FOLLOW_ICON_FILENAME

FOLLOW_ICON_FILENAME: string

File name for the close icon.

Accessors

behaviors

get behaviors(): Behavior<Control3D>[]

Inherited from ContentDisplay3D.behaviors
- Defined in .temp/docdirectory/doc.d.ts:125840
Gets the list of attached behaviors

see
https://doc.babylonjs.com/features/featuresDeepDive/behaviors

Returns Behavior<Control3D>[]

content

get content(): Control
set content(value: Control): void

Inherited from ContentDisplay3D.content
- Defined in .temp/docdirectory/doc.d.ts:125759
Gets or sets the GUI 2D content used to display the button's facade

Returns Control
Inherited from ContentDisplay3D.content
- Defined in .temp/docdirectory/doc.d.ts:125760
Gets or sets the GUI 2D content used to display the button's facade

Parameters
- value: Control
Returns void

contentResolution

get contentResolution(): number
set contentResolution(value: number): void

Inherited from ContentDisplay3D.contentResolution
- Defined in .temp/docdirectory/doc.d.ts:125765
Gets or sets the texture resolution used to render content (512 by default)

Returns number
Inherited from ContentDisplay3D.contentResolution
- Defined in .temp/docdirectory/doc.d.ts:125766
Gets or sets the texture resolution used to render content (512 by default)

Parameters
- value: number
Returns void

defaultBehavior

get defaultBehavior(): DefaultBehavior

- Defined in .temp/docdirectory/doc.d.ts:126155
Regroups all mesh behaviors for the slate

Returns DefaultBehavior

dimensions

get dimensions(): Vector2
set dimensions(value: Vector2): void

- Defined in .temp/docdirectory/doc.d.ts:126169
2D dimensions of the slate

Returns Vector2
- Defined in .temp/docdirectory/doc.d.ts:126170
2D dimensions of the slate

Parameters
- value: Vector2
Returns void

isVisible

get isVisible(): boolean
set isVisible(value: boolean): void

Inherited from ContentDisplay3D.isVisible
- Defined in .temp/docdirectory/doc.d.ts:125863
Gets or sets a boolean indicating if the control is visible

Returns boolean
Inherited from ContentDisplay3D.isVisible
- Defined in .temp/docdirectory/doc.d.ts:125864
Gets or sets a boolean indicating if the control is visible

Parameters
- value: boolean
Returns void

mesh

get mesh(): Nullable<AbstractMesh>

Inherited from ContentDisplay3D.mesh
- Defined in .temp/docdirectory/doc.d.ts:125889
Gets the mesh used to render this control

Returns Nullable<AbstractMesh>

node

get node(): Nullable<TransformNode>

Inherited from ContentDisplay3D.node
- Defined in .temp/docdirectory/doc.d.ts:125885
Gets the transform node used by this control

Returns Nullable<TransformNode>

position

get position(): Vector3
set position(value: Vector3): void

Inherited from ContentDisplay3D.position
- Defined in .temp/docdirectory/doc.d.ts:125794
Gets or sets the control position in world space

Returns Vector3
Inherited from ContentDisplay3D.position
- Defined in .temp/docdirectory/doc.d.ts:125795
Gets or sets the control position in world space

Parameters
- value: Vector3
Returns void

renderingGroupId

get renderingGroupId(): number
set renderingGroupId(id: number): void

- Defined in .temp/docdirectory/doc.d.ts:126188
Rendering ground id of all the meshes

Returns number
- Defined in .temp/docdirectory/doc.d.ts:126187
Rendering ground id of all the meshes

Parameters
- id: number
Returns void

scaling

get scaling(): Vector3
set scaling(value: Vector3): void

Inherited from ContentDisplay3D.scaling
- Defined in .temp/docdirectory/doc.d.ts:125797
Gets or sets the control scaling in world space

Returns Vector3
Inherited from ContentDisplay3D.scaling
- Defined in .temp/docdirectory/doc.d.ts:125798
Gets or sets the control scaling in world space

Parameters
- value: Vector3
Returns void

title

get title(): string
set title(title: string): void

- Defined in .temp/docdirectory/doc.d.ts:126193
The title text displayed at the top of the slate

Returns string
- Defined in .temp/docdirectory/doc.d.ts:126192
The title text displayed at the top of the slate

Parameters
- title: string
Returns void

titleBarHeight

get titleBarHeight(): number
set titleBarHeight(value: number): void

- Defined in .temp/docdirectory/doc.d.ts:126182
Height of the title bar component

Returns number
- Defined in .temp/docdirectory/doc.d.ts:126183
Height of the title bar component

Parameters
- value: number
Returns void

typeName

get typeName(): string

Inherited from ContentDisplay3D.typeName
- Defined in .temp/docdirectory/doc.d.ts:125875
Gets a string representing the class name

Returns string

Methods

_prepareNode Search playground for _prepareNode

_prepareNode(scene: Scene): void

Overrides ContentDisplay3D._prepareNode
- Defined in .temp/docdirectory/doc.d.ts:126223
internal*
Parameters
- scene: Scene
Returns void

addBehavior Search playground for addBehavior

addBehavior(behavior: Behavior<Control3D>): Control3D

Inherited from ContentDisplay3D.addBehavior
- Defined in .temp/docdirectory/doc.d.ts:125847
Attach a behavior to the control

see
https://doc.babylonjs.com/features/featuresDeepDive/behaviors

Parameters
- behavior: Behavior<Control3D>
  
  defines the behavior to attach
Returns Control3D
the current control

dispose Search playground for dispose

dispose(): void

Overrides ContentDisplay3D.dispose
- Defined in .temp/docdirectory/doc.d.ts:126232
Releases all associated resources

Returns void

getBehaviorByName Search playground for getBehaviorByName

getBehaviorByName(name: string): Nullable<Behavior<Control3D>>

Inherited from ContentDisplay3D.getBehaviorByName
- Defined in .temp/docdirectory/doc.d.ts:125861
Gets an attached behavior by name

see
https://doc.babylonjs.com/features/featuresDeepDive/behaviors

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

getClassName Search playground for getClassName

getClassName(): string

Inherited from ContentDisplay3D.getClassName
- Defined in .temp/docdirectory/doc.d.ts:125880
Get the current class name of the control.

Returns string
current class name

linkToTransformNode Search playground for linkToTransformNode

linkToTransformNode(node: Nullable<TransformNode>): Control3D

Inherited from ContentDisplay3D.linkToTransformNode
- Defined in .temp/docdirectory/doc.d.ts:125895
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

removeBehavior Search playground for removeBehavior

removeBehavior(behavior: Behavior<Control3D>): Control3D

Inherited from ContentDisplay3D.removeBehavior
- Defined in .temp/docdirectory/doc.d.ts:125854
Remove an attached behavior

see
https://doc.babylonjs.com/features/featuresDeepDive/behaviors

Parameters
- behavior: Behavior<Control3D>
  
  defines the behavior to attach
Returns Control3D
the current control

resetDefaultAspectAndPose Search playground for resetDefaultAspectAndPose

resetDefaultAspectAndPose(resetAspect?: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:126228
Resets the aspect and pose of the slate so it is right in front of the active camera, facing towards it.

Parameters
- Optional resetAspect: boolean
  
  Should the slate's dimensions/aspect ratio be reset as well
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional name: string

Returns HolographicSlate

Properties

Readonly defaultDimensionsSearch playground for defaultDimensions

minDimensionsSearch playground for minDimensions

Optional nameSearch playground for name

onPointerClickObservableSearch playground for onPointerClickObservable

onPointerDownObservableSearch playground for onPointerDownObservable

onPointerEnterObservableSearch playground for onPointerEnterObservable

onPointerMoveObservableSearch playground for onPointerMoveObservable

onPointerOutObservableSearch playground for onPointerOutObservable

onPointerUpObservableSearch playground for onPointerUpObservable

originSearch playground for origin

parentSearch playground for parent

pointerDownAnimationSearch playground for pointerDownAnimation

Type declaration

Returns void

pointerEnterAnimationSearch playground for pointerEnterAnimation

Type declaration

Returns void

pointerOutAnimationSearch playground for pointerOutAnimation

Type declaration

Returns void

pointerUpAnimationSearch playground for pointerUpAnimation

Type declaration

Returns void

titleBarMarginSearch playground for titleBarMargin

Static ASSETS_BASE_URLSearch playground for ASSETS_BASE_URL

Static CLOSE_ICON_FILENAMESearch playground for CLOSE_ICON_FILENAME

Static FOLLOW_ICON_FILENAMESearch playground for FOLLOW_ICON_FILENAME

Accessors

behaviors

Returns Behavior<Control3D>[]

content

Returns Control

Parameters

value: Control

Returns void

contentResolution

Returns number

Parameters

value: number

Returns void

defaultBehavior

Returns DefaultBehavior

dimensions

Returns Vector2

Parameters

value: Vector2

Returns void

isVisible

Returns boolean

Parameters

value: boolean

Returns void

mesh

Returns Nullable<AbstractMesh>

node

Returns Nullable<TransformNode>

position

Returns Vector3

Parameters

value: Vector3

Returns void

renderingGroupId

Returns number

Parameters

id: number

Returns void

scaling

Returns Vector3

Readonly defaultDimensions Search playground for defaultDimensions

minDimensions Search playground for minDimensions

Optional name Search playground for name

onPointerClickObservable Search playground for onPointerClickObservable

onPointerDownObservable Search playground for onPointerDownObservable

onPointerEnterObservable Search playground for onPointerEnterObservable

onPointerMoveObservable Search playground for onPointerMoveObservable

onPointerOutObservable Search playground for onPointerOutObservable

onPointerUpObservable Search playground for onPointerUpObservable

origin Search playground for origin

parent Search playground for parent

pointerDownAnimation Search playground for pointerDownAnimation

pointerEnterAnimation Search playground for pointerEnterAnimation

pointerOutAnimation Search playground for pointerOutAnimation

pointerUpAnimation Search playground for pointerUpAnimation

titleBarMargin Search playground for titleBarMargin

Static ASSETS_BASE_URL Search playground for ASSETS_BASE_URL

Static CLOSE_ICON_FILENAME Search playground for CLOSE_ICON_FILENAME

Static FOLLOW_ICON_FILENAME Search playground for FOLLOW_ICON_FILENAME

_prepareNode Search playground for _prepareNode

addBehavior Search playground for addBehavior

dispose Search playground for dispose

getBehaviorByName Search playground for getBehaviorByName

getClassName Search playground for getClassName

linkToTransformNode Search playground for linkToTransformNode

removeBehavior Search playground for removeBehavior

resetDefaultAspectAndPose Search playground for resetDefaultAspectAndPose