@zephyr3d/scene 0.7.0 → 0.8.0

package/dist/utility/blueprint/common/constants.js

@@ -1,30 +1,10 @@
+import { defineProps } from '../../serialization/types.js';
 import { getParamName } from '../common.js';
 import { BaseGraphNode } from '../node.js';
 
 /**
  * Constant scalar (float) value node
  *
- * @remarks
- * Represents a single floating-point constant in the material graph.
- * Can be either a literal constant or exposed as a uniform parameter.
- *
- * When set as uniform:
- * - Generates a shader uniform variable
- * - Can be modified at runtime without recompiling the shader
- * - Useful for material parameters like roughness, metallic, etc.
- *
- * When set as literal:
- * - Value is baked into the shader code
- * - More efficient but requires shader recompilation to change
- *
- * @example
- * ```typescript
- * const roughness = new ConstantScalarNode();
- * roughness.x = 0.5;
- * roughness.isUniform = true;
- * roughness.paramName = 'u_roughness';
- * ```
- *
  * @public
  */ class ConstantScalarNode extends BaseGraphNode {
     /** The scalar float value */ _value;
@@ -70,7 +50,7 @@ import { BaseGraphNode } from '../node.js';
             ctor: ConstantScalarNode,
             name: 'ConstantScalarNode',
             getProps () {
-                return [
+                return defineProps([
                     {
                         name: 'isUniform',
                         type: 'bool',
@@ -85,10 +65,14 @@ import { BaseGraphNode } from '../node.js';
                         name: 'paramName',
                         type: 'string',
                         get (value) {
-                            value.str[0] = this.paramName;
+                            value.str[0] = this.paramName ? this.paramName.slice(2) : '';
                         },
                         set (value) {
-                            this.paramName = value.str[0];
+                            if (!/^[A-Za-z0-9_]+$/.test(value.str[0])) {
+                                console.log(`Invalid parameter name: ${value.str[0]}`);
+                            } else {
+                                this.paramName = `u_${value.str[0]}`;
+                            }
                         }
                     },
                     {
@@ -101,7 +85,7 @@ import { BaseGraphNode } from '../node.js';
                             this.x = value.num[0];
                         }
                     }
-                ];
+                ]);
             }
         };
     }
@@ -124,7 +108,7 @@ import { BaseGraphNode } from '../node.js';
         return this._paramName;
     }
     set paramName(val) {
-        if (val !== this.paramName) {
+        if (this._paramName !== val) {
             this._paramName = val;
             this.dispatchEvent('changed');
         }
@@ -159,25 +143,95 @@ import { BaseGraphNode } from '../node.js';
     }
 }
 /**
- * Constant 2D vector (vec2) value node
- *
- * @remarks
- * Represents a 2-component vector constant (e.g., UV coordinates, 2D positions).
- * Provides multiple output slots:
- * - Output 1: The full vec2 value
- * - Output 2: The x component (swizzle)
- * - Output 3: The y component (swizzle)
+ * Constant scalar (bool) value node
  *
- * Can be exposed as a uniform parameter for runtime modification.
- *
- * @example
- * ```typescript
- * const offset = new ConstantVec2Node();
- * offset.x = 0.5;
- * offset.y = 0.5;
- * offset.isUniform = true;
- * offset.paramName = 'u_uvOffset';
- * ```
+ * @public
+ */ class ConstantBooleanNode extends BaseGraphNode {
+    /** The scalar boolean value */ _value;
+    /**
+   * Creates a new constant boolean node
+   *
+   * @remarks
+   * Initializes with a value of false and a single unnamed output slot.
+   */ constructor(){
+        super();
+        this._value = false;
+        this._outputs = [
+            {
+                id: 1,
+                name: ''
+            }
+        ];
+    }
+    /**
+   * Generates a string representation of this node
+   *
+   * @returns The parameter name if uniform, otherwise the rounded numeric value
+   *
+   * @remarks
+   * Values are rounded to 3 decimal places for display purposes.
+   */ toString() {
+        return String(this._value);
+    }
+    /**
+   * Gets the serialization descriptor for this node type
+   *
+   * @returns Serialization class descriptor with property definitions
+   *
+   * @remarks
+   * Used by the serialization system to save/load node graphs.
+   * Defines how to serialize the isUniform flag, parameter name, and value.
+   */ static getSerializationCls() {
+        return {
+            ctor: ConstantBooleanNode,
+            name: 'ConstantBooleanNode',
+            getProps () {
+                return defineProps([
+                    {
+                        name: 'x',
+                        type: 'bool',
+                        get (value) {
+                            value.bool[0] = this.x;
+                        },
+                        set (value) {
+                            this.x = value.bool[0];
+                        }
+                    }
+                ]);
+            }
+        };
+    }
+    /**
+   * Gets the scalar value
+   */ get x() {
+        return this._value;
+    }
+    set x(val) {
+        if (!!val !== this._value) {
+            this._value = !!val;
+            this.dispatchEvent('changed');
+        }
+    }
+    /**
+   * Validates the node state
+   *
+   * @returns Empty string (always valid)
+   *
+   * @remarks
+   * Constant nodes have no validation requirements.
+   */ validate() {
+        return '';
+    }
+    /**
+   * Gets the output type for this node
+   *
+   * @returns 'bool' for scalar output
+   */ getType() {
+        return 'bool';
+    }
+}
+/**
+ * Constant 2D vector (vec2) value node
  *
  * @public
  */ class ConstantVec2Node extends BaseGraphNode {
@@ -244,7 +298,7 @@ import { BaseGraphNode } from '../node.js';
         return this._paramName;
     }
     set paramName(val) {
-        if (val !== this._paramName) {
+        if (this._paramName !== val) {
             this._paramName = val;
             this.dispatchEvent('changed');
         }
@@ -283,7 +337,7 @@ import { BaseGraphNode } from '../node.js';
             ctor: ConstantVec2Node,
             name: 'ConstantVec2Node',
             getProps () {
-                return [
+                return defineProps([
                     {
                         name: 'isUniform',
                         type: 'bool',
@@ -298,10 +352,14 @@ import { BaseGraphNode } from '../node.js';
                         name: 'paramName',
                         type: 'string',
                         get (value) {
-                            value.str[0] = this.paramName;
+                            value.str[0] = this.paramName ? this.paramName.slice(2) : '';
                         },
                         set (value) {
-                            this.paramName = value.str[0];
+                            if (!/^[A-Za-z0-9_]+$/.test(value.str[0])) {
+                                console.log(`Invalid parameter name: ${value.str[0]}`);
+                            } else {
+                                this.paramName = `u_${value.str[0]}`;
+                            }
                         }
                     },
                     {
@@ -324,7 +382,7 @@ import { BaseGraphNode } from '../node.js';
                             this.y = value.num[0];
                         }
                     }
-                ];
+                ]);
             }
         };
     }
@@ -348,28 +406,130 @@ import { BaseGraphNode } from '../node.js';
     }
 }
 /**
- * Constant 3D vector (vec3) value node
- *
- * @remarks
- * Represents a 3-component vector constant (e.g., RGB colors, 3D positions, normals).
- * Provides multiple output slots:
- * - Output 1: The full vec3 value
- * - Output 2: The x component (swizzle)
- * - Output 3: The y component (swizzle)
- * - Output 4: The z component (swizzle)
+ * Constant 2D boolean vector (bvec2) value node
  *
- * Includes special 'rgb' serialization property for color picker integration.
- * Can be exposed as a uniform parameter for runtime modification.
- *
- * @example
- * ```typescript
- * const color = new ConstantVec3Node();
- * color.x = 1.0; // Red
- * color.y = 0.0; // Green
- * color.z = 0.0; // Blue
- * color.isUniform = true;
- * color.paramName = 'u_baseColor';
- * ```
+ * @public
+ */ class ConstantBVec2Node extends BaseGraphNode {
+    /** The 2D vector value [x, y] */ _value;
+    /**
+   * Creates a new constant bvec2 node
+   *
+   * @remarks
+   * Initializes with [false, false] and creates output slots for the full vector
+   * and individual components.
+   */ constructor(){
+        super();
+        this._value = [
+            false,
+            false
+        ];
+        this._outputs = [
+            {
+                id: 1,
+                name: ''
+            },
+            {
+                id: 2,
+                name: 'x',
+                swizzle: 'x'
+            },
+            {
+                id: 3,
+                name: 'y',
+                swizzle: 'y'
+            }
+        ];
+    }
+    /**
+   * Generates a string representation of this node
+   *
+   * @returns The parameter name if uniform, otherwise comma-separated values
+   *
+   * @remarks
+   * Values are rounded to 3 decimal places for display purposes.
+   */ toString() {
+        return `${String(this._value[0])},${String(this._value[1])}`;
+    }
+    /**
+   * Gets the x component of the vector
+   */ get x() {
+        return this._value[0];
+    }
+    set x(val) {
+        if (!!val !== this._value[0]) {
+            this._value[0] = !!val;
+            this.dispatchEvent('changed');
+        }
+    }
+    /**
+   * Gets the y component of the vector
+   */ get y() {
+        return this._value[1];
+    }
+    set y(val) {
+        if (!!val !== this._value[1]) {
+            this._value[1] = !!val;
+            this.dispatchEvent('changed');
+        }
+    }
+    /**
+   * Gets the serialization descriptor for this node type
+   *
+   * @returns Serialization class descriptor with property definitions
+   *
+   * @remarks
+   * Used by the serialization system to save/load node graphs.
+   */ static getSerializationCls() {
+        return {
+            ctor: ConstantBVec2Node,
+            name: 'ConstantBVec2Node',
+            getProps () {
+                return defineProps([
+                    {
+                        name: 'x',
+                        type: 'bool',
+                        get (value) {
+                            value.bool[0] = this.x;
+                        },
+                        set (value) {
+                            this.x = value.bool[0];
+                        }
+                    },
+                    {
+                        name: 'y',
+                        type: 'bool',
+                        get (value) {
+                            value.bool[0] = this.y;
+                        },
+                        set (value) {
+                            this.y = value.bool[0];
+                        }
+                    }
+                ]);
+            }
+        };
+    }
+    /**
+   * Validates the node state
+   *
+   * @returns Empty string (always valid)
+   *
+   * @remarks
+   * Constant nodes have no validation requirements.
+   */ validate() {
+        return '';
+    }
+    /**
+   * Gets the output type for a specific output slot
+   *
+   * @param id - The output slot ID
+   * @returns 'bool' for component outputs (id \> 1), 'bvec2' for the full vector
+   */ getType(id) {
+        return id > 1 ? 'bool' : 'bvec2';
+    }
+}
+/**
+ * Constant 3D vector (vec3) value node
  *
  * @public
  */ class ConstantVec3Node extends BaseGraphNode {
@@ -442,7 +602,7 @@ import { BaseGraphNode } from '../node.js';
         return this._paramName;
     }
     set paramName(val) {
-        if (val !== this._paramName) {
+        if (this._paramName !== val) {
             this._paramName = val;
             this.dispatchEvent('changed');
         }
@@ -493,7 +653,7 @@ import { BaseGraphNode } from '../node.js';
             ctor: ConstantVec3Node,
             name: 'ConstantVec3Node',
             getProps () {
-                return [
+                return defineProps([
                     {
                         name: 'isUniform',
                         type: 'bool',
@@ -508,10 +668,14 @@ import { BaseGraphNode } from '../node.js';
                         name: 'paramName',
                         type: 'string',
                         get (value) {
-                            value.str[0] = this.paramName;
+                            value.str[0] = this.paramName ? this.paramName.slice(2) : '';
                         },
                         set (value) {
-                            this.paramName = value.str[0];
+                            if (!/^[A-Za-z0-9_]+$/.test(value.str[0])) {
+                                console.log(`Invalid parameter name: ${value.str[0]}`);
+                            } else {
+                                this.paramName = `u_${value.str[0]}`;
+                            }
                         }
                     },
                     {
@@ -558,7 +722,7 @@ import { BaseGraphNode } from '../node.js';
                             this.z = value.num[2];
                         }
                     }
-                ];
+                ]);
             }
         };
     }
@@ -582,30 +746,158 @@ import { BaseGraphNode } from '../node.js';
     }
 }
 /**
- * Constant 4D vector (vec4) value node
- *
- * @remarks
- * Represents a 4-component vector constant (e.g., RGBA colors with alpha, 4D positions).
- * Provides multiple output slots:
- * - Output 1: The full vec4 value
- * - Output 2: The x component (swizzle)
- * - Output 3: The y component (swizzle)
- * - Output 4: The z component (swizzle)
- * - Output 5: The w component (swizzle)
+ * Constant 3D boolean vector (bvec3) value node
  *
- * Includes special 'rgba' serialization property for color picker integration with alpha.
- * Can be exposed as a uniform parameter for runtime modification.
- *
- * @example
- * ```typescript
- * const color = new ConstantVec4Node();
- * color.x = 1.0; // Red
- * color.y = 0.5; // Green
- * color.z = 0.0; // Blue
- * color.w = 0.8; // Alpha
- * color.isUniform = true;
- * color.paramName = 'u_tintColor';
- * ```
+ * @public
+ */ class ConstantBVec3Node extends BaseGraphNode {
+    /** The 3D vector value [x, y, z] */ _value;
+    /**
+   * Creates a new constant bvec3 node
+   *
+   * @remarks
+   * Initializes with [false, false, false] and creates output slots for the full vector
+   * and individual components.
+   */ constructor(){
+        super();
+        this._value = [
+            false,
+            false,
+            false
+        ];
+        this._outputs = [
+            {
+                id: 1,
+                name: ''
+            },
+            {
+                id: 2,
+                name: 'x',
+                swizzle: 'x'
+            },
+            {
+                id: 3,
+                name: 'y',
+                swizzle: 'y'
+            },
+            {
+                id: 4,
+                name: 'z',
+                swizzle: 'z'
+            }
+        ];
+    }
+    /**
+   * Generates a string representation of this node
+   *
+   * @returns The parameter name if uniform, otherwise comma-separated values
+   *
+   * @remarks
+   * Values are rounded to 3 decimal places for display purposes.
+   */ toString() {
+        return `${String(this._value[0])},${String(this._value[1])},${String(this._value[2])}`;
+    }
+    /**
+   * Gets the x component of the vector
+   */ get x() {
+        return this._value[0];
+    }
+    set x(val) {
+        if (!!val !== this._value[0]) {
+            this._value[0] = !!val;
+            this.dispatchEvent('changed');
+        }
+    }
+    /**
+   * Gets the y component of the vector
+   */ get y() {
+        return this._value[1];
+    }
+    set y(val) {
+        if (!!val !== this._value[1]) {
+            this._value[1] = !!val;
+            this.dispatchEvent('changed');
+        }
+    }
+    /**
+   * Gets the z component of the vector
+   */ get z() {
+        return this._value[2];
+    }
+    set z(val) {
+        if (!!val !== this._value[2]) {
+            this._value[2] = !!val;
+            this.dispatchEvent('changed');
+        }
+    }
+    /**
+   * Gets the serialization descriptor for this node type
+   *
+   * @returns Serialization class descriptor with property definitions
+   *
+   * @remarks
+   * Used by the serialization system to save/load node graphs.
+   * Includes an 'rgb' property for color picker integration.
+   */ static getSerializationCls() {
+        return {
+            ctor: ConstantBVec3Node,
+            name: 'ConstantBVec3Node',
+            getProps () {
+                return defineProps([
+                    {
+                        name: 'x',
+                        type: 'bool',
+                        get (value) {
+                            value.bool[0] = this.x;
+                        },
+                        set (value) {
+                            this.x = value.bool[0];
+                        }
+                    },
+                    {
+                        name: 'y',
+                        type: 'bool',
+                        get (value) {
+                            value.bool[0] = this.y;
+                        },
+                        set (value) {
+                            this.y = value.bool[0];
+                        }
+                    },
+                    {
+                        name: 'z',
+                        type: 'bool',
+                        get (value) {
+                            value.bool[0] = this.z;
+                        },
+                        set (value) {
+                            this.z = value.bool[0];
+                        }
+                    }
+                ]);
+            }
+        };
+    }
+    /**
+   * Validates the node state
+   *
+   * @returns Empty string (always valid)
+   *
+   * @remarks
+   * Constant nodes have no validation requirements.
+   */ validate() {
+        return '';
+    }
+    /**
+   * Gets the output type for a specific output slot
+   *
+   * @param id - The output slot ID
+   * @returns 'bool' for component outputs (id \> 1), 'bvec3' for the full vector
+   */ getType(id) {
+        return id > 1 ? 'bool' : 'bvec3';
+    }
+}
+/**
+ * Constant 4D vector (vec4) value node
  *
  * @public
  */ class ConstantVec4Node extends BaseGraphNode {
@@ -684,7 +976,7 @@ import { BaseGraphNode } from '../node.js';
         return this._paramName;
     }
     set paramName(val) {
-        if (val !== this._paramName) {
+        if (this._paramName !== val) {
             this._paramName = val;
             this.dispatchEvent('changed');
         }
@@ -746,7 +1038,7 @@ import { BaseGraphNode } from '../node.js';
             ctor: ConstantVec4Node,
             name: 'ConstantVec4Node',
             getProps () {
-                return [
+                return defineProps([
                     {
                         name: 'isUniform',
                         type: 'bool',
@@ -761,10 +1053,14 @@ import { BaseGraphNode } from '../node.js';
                         name: 'paramName',
                         type: 'string',
                         get (value) {
-                            value.str[0] = this.paramName;
+                            value.str[0] = this.paramName ? this.paramName.slice(2) : '';
                         },
                         set (value) {
-                            this.paramName = value.str[0];
+                            if (!/^[A-Za-z0-9_]+$/.test(value.str[0])) {
+                                console.log(`Invalid parameter name: ${value.str[0]}`);
+                            } else {
+                                this.paramName = `u_${value.str[0]}`;
+                            }
                         }
                     },
                     {
@@ -823,7 +1119,7 @@ import { BaseGraphNode } from '../node.js';
                             this.w = value.num[3];
                         }
                     }
-                ];
+                ]);
             }
         };
     }
@@ -846,6 +1142,184 @@ import { BaseGraphNode } from '../node.js';
         return id > 1 ? 'float' : 'vec4';
     }
 }
+/**
+ * Constant 4D boolean vector (bvec4) value node
+ *
+ * @public
+ */ class ConstantBVec4Node extends BaseGraphNode {
+    /** The 4D vector value [x, y, z, w] */ _value;
+    /**
+   * Creates a new constant vec4 node
+   *
+   * @remarks
+   * Initializes with [false, false, false, false] and creates output slots for the full vector
+   * and individual components.
+   */ constructor(){
+        super();
+        this._value = [
+            false,
+            false,
+            false,
+            false
+        ];
+        this._outputs = [
+            {
+                id: 1,
+                name: ''
+            },
+            {
+                id: 2,
+                name: 'x',
+                swizzle: 'x'
+            },
+            {
+                id: 3,
+                name: 'y',
+                swizzle: 'y'
+            },
+            {
+                id: 4,
+                name: 'z',
+                swizzle: 'z'
+            },
+            {
+                id: 5,
+                name: 'w',
+                swizzle: 'w'
+            }
+        ];
+    }
+    /**
+   * Generates a string representation of this node
+   *
+   * @returns The parameter name if uniform, otherwise comma-separated values
+   *
+   * @remarks
+   * Values are rounded to 3 decimal places for display purposes.
+   */ toString() {
+        return `${String(this._value[0])},${String(this._value[1])},${String(this._value[2])},${String(this._value[3])}`;
+    }
+    /**
+   * Gets the x component of the vector
+   */ get x() {
+        return this._value[0];
+    }
+    set x(val) {
+        if (!!val !== this._value[0]) {
+            this._value[0] = !!val;
+            this.dispatchEvent('changed');
+        }
+    }
+    /**
+   * Gets the y component of the vector
+   */ get y() {
+        return this._value[1];
+    }
+    set y(val) {
+        if (!!val !== this._value[1]) {
+            this._value[1] = !!val;
+            this.dispatchEvent('changed');
+        }
+    }
+    /**
+   * Gets the z component of the vector
+   */ get z() {
+        return this._value[2];
+    }
+    set z(val) {
+        if (!!val !== this._value[2]) {
+            this._value[2] = !!val;
+            this.dispatchEvent('changed');
+        }
+    }
+    /**
+   * Gets the w component of the vector
+   */ get w() {
+        return this._value[3];
+    }
+    set w(val) {
+        if (!!val !== this._value[3]) {
+            this._value[3] = !!val;
+            this.dispatchEvent('changed');
+        }
+    }
+    /**
+   * Gets the serialization descriptor for this node type
+   *
+   * @returns Serialization class descriptor with property definitions
+   *
+   * @remarks
+   * Used by the serialization system to save/load node graphs.
+   * Includes an 'rgba' property for color picker integration with alpha channel.
+   */ static getSerializationCls() {
+        return {
+            ctor: ConstantBVec4Node,
+            name: 'ConstantBVec4Node',
+            getProps () {
+                return defineProps([
+                    {
+                        name: 'x',
+                        type: 'bool',
+                        get (value) {
+                            value.bool[0] = this.x;
+                        },
+                        set (value) {
+                            this.x = value.bool[0];
+                        }
+                    },
+                    {
+                        name: 'y',
+                        type: 'bool',
+                        get (value) {
+                            value.bool[0] = this.y;
+                        },
+                        set (value) {
+                            this.y = value.bool[0];
+                        }
+                    },
+                    {
+                        name: 'z',
+                        type: 'bool',
+                        get (value) {
+                            value.bool[0] = this.z;
+                        },
+                        set (value) {
+                            this.z = value.bool[0];
+                        }
+                    },
+                    {
+                        name: 'w',
+                        type: 'bool',
+                        get (value) {
+                            value.bool[0] = this.w;
+                        },
+                        set (value) {
+                            this.w = value.bool[0];
+                        }
+                    }
+                ]);
+            }
+        };
+    }
+    /**
+   * Validates the node state
+   *
+   * @returns Empty string (always valid)
+   *
+   * @remarks
+   * Constant nodes have no validation requirements.
+   */ validate() {
+        return '';
+    }
+    /**
+   * Gets the output type for a specific output slot
+   *
+   * @param id - The output slot ID
+   * @returns 'bool' for component outputs (id \> 1), 'bvec4' for the full vector
+   */ getType(id) {
+        return id > 1 ? 'bool' : 'bvec4';
+    }
+}
 
-export { ConstantScalarNode, ConstantVec2Node, ConstantVec3Node, ConstantVec4Node };
+export { ConstantBVec2Node, ConstantBVec3Node, ConstantBVec4Node, ConstantBooleanNode, ConstantScalarNode, ConstantVec2Node, ConstantVec3Node, ConstantVec4Node };
 //# sourceMappingURL=constants.js.map