⬅️ Back to Table of Contents

📄 SetMaterialValueCommand.js

📊 Analysis Summary

Metric	Count
🔧 Functions	5
🧱 Classes	1
📦 Imports	1
📊 Variables & Constants	1

📚 Table of Contents

• Imports
• Variables & Constants
• Functions
• Classes

🛠️ File Location:

📂 editor/js/commands/SetMaterialValueCommand.js

📦 Imports

Name	Source
Command	../Command.js

---

Variables & Constants

Name	Type	Kind	Value	Exported
material	any	let/var	( object !== null ) ? editor.getObjectMaterial( object, materialSlot ) : null	✗

---

Functions

SetMaterialValueCommand.execute(): void

Returns: void

Calls:

• this.editor.getObjectMaterial
• this.editor.signals.objectChanged.dispatch
• this.editor.signals.materialChanged.dispatch

Code

execute() {

        const material = this.editor.getObjectMaterial( this.object, this.materialSlot );

        material[ this.attributeName ] = this.newValue;
        material.needsUpdate = true;

        this.editor.signals.objectChanged.dispatch( this.object );
        this.editor.signals.materialChanged.dispatch( this.object, this.materialSlot );

    }

SetMaterialValueCommand.undo(): void

Returns: void

Calls:

• this.editor.getObjectMaterial
• this.editor.signals.objectChanged.dispatch
• this.editor.signals.materialChanged.dispatch

Code

undo() {

        const material = this.editor.getObjectMaterial( this.object, this.materialSlot );

        material[ this.attributeName ] = this.oldValue;
        material.needsUpdate = true;

        this.editor.signals.objectChanged.dispatch( this.object );
        this.editor.signals.materialChanged.dispatch( this.object, this.materialSlot );

    }

SetMaterialValueCommand.update(cmd: any): void

Parameters:

• cmd any

Returns: void

Code

update( cmd ) {

        this.newValue = cmd.newValue;

    }

SetMaterialValueCommand.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;
        output.materialSlot = this.materialSlot;

        return output;

    }

SetMaterialValueCommand.fromJSON(json: any): void

Parameters:

• json any

Returns: void

Calls:

• super.fromJSON
• this.editor.objectByUuid

Code

fromJSON( json ) {

        super.fromJSON( json );

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

    }

---

Classes

SetMaterialValueCommand

Class Code

class SetMaterialValueCommand extends Command {

    /**
     * @param {Editor} editor
     * @param {THREE.Object3D|null} [object=null]
     * @param {string} [attributeName='']
     * @param {number|string|boolean|Object|null} [newValue=null]
     * @param {number} [materialSlot=-1]
     * @constructor
     */
    constructor( editor, object = null, attributeName = '', newValue = null, materialSlot = - 1 ) {

        super( editor );

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

        this.object = object;
        this.materialSlot = materialSlot;

        const material = ( object !== null ) ? editor.getObjectMaterial( object, materialSlot ) : null;

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

        this.attributeName = attributeName;

    }

    execute() {

        const material = this.editor.getObjectMaterial( this.object, this.materialSlot );

        material[ this.attributeName ] = this.newValue;
        material.needsUpdate = true;

        this.editor.signals.objectChanged.dispatch( this.object );
        this.editor.signals.materialChanged.dispatch( this.object, this.materialSlot );

    }

    undo() {

        const material = this.editor.getObjectMaterial( this.object, this.materialSlot );

        material[ this.attributeName ] = this.oldValue;
        material.needsUpdate = true;

        this.editor.signals.objectChanged.dispatch( this.object );
        this.editor.signals.materialChanged.dispatch( this.object, this.materialSlot );

    }

    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;
        output.materialSlot = this.materialSlot;

        return output;

    }

    fromJSON( json ) {

        super.fromJSON( json );

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

    }

}

Methods

execute(): void

Code

execute() {

        const material = this.editor.getObjectMaterial( this.object, this.materialSlot );

        material[ this.attributeName ] = this.newValue;
        material.needsUpdate = true;

        this.editor.signals.objectChanged.dispatch( this.object );
        this.editor.signals.materialChanged.dispatch( this.object, this.materialSlot );

    }

undo(): void

Code

undo() {

        const material = this.editor.getObjectMaterial( this.object, this.materialSlot );

        material[ this.attributeName ] = this.oldValue;
        material.needsUpdate = true;

        this.editor.signals.objectChanged.dispatch( this.object );
        this.editor.signals.materialChanged.dispatch( this.object, this.materialSlot );

    }

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;
        output.materialSlot = this.materialSlot;

        return output;

    }

fromJSON(json: any): void

Code

fromJSON( json ) {

        super.fromJSON( json );

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

    }

---