Class ScaleGizmo

Gizmo that enables scaling a mesh along 3 axis

Hierarchy

Gizmo
- ScaleGizmo

Implements

IDisposable

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ScaleGizmo(gizmoLayer?: UtilityLayerRenderer, thickness?: number, gizmoManager?: GizmoManager): ScaleGizmo

Overrides Gizmo.constructor
- Defined in .temp/docdirectory/doc.d.ts:28859
Creates a ScaleGizmo

Parameters
- Optional gizmoLayer: UtilityLayerRenderer
  
  The utility layer the gizmo will be added to
- Optional thickness: number
  
  display gizmo axis thickness
- Optional gizmoManager: GizmoManager
Returns ScaleGizmo

Properties

_rootMeshSearch playground for _rootMesh

_rootMesh: Mesh

The root mesh of the gizmo

gizmoLayerSearch playground for gizmoLayer

gizmoLayer: UtilityLayerRenderer

The utility layer the gizmo will be added to

onDragEndObservableSearch playground for onDragEndObservable

onDragEndObservable: Observable<unknown>

Fires an event when any of it's sub gizmos are released from dragging

onDragStartObservableSearch playground for onDragStartObservable

onDragStartObservable: Observable<unknown>

Fires an event when any of it's sub gizmos are dragged

uniformScaleGizmoSearch playground for uniformScaleGizmo

uniformScaleGizmo: AxisScaleGizmo

Internal gizmo used to scale all axis equally

updateGizmoPositionToMatchAttachedMeshSearch playground for updateGizmoPositionToMatchAttachedMesh

updateGizmoPositionToMatchAttachedMesh: boolean

If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)

updateScaleSearch playground for updateScale

updateScale: boolean

When set, the gizmo will always appear the same size no matter where the camera is (default: true)

xGizmoSearch playground for xGizmo

xGizmo: AxisScaleGizmo

Internal gizmo used for interactions on the x axis

yGizmoSearch playground for yGizmo

yGizmo: AxisScaleGizmo

Internal gizmo used for interactions on the y axis

zGizmoSearch playground for zGizmo

zGizmo: AxisScaleGizmo

Internal gizmo used for interactions on the z axis

Static PreserveScalingSearch playground for PreserveScaling

PreserveScaling: boolean

When enabled, any gizmo operation will perserve scaling sign. Default is off. Only valid for TransformNode derived classes (Mesh, AbstractMesh, ...)

Accessors

attachedMesh

get attachedMesh(): Nullable<AbstractMesh>
set attachedMesh(mesh: Nullable<AbstractMesh>): any

Overrides AxisDragGizmo.attachedMesh
- Defined in .temp/docdirectory/doc.d.ts:28852
Returns Nullable<AbstractMesh>
Overrides AxisDragGizmo.attachedMesh
- Defined in .temp/docdirectory/doc.d.ts:28853
Parameters
- mesh: Nullable<AbstractMesh>
Returns any

attachedNode

get attachedNode(): Nullable<Node>
set attachedNode(node: Nullable<Node>): any

Overrides AxisDragGizmo.attachedNode
- Defined in .temp/docdirectory/doc.d.ts:28854
Returns Nullable<Node>
Overrides AxisDragGizmo.attachedNode
- Defined in .temp/docdirectory/doc.d.ts:28855
Parameters
- node: Nullable<Node>
Returns any

customRotationQuaternion

get customRotationQuaternion(): Nullable<Quaternion>
set customRotationQuaternion(customRotationQuaternion: Nullable<Quaternion>): any

Inherited from AxisDragGizmo.customRotationQuaternion
- Defined in .temp/docdirectory/doc.d.ts:28275
posture that the gizmo will be display When set null, default value will be used (Quaternion(0, 0, 0, 1))

Returns Nullable<Quaternion>
Inherited from AxisDragGizmo.customRotationQuaternion
- Defined in .temp/docdirectory/doc.d.ts:28276
posture that the gizmo will be display When set null, default value will be used (Quaternion(0, 0, 0, 1))

Parameters
- customRotationQuaternion: Nullable<Quaternion>
Returns any

isHovered

get isHovered(): boolean

Overrides AxisDragGizmo.isHovered
- Defined in .temp/docdirectory/doc.d.ts:28859
True when the mouse pointer is hovering a gizmo mesh

Returns boolean

scaleRatio

get scaleRatio(): number
set scaleRatio(value: number): any

Overrides AxisDragGizmo.scaleRatio
- Defined in .temp/docdirectory/doc.d.ts:28880
Ratio for the scale of the gizmo (Default: 1)

Returns number
Overrides AxisDragGizmo.scaleRatio
- Defined in .temp/docdirectory/doc.d.ts:28879
Ratio for the scale of the gizmo (Default: 1)

Parameters
- value: number
Returns any

sensitivity

get sensitivity(): number
set sensitivity(value: number): any

- Defined in .temp/docdirectory/doc.d.ts:28885
Sensitivity factor for dragging (Default: 1)

Returns number
- Defined in .temp/docdirectory/doc.d.ts:28884
Sensitivity factor for dragging (Default: 1)

Parameters
- value: number
Returns any

snapDistance

get snapDistance(): number
set snapDistance(value: number): any

- Defined in .temp/docdirectory/doc.d.ts:28875
Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)

Returns number
- Defined in .temp/docdirectory/doc.d.ts:28874
Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)

Parameters
- value: number
Returns any

updateGizmoRotationToMatchAttachedMesh

get updateGizmoRotationToMatchAttachedMesh(): boolean
set updateGizmoRotationToMatchAttachedMesh(value: boolean): any

Overrides AxisDragGizmo.updateGizmoRotationToMatchAttachedMesh
- Defined in .temp/docdirectory/doc.d.ts:28870
Returns boolean
Overrides AxisDragGizmo.updateGizmoRotationToMatchAttachedMesh
- Defined in .temp/docdirectory/doc.d.ts:28869
Parameters
- value: boolean
Returns any

Methods

addToAxisCacheSearch playground for addToAxisCache

addToAxisCache(mesh: Mesh, cache: GizmoAxisCache): void

- Defined in .temp/docdirectory/doc.d.ts:28891
Builds Gizmo Axis Cache to enable features such as hover state preservation and graying out other axis during manipulation

Parameters
- mesh: Mesh
  
  Axis gizmo mesh
- cache: GizmoAxisCache
  
  Gizmo axis definition used for reactive gizmo UI
Returns void

disposeSearch playground for dispose

dispose(): void

Implementation of IDisposable.dispose

Overrides Gizmo.dispose
- Defined in .temp/docdirectory/doc.d.ts:28895
Disposes of the gizmo

Returns void

setCustomMeshSearch playground for setCustomMesh

setCustomMesh(mesh: Mesh): void

Inherited from AxisDragGizmo.setCustomMesh
- Defined in .temp/docdirectory/doc.d.ts:28240
Disposes and replaces the current meshes in the gizmo with the specified mesh

Parameters
- mesh: Mesh
  
  The mesh to replace the default mesh of the gizmo
Returns void

Static GizmoAxisPointerObserverSearch playground for GizmoAxisPointerObserver

GizmoAxisPointerObserver(gizmoLayer: UtilityLayerRenderer, gizmoAxisCache: Map<Mesh, GizmoAxisCache>): Observer<PointerInfo>

Inherited from AxisDragGizmo.GizmoAxisPointerObserver
- Defined in .temp/docdirectory/doc.d.ts:28301
Subscribes to pointer up, down, and hover events. Used for responsive gizmos.

Parameters
- gizmoLayer: UtilityLayerRenderer
  
  The utility layer the gizmo will be added to
- gizmoAxisCache: Map<Mesh, GizmoAxisCache>
  
  Gizmo axis definition used for reactive gizmo UI
Returns Observer<PointerInfo>

pointerObserver

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional gizmoLayer: UtilityLayerRenderer

Optional thickness: number

Optional gizmoManager: GizmoManager

Returns ScaleGizmo

Properties

_rootMeshSearch playground for _rootMesh

gizmoLayerSearch playground for gizmoLayer

onDragEndObservableSearch playground for onDragEndObservable

onDragStartObservableSearch playground for onDragStartObservable

uniformScaleGizmoSearch playground for uniformScaleGizmo

updateGizmoPositionToMatchAttachedMeshSearch playground for updateGizmoPositionToMatchAttachedMesh

updateScaleSearch playground for updateScale

xGizmoSearch playground for xGizmo

yGizmoSearch playground for yGizmo

zGizmoSearch playground for zGizmo

Static PreserveScalingSearch playground for PreserveScaling

Accessors

attachedMesh

Returns Nullable<AbstractMesh>

Parameters

mesh: Nullable<AbstractMesh>

Returns any

attachedNode

Returns Nullable<Node>

Parameters

node: Nullable<Node>

Returns any

customRotationQuaternion

Returns Nullable<Quaternion>

Parameters

customRotationQuaternion: Nullable<Quaternion>

Returns any

isHovered

Returns boolean

scaleRatio

Returns number

Parameters

value: number

Returns any

sensitivity

Returns number

Parameters

value: number

Returns any

snapDistance

Returns number

Parameters

value: number

Returns any

updateGizmoRotationToMatchAttachedMesh

Returns boolean

Parameters

value: boolean

Returns any

Methods

addToAxisCacheSearch playground for addToAxisCache

Parameters

mesh: Mesh

cache: GizmoAxisCache

Returns void

disposeSearch playground for dispose

Returns void

setCustomMeshSearch playground for setCustomMesh

Parameters

mesh: Mesh

Returns void

Static GizmoAxisPointerObserverSearch playground for GizmoAxisPointerObserver

Parameters

gizmoLayer: UtilityLayerRenderer

gizmoAxisCache: Map<Mesh, GizmoAxisCache>