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

    Command that creates a Zone in the ZonePlugin's zoneController: a cube over the selection's bounding box, a sphere over its bounding sphere (unit ones at the scene's centre without selection), or a copy of the last selected object's geometry (its engine geometries shared, not copied). The zone, of the colour given and seen through, is attached to the transform tool once added. Undoable.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _object: Zone | null = null
    isUndoable: boolean = true

    Indicates whether the command is undoable and redoable

    isUpdatable: boolean = false

    Indicated whether the command can be updated

    name: "AddZoneCommand" = 'AddZoneCommand'

    Name of the command

    viewer: Viewer

    Accessors

    • get hasBeenExecuted(): boolean

      Returns boolean

    Methods

    • Releases the object of an undone addition for good, its engine objects removed.

      Returns Promise<void>

    • Makes the zone and its engine object.

      Returns Promise<Zone>

      For an object zone, when the last selected object has no geometry drawn.

    • Actions to execute during the execute method

      Returns Promise<Zone>

    • Actions to execute during the undo method

      Returns Promise<void>

    • Parameters

      • cmd: this

      Returns boolean

    • Updates the command with a latest version of the required parameters.

      The update method can be called during continuous user interactions (such as mousemove, mousedrag or color changes) where the command to fire can be updated accordingly to the user inputs instead of creating a new command for each value.

      Note

      • The attribute isUpdatable indicates if a command can be updated

      Parameters

      • ..._params: unknown[]

      Returns Promise<void>