Engine API Reference - v2.24.0-beta.18
    Preparing search index...

    Class RotateGizmo

    The RotateGizmo provides interactive 3D manipulation handles for rotating/reorienting Entitys in a Scene. It creates a visual widget with a draggable ring for each axis of rotation, plus a fourth ring for rotation in the camera's view plane, allowing precise control over object orientation through direct manipulation. The gizmo's visual appearance can be customized away from the defaults as required.

    Note that the gizmo can be driven by both mouse+keyboard and touch input.

    // Create a layer for rendering all gizmos
    const gizmoLayer = Gizmo.createLayer(app);

    // Create a rotate gizmo
    const gizmo = new RotateGizmo(cameraComponent, gizmoLayer);

    // Create an entity to attach the gizmo to
    const entity = new Entity();
    entity.addComponent('render', {
        type: 'box'
    });
    app.root.addChild(entity);

    // Attach the gizmo to the entity
    gizmo.attach([entity]);

    Relevant Engine API examples:

    Hierarchy (View Summary)

    Index
    constructor
    _app _camera _coordSpace _device _handles _layer _mouseButtons _readout _renderUpdate _rootStartPos _rootStartRot _scale _selectedAxis _selectedIsPlane _selectionStartPoint _shapes _theme dragMode intersectShapes nodes preventDefault root rotationMode snap snapIncrement
    _dragging angleGuideThickness camera cameraDir centerRadius coordSpace enabled faceRingRadius faceTubeRadius facingDir layer mouseButtons readout ringTolerance size theme xyzRingRadius xyzTubeRadius
    _calculateArcAngle _createPlane _createRay _createTransform _dirFromAxis _drawGuideLines _drawSpanLine _projectToAxis _readoutAxes _readoutDelta _readoutLabel _screenToPoint _showReadout _updatePosition _updateRotation _updateScale attach destroy detach enableShape fire hasEvent isShapeEnabled off on once prerender setTheme update createLayer
    EVENT_NODESATTACH EVENT_NODESDETACH EVENT_POINTERDOWN EVENT_POINTERMOVE EVENT_POINTERUP EVENT_POSITIONUPDATE EVENT_RENDERUPDATE EVENT_ROTATIONUPDATE EVENT_SCALEUPDATE EVENT_TRANSFORMEND EVENT_TRANSFORMMOVE EVENT_TRANSFORMREADOUT EVENT_TRANSFORMSTART

    Protected_app

    _app: AppBase

    Internal reference to the app containing the gizmo.

    Protected_camera

    _camera: CameraComponent

    Internal reference to camera component to view the gizmo.

    Protected_coordSpace

    _coordSpace: GizmoSpace = 'world'

    Internal version of coordinate space. Defaults to 'world'.

    Protected_device

    _device: GraphicsDevice

    Internal reference to the graphics device of the app.

    Protected_handles

    _handles: EventHandle[] = []

    Internal list of app event handles for the gizmo.

    Protected_layer

    _layer: Layer

    Internal reference to layer to render the gizmo..

    Protected_mouseButtons

    _mouseButtons: [boolean, boolean, boolean] = ...

    Internal array of mouse buttons that can interact with the gizmo.

    Protected_readout

    _readout: Readout | null = null

    Internal readout showing the transform delta while dragging.

    Protected_renderUpdate

    _renderUpdate: boolean = false

    Internal flag to track if a render update is required.

    Protected_rootStartPos

    _rootStartPos: Vec3 = ...

    Internal gizmo starting rotation in world space.

    Protected_rootStartRot

    _rootStartRot: Quat = ...

    Internal gizmo starting rotation in world space.

    Protected_scale

    _scale: number = 1

    Internal version of the gizmo scale. Defaults to 1.

    Protected_selectedAxis

    _selectedAxis: "" | GizmoAxis = ''

    Internal currently selected axis.

    Protected_selectedIsPlane

    _selectedIsPlane: boolean = false

    Internal state of if currently selected shape is a plane.

    Protected_selectionStartPoint

    _selectionStartPoint: Vec3 = ...

    Internal selection starting coordinates in world space.

    Protected_shapes

    _shapes: {
        f: ArcShape;
        x: ArcShape;
        xyz: SphereShape;
        y: ArcShape;
        z: ArcShape;
    } = ...

    Internal object containing the gizmo shapes to render.

    Protected_theme

    _theme: GizmoTheme = ...

    Internal theme.

    dragMode: GizmoDragMode = 'selected'

    Whether to hide the shapes when dragging. Defaults to 'selected'.

    intersectShapes: Shape[] = []

    The intersection shapes for the gizmo.

    nodes: GraphNode[] = []

    The graph nodes attached to the gizmo.

    preventDefault: boolean = true

    Flag to indicate whether to call preventDefault on pointer events.

    root: Entity

    The root gizmo entity.

    rotationMode: "absolute" | "orbit" = 'absolute'

    The rotation mode of the gizmo. This can be either:

    • 'absolute': The rotation is calculated based on the mouse displacement relative to the initial click point.
    • 'orbit': The rotation is calculated based on the gizmos position around the center of rotation.
    snap: boolean = false

    Whether snapping is enabled. Defaults to false.

    snapIncrement: number = 5

    Protected_dragging

    • get enabled(): boolean

      Gets the gizmo enabled state.

      Returns boolean

    • set enabled(state: boolean): void

      Sets the gizmo enabled state.

      Parameters

      • state: boolean

      Returns void

    • get readout(): boolean

      Gets whether to show the transform delta in a text readout just below the gizmo while dragging.

      Returns boolean

    • set readout(value: boolean): void

      Sets whether to show the transform delta in a text readout just below the gizmo while dragging. The readout is a div with the class gizmo-readout, added to the document body. To show the value in a custom UI instead, turn this off and listen to TransformGizmo.EVENT_TRANSFORMREADOUT. Defaults to true.

      Parameters

      • value: boolean

      Returns void

    • get size(): number

      Gets the gizmo size.

      Returns number

    • set size(value: number): void

      Sets the gizmo size. Defaults to 1.

      Parameters

      • value: number

      Returns void

    Protected_calculateArcAngle

    • _calculateArcAngle(point: Vec3, x: number, y: number): number
      Protected

      Parameters

      • point: Vec3

        The point.

      • x: number

        The x coordinate.

      • y: number

        The y coordinate.

      Returns number

      The angle.

    Protected_createPlane

    Protected_createRay

    Protected_createTransform

    Protected_dirFromAxis

    _drawGuideLines

    Protected_drawSpanLine

    Protected_projectToAxis

    Protected_readoutAxes

    • _readoutAxes(values: Vec3, factor?: boolean): string
      Protected

      Formats a value for each of the axes being dragged.

      Parameters

      • values: Vec3

        The value for each axis.

      • Optionalfactor: boolean = false

        Whether the values are factors rather than deltas. Defaults to false.

      Returns string

      The readout markup.

    Protected_readoutDelta

    • _readoutDelta(value: number, digits: number): string
      Protected

      Formats a delta with an explicit sign, so it does not read as an absolute value. A value that rounds to zero is shown as positive.

      Parameters

      • value: number

        The value.

      • digits: number

        The number of digits after the decimal point.

      Returns string

      The signed value.

    Protected_readoutLabel

    Protected_screenToPoint

    Protected_showReadout

    Protected_updatePosition

    Protected_updateRotation

    Protected_updateScale

    • Detaches all graph nodes from the gizmo.

      Returns void

      const gizmo = new Gizmo(camera, layer);
      gizmo.attach([boxA, boxB]);
      gizmo.detach();

    • Fire an event, all additional arguments are passed on to the event listener.

      Parameters

      • name: string

        Name of event to fire.

      • Optionalarg1: any

        First argument that is passed to the event handler.

      • Optionalarg2: any

        Second argument that is passed to the event handler.

      • Optionalarg3: any

        Third argument that is passed to the event handler.

      • Optionalarg4: any

        Fourth argument that is passed to the event handler.

      • Optionalarg5: any

        Fifth argument that is passed to the event handler.

      • Optionalarg6: any

        Sixth argument that is passed to the event handler.

      • Optionalarg7: any

        Seventh argument that is passed to the event handler.

      • Optionalarg8: any

        Eighth argument that is passed to the event handler.

      Returns EventHandler

      Self for chaining.

      obj.fire('test', 'This is the message');

    • Test if there are any handlers bound to an event name.

      Parameters

      • name: string

        The name of the event to test.

      Returns boolean

      True if the object has handlers bound to the specified event name.

      obj.on('test', () => {}); // bind an event to 'test'
      obj.hasEvent('test'); // returns true
      obj.hasEvent('hello'); // returns false

    • Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

      Use this form to remove all listeners matching a name (and optionally callback/scope). To remove a single known subscription, prefer retaining the EventHandle returned by EventHandler#on / EventHandler#once and calling its EventHandle#off: it removes exactly that subscription and is faster (no scan of the callback list).

      Parameters

      • Optionalname: string

        Name of the event to unbind.

      • Optionalcallback: HandleEventCallback

        Function to be unbound.

      • Optionalscope: any

        Scope that was used as the this when the event is fired.

      Returns EventHandler

      Self for chaining.

      const handler = () => {};
      obj.on('test', handler);

      obj.off(); // Removes all events
      obj.off('test'); // Removes all events called 'test'
      obj.off('test', handler); // Removes all handler functions, called 'test'
      obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

    • Attach an event handler to an event.

      Parameters

      • name: string

        Name of the event to bind the callback to.

      • callback: HandleEventCallback

        Function that is called when event is fired. Note the callback is limited to 8 arguments.

      • Optionalscope: any = ...

        Object to use as 'this' when the event is fired, defaults to current this.

      Returns EventHandle

      An event handle. For later removal, prefer retaining this handle and calling its EventHandle#off over EventHandler#off with a name/callback: it removes exactly this subscription and is faster (no scan of the callback list).

      obj.on('test', (a, b) => {
          console.log(a + b);
      });
      obj.fire('test', 1, 2); // prints 3 to the console

      // preferred removal: retain the handle and call off() on it
      const evt = obj.on('test', (a, b) => {
          console.log(a + b);
      });
      // some time later
      evt.off();

    • Attach an event handler to an event. The handler is removed before it is called, so it runs at most once, even if it fires the same event again or throws.

      Parameters

      • name: string

        Name of the event to bind the callback to.

      • callback: HandleEventCallback

        Function that is called when event is fired. Note the callback is limited to 8 arguments.

      • Optionalscope: any = ...

        Object to use as 'this' when the event is fired, defaults to current this.

      Returns EventHandle

      An event handle. For removal before it fires, prefer retaining this handle and calling its EventHandle#off over EventHandler#off with a name/callback: it removes exactly this subscription and is faster (no scan of the callback list).

      obj.once('test', (a, b) => {
          console.log(a + b);
      });
      obj.fire('test', 1, 2); // prints 3 to the console
      obj.fire('test', 1, 2); // not going to get handled

    • Updates the gizmo position, rotation, and scale.

      Returns void

      const gizmo = new Gizmo(camera, layer);
      gizmo.attach([boxA, boxB]);
      gizmo.update();

    • Creates a new gizmo layer and adds it to the scene.

      Parameters

      • app: AppBase

        The app.

      • OptionallayerName: string = 'Gizmo'

        The layer name. Defaults to 'Gizmo'.

      • OptionallayerIndex: number = app.scene.layers.layerList.length

        The layer index. Defaults to the end of the layer list.

      Returns Layer

      The new layer.

    EVENT_NODESATTACH: string = 'nodes:attach'

    Fired when graph nodes are attached.

    const gizmo = new Gizmo(camera, layer);
    gizmo.on('nodes:attach', () => {
        console.log('Graph nodes attached');
    });
    EVENT_NODESDETACH: string = 'nodes:detach'

    Fired when graph nodes are detached.

    const gizmo = new Gizmo(camera, layer);
    gizmo.on('nodes:detach', () => {
        console.log('Graph nodes detached');
    });
    EVENT_POINTERDOWN: string = 'pointer:down'

    Fired when the pointer is down on the gizmo.

    const gizmo = new Gizmo(camera, layer);
    gizmo.on('pointer:down', (x, y, meshInstance) => {
        console.log(`Pointer was down on ${meshInstance.node.name} at ${x}, ${y}`);
    });
    EVENT_POINTERMOVE: string = 'pointer:move'

    Fired when the pointer is moving over the gizmo.

    const gizmo = new Gizmo(camera, layer);
    gizmo.on('pointer:move', (x, y, meshInstance) => {
        console.log(`Pointer was moving on ${meshInstance.node.name} at ${x}, ${y}`);
    });
    EVENT_POINTERUP: string = 'pointer:up'

    Fired when the pointer is up off the gizmo.

    const gizmo = new Gizmo(camera, layer);
    gizmo.on('pointer:up', (x, y, meshInstance) => {
        console.log(`Pointer was up on ${meshInstance.node.name} at ${x}, ${y}`);
    })
    EVENT_POSITIONUPDATE: string = 'position:update'

    Fired when the gizmo's position is updated.

    const gizmo = new Gizmo(camera, layer);
    gizmo.on('position:update', (position) => {
        console.log(`The gizmo's position was updated to ${position}`);
    })
    EVENT_RENDERUPDATE: string = 'render:update'

    Fired when the gizmo render has updated.

    const gizmo = new TransformGizmo(camera, layer);
    gizmo.on('render:update', () => {
        console.log('Gizmo render has been updated');
    });
    EVENT_ROTATIONUPDATE: string = 'rotation:update'

    Fired when the gizmo's rotation is updated.

    const gizmo = new Gizmo(camera, layer);
    gizmo.on('rotation:update', (rotation) => {
        console.log(`The gizmo's rotation was updated to ${rotation}`);
    });
    EVENT_SCALEUPDATE: string = 'scale:update'

    Fired when the gizmo's scale is updated.

    const gizmo = new Gizmo(camera, layer);
    gizmo.on('scale:update', (scale) => {
        console.log(`The gizmo's scale was updated to ${scale}`);
    });
    EVENT_TRANSFORMEND: string = 'transform:end'

    Fired when the transformation has ended.

    const gizmo = new TransformGizmo(camera, layer);
    gizmo.on('transform:end', () => {
        console.log('Transformation ended');
    });
    EVENT_TRANSFORMMOVE: string = 'transform:move'

    Fired during the transformation, with the dragged point on the selected axis or plane and the screen position of the pointer.

    const gizmo = new TransformGizmo(camera, layer);
    gizmo.on('transform:move', (point, x, y) => {
        console.log(`Transformation moved to ${point} (screen: ${x}, ${y})`);
    });
    EVENT_TRANSFORMREADOUT: string = 'transform:readout'

    Fired with the value shown in the readout when the transformation starts and on each step of it, whether or not TransformGizmo#readout is enabled, to show the value in a custom UI. The handler is passed the selected axis, whether it is a plane, which moves along the other two axes, and the value: the translation as a Vec3 for a translate gizmo, the scale factor as a Vec3 for a scale gizmo, or the angle in degrees for a rotate gizmo. The Vec3 is reused, so copy it to keep it.

    const gizmo = new TranslateGizmo(camera, layer);
    gizmo.readout = false;
    gizmo.on('transform:readout', (axis, isPlane, value) => {
        console.log(`Transformation ${axis}: ${value}`);
    });
    EVENT_TRANSFORMSTART: string = 'transform:start'

    Fired when the transformation has started.

    const gizmo = new TransformGizmo(camera, layer);
    gizmo.on('transform:start', () => {
        console.log('Transformation started');
    });

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods
    Events