Class GetSelectedObjectsCommand

Returns the currently selected objects uuids.

Hierarchy (View Summary)

Command<Generator<string>>
- GetSelectedObjectsCommand

Index

Constructors

Properties

isUndoable isUpdatable name

Accessors

hasBeenExecuted

Methods

_clean equals execute toggle undo update

Constructors

constructor

new GetSelectedObjectsCommand(viewer: Viewer): GetSelectedObjectsCommand
Parameters
- viewer: Viewer
Returns GetSelectedObjectsCommand
Overrides Command.constructor
- Defined in src/viewer/command/objects/GetSelectedObjectsCommand.ts:15

Properties

isUndoable

isUndoable: boolean = false

Indicates whether the command is undoable and redoable

isUpdatable

isUpdatable: boolean = false

Indicated whether the command can be updated

`Readonly`name

name: "GetSelectedObjectsCommand" = 'GetSelectedObjectsCommand'

Name of the command

Accessors

hasBeenExecuted

get hasBeenExecuted(): boolean
Returns boolean
Inherited from Command.hasBeenExecuted
- Defined in src/viewer/command/Command.ts:46

Methods

_clean

_clean(): Promise<void>
Cleans the command footprint.

Returns Promise<void>
Inherited from Command._clean
- Defined in src/viewer/command/Command.ts:142

equals

equals(cmd: this): boolean
Parameters
- cmd: this
Returns boolean
Inherited from Command.equals
- Defined in src/viewer/command/Command.ts:146

execute

execute(options?: ExecuteCommandOptions): Promise<Generator<string, any, any>>
Execute the command
Parameters
- options: ExecuteCommandOptions = {}
Returns Promise<Generator<string, any, any>>
Inherited from Command.execute
- Defined in src/viewer/command/Command.ts:55

toggle

toggle(options?: CommandOptions): Promise<void | Generator<string, any, any>>
Toggle the command
Parameters
- options: CommandOptions = {}
Returns Promise<void | Generator<string, any, any>>
Inherited from Command.toggle
- Defined in src/viewer/command/Command.ts:107

undo

undo(options?: UndoCommandOptions): Promise<void>
Undo the command
Parameters
- options: UndoCommandOptions = {}
Returns Promise<void>
Inherited from Command.undo
- Defined in src/viewer/command/Command.ts:82

update

update(..._params: unknown[]): Promise<void>
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 (otherwise an error is thrown)
Parameters
- ..._params: unknown[]
Returns Promise<void>
Inherited from Command.update
- Defined in src/viewer/command/Command.ts:161