@minecraft
    Preparing search index...

    Interface WidgetComponentGizmoOptions

    Options used when creating a gizmo component. A gizmo must enable at least one translation axis or one rotation axis.

    interface WidgetComponentGizmoOptions {
        axes?: Axis;
        constrainToBlockCenters?: boolean;
        enablePlanes?: boolean;
        lockToSurface?: boolean;
        normalizedAutoOffset?: Vector3;
        offset?: Vector3;
        rotationAxes?: Axis;
        scaleMode?: WidgetGizmoScaleMode;
        stateChangeEvent?: (
            arg0: WidgetComponentGizmoStateChangeEventParameters,
        ) => void;
        visible?: boolean;
    }

    Hierarchy (View Summary)

    Index
    axes? constrainToBlockCenters? enablePlanes? lockToSurface? normalizedAutoOffset? offset? rotationAxes? scaleMode? stateChangeEvent? visible?
    axes?: Axis
    constrainToBlockCenters?: boolean

    When true, dragging keeps the widget origin at least half a block inside each worldBoundsMin and worldBoundsMax face, instead of constraining the combined component bounds. Intended for widgets whose origin is a block center. Defaults to false.

    enablePlanes?: boolean
    lockToSurface?: boolean
    normalizedAutoOffset?: Vector3
    offset?: Vector3
    rotationAxes?: Axis

    The world axes that have rotation rings when the gizmo is created. Defaults to Axis.None. The value can be Axis.None when at least one translation axis is enabled.

    Throws when neither a translation axis nor a rotation axis is enabled, or when the value contains bits other than Axis.X, Axis.Y, or Axis.Z.

    scaleMode?: WidgetGizmoScaleMode
    stateChangeEvent?: (
        arg0: WidgetComponentGizmoStateChangeEventParameters,
    ) => void
    visible?: boolean

    Settings
    Member Visibility

    On This Page
    Properties