Babylon.js API documentation|

Class GUI3DManager

Class used to manage 3D user interface

see: https://doc.babylonjs.com/features/featuresDeepDive/gui/gui3D

Hierarchy

GUI3DManager

Implements

IDisposable

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new GUI3DManager(scene?: Scene): GUI3DManager

- Defined in .temp/docdirectory/doc.d.ts:128200
Creates a new GUI3DManager

Parameters
- Optional scene: Scene
Returns GUI3DManager

Properties

onPickedPointChangedObservable Search playground for onPickedPointChangedObservable

onPickedPointChangedObservable: Observable<Nullable<Vector3>>

BABYLON.Observable raised when the point picked by the pointer events changed

onPickingObservable Search playground for onPickingObservable

onPickingObservable: Observable<Nullable<AbstractMesh>>

BABYLON.Observable raised when a picking happens

Accessors

controlScaling

get controlScaling(): number
set controlScaling(newScale: number): void

- Defined in .temp/docdirectory/doc.d.ts:128189
Gets the scaling for all UI elements owned by this manager

Returns number
- Defined in .temp/docdirectory/doc.d.ts:128191
Sets the scaling adjustment for all UI elements owned by this manager

Parameters
- newScale: number
Returns void

rootContainer

get rootContainer(): Container3D

- Defined in .temp/docdirectory/doc.d.ts:128206
Gets the root container

Returns Container3D

scene

get scene(): Scene

- Defined in .temp/docdirectory/doc.d.ts:128185
Gets the hosting scene

Returns Scene

useRealisticScaling

get useRealisticScaling(): boolean
set useRealisticScaling(newValue: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:128193
Gets if controls attached to this manager are realistically sized, based on the fact that 1 unit length is 1 meter

Returns boolean
- Defined in .temp/docdirectory/doc.d.ts:128195
Sets if controls attached to this manager are realistically sized, based on the fact that 1 unit length is 1 meter

Parameters
- newValue: boolean
Returns void

utilityLayer

get utilityLayer(): Nullable<UtilityLayerRenderer>

- Defined in .temp/docdirectory/doc.d.ts:128187
Gets associated utility layer

Returns Nullable<UtilityLayerRenderer>

Methods

addControl Search playground for addControl

addControl(control: Control3D): GUI3DManager

- Defined in .temp/docdirectory/doc.d.ts:128218
Adds a control to the root child list

Parameters
- control: Control3D
  
  defines the control to add
Returns GUI3DManager
the current manager

containsControl Search playground for containsControl

containsControl(control: Control3D): boolean

- Defined in .temp/docdirectory/doc.d.ts:128212
Gets a boolean indicating if the given control is in the root child list

Parameters
- control: Control3D
  
  defines the control to check
Returns boolean
true if the control is in the root child list

dispose Search playground for dispose

dispose(): void

Implementation of IDisposable.dispose
- Defined in .temp/docdirectory/doc.d.ts:128228
Releases all associated resources

Returns void

removeControl Search playground for removeControl

removeControl(control: Control3D): GUI3DManager

- Defined in .temp/docdirectory/doc.d.ts:128224
Removes a control from the root child list

Parameters
- control: Control3D
  
  defines the control to remove
Returns GUI3DManager
the current container