Options
All
  • Public
  • Public/Protected
  • All
Menu

BABYLON.Gizmo to resize 2D slates

Hierarchy

Index

Constructors

Properties

_rootMesh: Mesh

The root mesh of the gizmo

fixedScreenSize: boolean

If set, the handles will increase in size based on the distance away from the camera to have a consistent screen size (Default: true)

fixedScreenSizeDistanceFactor: number

The distance away from the object which the draggable meshes should appear world sized when fixedScreenSize is set to true (default: 10)

The utility layer the gizmo will be added to

PreserveScaling: boolean

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

UseAbsoluteScaling: boolean

There are 2 ways to preserve scaling: using mesh scaling or absolute scaling. Depending of hierarchy, non uniform scaling and LH or RH coordinates. One is preferable than the other. If the scaling to be preserved is the local scaling, then set this value to false. Default is true which means scaling to be preserved is absolute one (with hierarchy applied)

Accessors

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

    Returns GizmoAnchorPoint

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

    Parameters

    Returns void

  • 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

    Returns 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

    Parameters

    Returns void

  • 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

    Returns 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

    Parameters

    Returns void

  • The slate attached to this gizmo

    Returns Nullable<HolographicSlate>

  • The slate attached to this gizmo

    Parameters

    Returns void

  • Set the coordinate system to use. By default it's local. But it's possible for a user to tweak so its local for translation and world for rotation. In that case, setting the coordinate system will change updateGizmoRotationToMatchAttachedMesh and updateGizmoPositionToMatchAttachedMesh

    Returns GizmoCoordinatesMode

  • Set the coordinate system to use. By default it's local. But it's possible for a user to tweak so its local for translation and world for rotation. In that case, setting the coordinate system will change updateGizmoRotationToMatchAttachedMesh and updateGizmoPositionToMatchAttachedMesh

    Parameters

    Returns void

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

    Returns Nullable<Quaternion>

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

    Parameters

    Returns void

  • get isHovered(): boolean
  • True when the mouse pointer is hovered a gizmo mesh

    Returns boolean

  • get scaleRatio(): number
  • set scaleRatio(value: number): void
  • Ratio for the scale of the gizmo (Default: 1)

    Returns number

  • Ratio for the scale of the gizmo (Default: 1)

    Parameters

    • value: number

    Returns void

  • get updateGizmoPositionToMatchAttachedMesh(): boolean
  • set updateGizmoPositionToMatchAttachedMesh(value: boolean): void
  • If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)

    Returns boolean

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

    Parameters

    • value: boolean

    Returns void

  • get updateGizmoRotationToMatchAttachedMesh(): boolean
  • set updateGizmoRotationToMatchAttachedMesh(value: boolean): void
  • If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true) NOTE: This is only possible for meshes with uniform scaling, as otherwise it's not possible to decompose the rotation

    Returns boolean

  • If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true) NOTE: This is only possible for meshes with uniform scaling, as otherwise it's not possible to decompose the rotation

    Parameters

    • value: boolean

    Returns void

  • get updateScale(): boolean
  • set updateScale(value: boolean): void
  • When set, the gizmo will always appear the same size no matter where the camera is (default: true)

    Returns boolean

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

    Parameters

    • value: boolean

    Returns void

Methods

  • dispose(): void
  • Disposes of the gizmo

    Returns void

  • 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

  • updateBoundingBox(): void
  • Updates the bounding box information for the gizmo

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Property
  • Method
  • Static method

Settings

Theme