IPlaneDragGizmo | Babylon.js API documentation

Interface IPlaneDragGizmo

Interface for plane drag gizmo

interface IPlaneDragGizmo {
    _rootMesh: Mesh;
    additionalTransformNode?: TransformNode;
    anchorPoint: GizmoAnchorPoint;
    attachedMesh: Nullable<AbstractMesh>;
    attachedNode: Nullable<Node>;
    coloredMaterial: StandardMaterial;
    coordinatesMode: GizmoCoordinatesMode;
    customRotationQuaternion: Nullable<Quaternion>;
    disableMaterial: StandardMaterial;
    dragBehavior: PointerDragBehavior;
    gizmoLayer: UtilityLayerRenderer;
    hoverMaterial: StandardMaterial;
    isEnabled: boolean;
    isHovered: boolean;
    onSnapObservable: Observable<{ snapDistance: number }>;
    scaleRatio: number;
    snapDistance: number;
    updateGizmoPositionToMatchAttachedMesh: boolean;
    updateGizmoRotationToMatchAttachedMesh: boolean;
    updateScale: boolean;
    dispose(): void;
    setCustomMesh(mesh: Mesh): void;
}

Hierarchy (View Summary)

IGizmo
- IPlaneDragGizmo

Implemented by

PlaneDragGizmo

Properties

_rootMesh

_rootMesh: Mesh

The root mesh of the gizmo

`Optional`additionalTransformNode

additionalTransformNode?: TransformNode

Additional transform applied to the gizmo. It's useful when the gizmo is attached to a bone: if the bone is part of a skeleton attached to a mesh, you should define the mesh as additionalTransformNode if you want the gizmo to be displayed at the bone's correct location. Otherwise, as the gizmo is relative to the skeleton root, the mesh transformation will not be taken into account.

anchorPoint

anchorPoint: GizmoAnchorPoint

Defines where the gizmo will be positioned if updateGizmoPositionToMatchAttachedMesh is enabled. (Default: GizmoAnchorPoint.Origin)

attachedMesh

attachedMesh: Nullable<AbstractMesh>

Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)

When set, interactions will be enabled

attachedNode

attachedNode: Nullable<Node>

Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)

When set, interactions will be enabled

coloredMaterial

coloredMaterial: StandardMaterial

Default material used to render when gizmo is not disabled or hovered

coordinatesMode

coordinatesMode: GizmoCoordinatesMode

Set the coordinate mode to use. By default it's local.

customRotationQuaternion

customRotationQuaternion: Nullable<Quaternion>

posture that the gizmo will be display When set null, default value will be used (Quaternion(0, 0, 0, 1))

disableMaterial

disableMaterial: StandardMaterial

Material used to render when gizmo is disabled. typically grey.

dragBehavior

dragBehavior: PointerDragBehavior

Drag behavior responsible for the gizmos dragging interactions

gizmoLayer

gizmoLayer: UtilityLayerRenderer

The utility layer the gizmo will be added to

hoverMaterial

hoverMaterial: StandardMaterial

Material used to render when gizmo is hovered with mouse

isEnabled

isEnabled: boolean

If the gizmo is enabled

`Readonly`isHovered

isHovered: boolean

True when the mouse pointer is hovered a gizmo mesh

onSnapObservable

onSnapObservable: Observable<{ snapDistance: number }>

Event that fires each time the gizmo snaps to a new location.

snapDistance is the change in distance

scaleRatio

scaleRatio: number

Ratio for the scale of the gizmo

snapDistance

snapDistance: number

Drag distance in babylon units that the gizmo will snap to when dragged

updateGizmoPositionToMatchAttachedMesh

updateGizmoPositionToMatchAttachedMesh: boolean

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

updateGizmoRotationToMatchAttachedMesh

updateGizmoRotationToMatchAttachedMesh: boolean

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

updateScale

updateScale: boolean

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

Methods

dispose

dispose(): void
Releases all held resources

Returns void
Inherited from IGizmo.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:1936

setCustomMesh

setCustomMesh(mesh: Mesh): void
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
Inherited from IGizmo.setCustomMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:99095

Interface IPlaneDragGizmo

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

_rootMesh

`Optional`additionalTransformNode

anchorPoint

attachedMesh

attachedNode

coloredMaterial

coordinatesMode

customRotationQuaternion

disableMaterial

dragBehavior

gizmoLayer

hoverMaterial

isEnabled

`Readonly`isHovered

onSnapObservable

scaleRatio

snapDistance

updateGizmoPositionToMatchAttachedMesh

updateGizmoRotationToMatchAttachedMesh

updateScale

Methods

dispose

Returns void

setCustomMesh

Parameters

Returns void

Settings

On This Page

Interface IPlaneDragGizmo

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

_rootMesh

OptionaladditionalTransformNode

anchorPoint

attachedMesh

attachedNode

coloredMaterial

coordinatesMode

customRotationQuaternion

disableMaterial

dragBehavior

gizmoLayer

hoverMaterial

isEnabled

ReadonlyisHovered

onSnapObservable

scaleRatio

snapDistance

updateGizmoPositionToMatchAttachedMesh

updateGizmoRotationToMatchAttachedMesh

updateScale

Methods

dispose

Returns void

setCustomMesh

Parameters

Returns void

Settings

On This Page

`Optional`additionalTransformNode

`Readonly`isHovered