⬅️ Back to Table of Contents

📄 SetColorCommand.js

📊 Analysis Summary

Metric	Count
🔧 Functions	5
🧱 Classes	1
📦 Imports	1

📚 Table of Contents

• Imports
• Functions
• Classes

🛠️ File Location:

📂 editor/js/commands/SetColorCommand.js

📦 Imports

Name	Source
Command	../Command.js

---

Functions

SetColorCommand.execute(): void

Returns: void

Calls:

• this.object[ this.attributeName ].setHex
• this.editor.signals.objectChanged.dispatch

Code

execute() {

        this.object[ this.attributeName ].setHex( this.newValue );
        this.editor.signals.objectChanged.dispatch( this.object );

    }

SetColorCommand.undo(): void

Returns: void

Calls:

• this.object[ this.attributeName ].setHex
• this.editor.signals.objectChanged.dispatch

Code

undo() {

        this.object[ this.attributeName ].setHex( this.oldValue );
        this.editor.signals.objectChanged.dispatch( this.object );

    }

SetColorCommand.update(cmd: any): void

Parameters:

• cmd any

Returns: void

Code

update( cmd ) {

        this.newValue = cmd.newValue;

    }

SetColorCommand.toJSON(): { type: string; id: number; name: string; }

Returns: { type: string; id: number; name: string; }

Calls:

• super.toJSON

Code

toJSON() {

        const output = super.toJSON( this );

        output.objectUuid = this.object.uuid;
        output.attributeName = this.attributeName;
        output.oldValue = this.oldValue;
        output.newValue = this.newValue;

        return output;

    }

SetColorCommand.fromJSON(json: any): void

Parameters:

• json any

Returns: void

Calls:

• super.fromJSON
• this.editor.objectByUuid

Code

fromJSON( json ) {

        super.fromJSON( json );

        this.object = this.editor.objectByUuid( json.objectUuid );
        this.attributeName = json.attributeName;
        this.oldValue = json.oldValue;
        this.newValue = json.newValue;

    }

---

Classes

SetColorCommand

Class Code

class SetColorCommand extends Command {

    /**
     * @param {Editor} editor
     * @param {THREE.Object3D|null} [object=null]
     * @param {string} attributeName
     * @param {?number} [newValue=null] Integer representing a hex color value
     * @constructor
     */
    constructor( editor, object = null, attributeName = '', newValue = null ) {

        super( editor );

        this.type = 'SetColorCommand';
        this.name = editor.strings.getKey( 'command/SetColor' ) + ': ' + attributeName;
        this.updatable = true;

        this.object = object;
        this.attributeName = attributeName;
        this.oldValue = ( object !== null ) ? this.object[ this.attributeName ].getHex() : null;
        this.newValue = newValue;

    }

    execute() {

        this.object[ this.attributeName ].setHex( this.newValue );
        this.editor.signals.objectChanged.dispatch( this.object );

    }

    undo() {

        this.object[ this.attributeName ].setHex( this.oldValue );
        this.editor.signals.objectChanged.dispatch( this.object );

    }

    update( cmd ) {

        this.newValue = cmd.newValue;

    }

    toJSON() {

        const output = super.toJSON( this );

        output.objectUuid = this.object.uuid;
        output.attributeName = this.attributeName;
        output.oldValue = this.oldValue;
        output.newValue = this.newValue;

        return output;

    }

    fromJSON( json ) {

        super.fromJSON( json );

        this.object = this.editor.objectByUuid( json.objectUuid );
        this.attributeName = json.attributeName;
        this.oldValue = json.oldValue;
        this.newValue = json.newValue;

    }

}

Methods

execute(): void

Code

execute() {

        this.object[ this.attributeName ].setHex( this.newValue );
        this.editor.signals.objectChanged.dispatch( this.object );

    }

undo(): void

Code

undo() {

        this.object[ this.attributeName ].setHex( this.oldValue );
        this.editor.signals.objectChanged.dispatch( this.object );

    }

update(cmd: any): void

Code

update( cmd ) {

        this.newValue = cmd.newValue;

    }

toJSON(): { type: string; id: number; name: string; }

Code

toJSON() {

        const output = super.toJSON( this );

        output.objectUuid = this.object.uuid;
        output.attributeName = this.attributeName;
        output.oldValue = this.oldValue;
        output.newValue = this.newValue;

        return output;

    }

fromJSON(json: any): void

Code

fromJSON( json ) {

        super.fromJSON( json );

        this.object = this.editor.objectByUuid( json.objectUuid );
        this.attributeName = json.attributeName;
        this.oldValue = json.oldValue;
        this.newValue = json.newValue;

    }

---