Documentation - v20.0.0-dev
    Preparing search index...

    Handle the gizmo controls in the viewport.

    Index

    Constructors

    Properties

    signals: {
        onTransformGizmoUpdated: Signal<(mode: TransformControlsMode) => void>;
    } = ...

    Accessors

    • get canRotate(): boolean

      Indicates whether the current attached objects can be rotated via gizmo

      Returns boolean

    • get canScale(): boolean

      Indicates whether the current attached objects can be scaled via gizmo

      Returns boolean

    • get canTranslate(): boolean

      Indicates whether the current attached objects can be translated via gizmo

      Returns boolean

    Methods

    • Returns void

    • Attach the given objects to the transform controller If no object are passed, we update the position of the gizmo for the current attached objects

      Objects that are not transformable or visible are ignored. If object configuration (rotate, translate, scale) of any object is false, then that transform will not be available for all given objects. Same rule apply to axis visibility

      Parameters

      Returns void

    • Listens to element's pointer input, for the gizmo: the viewport's canvas.

      Parameters

      • element: HTMLElement

      Returns void

    • Detaches all the objects from the transform controller

      Returns void

    • Stops listening to the element connected, if any.

      Returns void

    • Returns void

    • Parameters

      Returns boolean

    • Returns void

    • Parameters

      • pivotPoint: "Center" | "Min" | "Max"

      Returns void