API
API|
@babylonjs/core|
IPlaneDragGizmo

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)

Implemented by

Index
_rootMesh additionalTransformNode? anchorPoint attachedMesh attachedNode coloredMaterial coordinatesMode customRotationQuaternion disableMaterial dragBehavior gizmoLayer hoverMaterial isEnabled isHovered onSnapObservable scaleRatio snapDistance updateGizmoPositionToMatchAttachedMesh updateGizmoRotationToMatchAttachedMesh updateScale
dispose setCustomMesh

_rootMesh

_rootMesh: Mesh

The root mesh of the gizmo

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: GizmoAnchorPoint

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

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: 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: StandardMaterial

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

coordinatesMode: GizmoCoordinatesMode

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

customRotationQuaternion: Nullable<Quaternion>

Orientation that the gizmo will be displayed with. When set null, default value will be used (Quaternion(0, 0, 0, 1))

disableMaterial: StandardMaterial

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

dragBehavior: PointerDragBehavior

Drag behavior responsible for the gizmos dragging interactions

gizmoLayer: UtilityLayerRenderer

The utility layer the gizmo will be added to

hoverMaterial: StandardMaterial

Material used to render when gizmo is hovered with mouse

isEnabled: boolean

If the gizmo is enabled

isHovered: boolean

True when the mouse pointer is hovered a gizmo mesh

onSnapObservable: Observable<{ snapDistance: number }>

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

  • snapDistance is the change in distance
scaleRatio: number

Ratio for the scale of the gizmo

snapDistance: number

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

updateGizmoPositionToMatchAttachedMesh: boolean

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

updateGizmoRotationToMatchAttachedMesh: boolean

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

updateScale: boolean

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