Class SetNavigationRoutePointCommand

Creates a missing route endpoint or moves the existing one, preserving its state for undo.

Hierarchy (View Summary)

Command<void>
- SetNavigationRoutePointCommand

Index

Constructors

Properties

isUndoable isUpdatable name pointType position viewer

Accessors

hasBeenExecuted

Methods

_clean _do _undo equals execute reconnect toggle undo update

Constructors

constructor

new SetNavigationRoutePointCommand(
    viewer: Viewer,
    pointType: NavigationRoutePointType,
    position: Vector3,
    shouldReconnect?: boolean,
): SetNavigationRoutePointCommand
Parameters
- viewer: Viewer
- pointType: NavigationRoutePointType
- position: Vector3
- shouldReconnect: boolean = true
Returns SetNavigationRoutePointCommand
Overrides Command.constructor
- Defined in plugins/src/PathPlugin/commands/routing/SetNavigationRoutePointCommand.ts:17

Properties

`Readonly`isUndoable

isUndoable: true

Indicates whether the command is undoable and redoable

`Readonly`isUpdatable

isUpdatable: true

Indicated whether the command can be updated

`Readonly`name

name: string = 'SetNavigationRoutePointCommand'

Name of the command

`Protected` `Readonly`pointType

pointType: NavigationRoutePointType

`Protected` `Readonly`position

position: Vector3

`Protected`viewer

viewer: Viewer

Accessors

hasBeenExecuted

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

Methods

_clean

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

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

`Protected`_do

_do(): Promise<void>
Actions to execute during the execute method

Returns Promise<void>
Overrides Command._do
- Defined in plugins/src/PathPlugin/commands/routing/SetNavigationRoutePointCommand.ts:27

`Protected`_undo

_undo(): Promise<void>
Actions to execute during the undo method

Returns Promise<void>
Overrides Command._undo
- Defined in plugins/src/PathPlugin/commands/routing/SetNavigationRoutePointCommand.ts:37

equals

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

execute

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

reconnect

reconnect(): void
Returns void
- Defined in plugins/src/PathPlugin/commands/routing/SetNavigationRoutePointCommand.ts:53

toggle

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

undo

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

update

update(position: Vector3): 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
Parameters
- position: Vector3
Returns Promise<void>
Throws
- NotUpdatableCommandError if command is not updatable.
- CommandNotExecutedError if command has not been executed.
Overrides Command.update
- Defined in plugins/src/PathPlugin/commands/routing/SetNavigationRoutePointCommand.ts:46