Class SetObjectsColorCommand

Changes the color of the given objects. Only applies to meshes.

Hierarchy

ObjectStateCommand<MeshState, ColorRepresentation>
- SetObjectsColorCommand

Index

Constructors

Properties

isUndoable isUpdatable name

Accessors

hasBeenExecuted

Methods

_clean equals execute toggle undo update

Constructors

constructor

new SetObjectsColorCommand(
    viewer: Viewer,
    uuids: Iterable<string>,
    newColor: ColorRepresentation,
): SetObjectsColorCommand
Parameters
- viewer: Viewer
- uuids: Iterable<string>
- newColor: ColorRepresentation
Returns SetObjectsColorCommand
Overrides ObjectStateCommand<MeshState, ColorRepresentation>.constructor
- Defined in src/viewer/command/objects/SetObjectsColorCommand.ts:16

Properties

isUndoable

isUndoable: boolean = true

Indicates whether the command is undoable and redoable

isUpdatable

isUpdatable: boolean = true

Indicated whether the command can be updated

`Readonly`name

name: "SetObjectsColorCommand" = 'SetObjectsColorCommand'

Name of the command

Accessors

hasBeenExecuted

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

Methods

_clean

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

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

equals

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

execute

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

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 src/viewer/command/Command.ts:107

undo

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

update

update(newColor: ColorRepresentation): Promise<void>
Update the current state of the command and push the new state in history
Parameters
- newColor: ColorRepresentation
Returns Promise<void>
Overrides ObjectStateCommand.update
- Defined in src/viewer/command/objects/SetObjectsColorCommand.ts:26