Class SetObjectsXRayStatusCommand

Changes the XRay of the given objects.

Hierarchy

ObjectStateCommand<MeshState>
- SetObjectsXRayStatusCommand

Index

Constructors

Properties

_objects _state isUndoable isUpdatable name viewer

Accessors

hasBeenExecuted

Methods

_clean _do _undo _updateState equals execute toggle undo update

Constructors

constructor

new SetObjectsXRayStatusCommand(
    viewer: Viewer,
    uuids: Iterable<string>,
    xRay: boolean,
): SetObjectsXRayStatusCommand
Parameters
- viewer: Viewer
- uuids: Iterable<string>
- xRay: boolean
Returns SetObjectsXRayStatusCommand
Overrides ObjectStateCommand<MeshState>.constructor
- Defined in packages/viewer/src/command/objects/SetObjectsXRayStatusCommand.ts:13

Properties

`Protected` `Readonly`_objects

_objects: SceneObject[]

`Protected` `Readonly`_state

_state: PartialState<TState>

isUndoable

isUndoable: boolean = true

Indicates whether the command is undoable and redoable

`Readonly`isUpdatable

isUpdatable: boolean = false

Indicated whether the command can be updated

`Readonly`name

name: "SetObjectsXRayStatusCommand" = 'SetObjectsXRayStatusCommand'

Name of the command

`Protected`viewer

viewer: Viewer

Accessors

hasBeenExecuted

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

Methods

_clean

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

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

`Protected`_do

_do(): Promise<Partial<MeshState & RestoreState>>
Actions to execute during the execute method

Returns Promise<Partial<MeshState & RestoreState>>
Inherited from ObjectStateCommand._do
- Defined in packages/viewer/src/command/ObjectStateCommand.ts:29

`Protected`_undo

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

Returns Promise<void>
Inherited from ObjectStateCommand._undo
- Defined in packages/viewer/src/command/ObjectStateCommand.ts:35

`Protected`_updateState

_updateState(): void
Update the current state of the command when the update method is called

Returns void
Overrides ObjectStateCommand._updateState
- Defined in packages/viewer/src/command/objects/SetObjectsXRayStatusCommand.ts:28

equals

equals(cmd: this): boolean
Parameters
- cmd: this
Returns boolean
Overrides ObjectStateCommand.equals
- Defined in packages/viewer/src/command/objects/SetObjectsXRayStatusCommand.ts:24

execute

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

toggle

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

undo

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

update

update(...params: unknown[]): Promise<void>
Update the current state of the command and push the new state in history
Parameters
- ...params: unknown[]
Returns Promise<void>
Inherited from ObjectStateCommand.update
- Defined in packages/viewer/src/command/ObjectStateCommand.ts:52