RSX Code Reference
    Preparing search index...

    Class BoundsScaleInteractiveGizmo

    The BoundsScaleInteractiveGizmo implements a BuiltInInteractiveGizmo that allows an object to be scaled by dragging handles placed at the face-centers of its local-space AABB.

    Hierarchy (View Summary)

    Index
    _isDragActive: boolean
    _position: Vector3
    _worldAxes: Matrix3
    cornerHandleSize: number

    Size of the handles at the corners.

    edgeCylinderRadius: number

    Radius of the cylinder used to render edge handles when hovered or active.

    edgeRotationIndicatorRadius: number

    Radius of the rotation indicator circles drawn at edge midpoints.

    faceHandleSize: number

    Size of the handles on the faces.

    gizmoLayer: rsx.LayerMask

    Layer of the gizmo.

    maxHandleSizeExtentFraction: number

    Maximum handle size as a fraction of the smallest bounds half-extent, preventing handles from overlapping on large objects.

    • get activeHandleAxisSign(): Immutable<Vector3>

      Signed axis of the currently active handle (+1/−1 per component), or zero when idle.

      Returns Immutable<Vector3>

    • get delta(): Vector3

      Returns the amount of scaling since the start of the drag.

      Returns Vector3

    • set delta(value: Immutable<Vector3>): void

      The delta of the current drag operation.

      Parameters

      Returns void

    • get isDragging(): boolean

      Determines if the gizmo currently being interacted with (clicking, or dragging).

      Returns boolean

    • get isEdgeRotateDragged(): boolean

      Returns true when an edge handle is being dragged for rotation.

      Returns boolean

    • get isEnabled(): boolean

      Determines the active state of the gizmo. If disabled, the gizmo will not render or receive input.

      Returns boolean

    • get isFreeMoveDragged(): boolean

      True, if the object is being dragged by its bounds and not locked to an axis.

      Returns boolean

    • get isHovering(): boolean

      Determines if the gizmo currently being hovered.

      Returns boolean

    • get isMoveDragged(): boolean

      Returns true when the object is being translated via the free-move handle or a face-move drag.

      Returns boolean

    • get isScaleDragged(): boolean

      Returns true when a face or corner handle is being dragged for scaling.

      Returns boolean

    • get moveDelta(): Immutable<Vector3>

      World-space camera-plane translation delta when dragging on the bounds area; zero when inactive.

      Returns Immutable<Vector3>

    • get moveGridDelta(): Immutable<Vector3>

      World-space camera-plane translation delta when dragging on the bounds area; zero when inactive.

      Returns Immutable<Vector3>

    • get rotationDelta(): Quaternion

      Rotation delta since the start of the edge-drag; identity when idle.

      Returns Quaternion

    • get rotationDeltaAngle(): rsx.Degree

      Angle component of the rotation delta in degrees.

      Returns rsx.Degree

    • get worldAxes(): Matrix3

      World axes of the gizmo. Columns are the world-space local X, Y, Z directions.

      Returns Matrix3

    • set worldAxes(value: Immutable<Matrix3>): void

      Parameters

      Returns void

    • get worldPosition(): Vector3

      World position of the gizmo.

      Returns Vector3

    • set worldPosition(value: Immutable<Vector3>): void

      Parameters

      Returns void

    • get worldRotation(): Quaternion

      World rotation of the gizmo.

      Returns Quaternion

    • set worldRotation(value: Immutable<Quaternion>): void

      Parameters

      Returns void

    onDragStart: Event<any[], void>

    Invoked when a drag is started and a new delta is available.

    The onDrag event is invoked right after this event. Do not integrate the current delta during this event.

    onDrag: Event<any[], void>

    Invoked when a drag is performed and a new delta is available.

    onDragFinished: Event<any[], void>

    Invoked when the drag finished.