Class HolographicBackplate

Class used to create a holographic backplate in 3D

since: 5.0.0

Hierarchy

Control3D
- HolographicBackplate

Constructors

constructor

new HolographicBackplate(name?: string, _shareMaterials?: boolean): HolographicBackplate

Overrides Control3D.constructor
- Defined in .temp/docdirectory/doc.d.ts:126024
Creates a new holographic backplate

Parameters
- Optional name: string
  
  defines the control name
- Optional _shareMaterials: boolean
Returns HolographicBackplate

Properties

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

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

Static MODEL_BASE_URL Search playground for MODEL_BASE_URL

MODEL_BASE_URL: string

Base Url for the button model.

Static MODEL_FILENAME Search playground for MODEL_FILENAME

MODEL_FILENAME: string

File name for the button model.

Accessors

behaviors

get behaviors(): Behavior<Control3D>[]

Inherited from Control3D.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>[]

isVisible

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

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

Returns boolean
Inherited from Control3D.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

material

get material(): FluentBackplateMaterial

- Defined in .temp/docdirectory/doc.d.ts:126014
Gets the material used by the backplate

Returns FluentBackplateMaterial

mesh

get mesh(): Nullable<AbstractMesh>

Inherited from Control3D.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 Control3D.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 Control3D.position
- Defined in .temp/docdirectory/doc.d.ts:125794
Gets or sets the control position in world space

Returns Vector3
Inherited from Control3D.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:126010
Rendering ground id of the backplate mesh.

Returns number
- Defined in .temp/docdirectory/doc.d.ts:126009
Rendering ground id of the backplate mesh.

Parameters
- id: number
Returns void

scaling

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

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

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

Parameters
- value: Vector3
Returns void

shareMaterials

get shareMaterials(): boolean

- Defined in .temp/docdirectory/doc.d.ts:126018
Gets a boolean indicating if this backplate shares its material with other HolographicBackplates

Returns boolean

typeName

get typeName(): string

Inherited from Control3D.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

Inherited from Control3D._prepareNode
- Defined in .temp/docdirectory/doc.d.ts:125899
internal*
Parameters
- scene: Scene
Returns void

addBehavior Search playground for addBehavior

addBehavior(behavior: Behavior<Control3D>): Control3D

Inherited from Control3D.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 Control3D.dispose
- Defined in .temp/docdirectory/doc.d.ts:126032
Releases all associated resources

Returns void

getBehaviorByName Search playground for getBehaviorByName

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

Inherited from Control3D.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 Control3D.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 Control3D.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 Control3D.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

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional name: string

Optional _shareMaterials: boolean

Returns HolographicBackplate

Properties

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

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

Static MODEL_BASE_URLSearch playground for MODEL_BASE_URL

Static MODEL_FILENAMESearch playground for MODEL_FILENAME

Accessors

behaviors

Returns Behavior<Control3D>[]

isVisible

Returns boolean

Parameters

value: boolean

Returns void

material

Returns FluentBackplateMaterial

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

Parameters

value: Vector3

Returns void

shareMaterials

Returns boolean

typeName

Returns string

Methods

_prepareNodeSearch playground for _prepareNode

Parameters

scene: Scene

Returns void

addBehaviorSearch playground for addBehavior

Parameters

behavior: Behavior<Control3D>

Returns Control3D

disposeSearch playground for dispose

Returns void

getBehaviorByNameSearch playground for getBehaviorByName

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

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

Static MODEL_BASE_URL Search playground for MODEL_BASE_URL

Static MODEL_FILENAME Search playground for MODEL_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