sparcoon 0.6.1 → 0.7.1

package/dist/nodes/blending/FXNodeLightnessBlendingMask.d.ts

@@ -0,0 +1,16 @@
+import { FXNodeBlending } from "./FXNodeBlending";
+export declare class FXNodeLightnessBlendingMask extends FXNodeBlending {
+    private readonly uniformEdge0;
+    private readonly uniformEdge1;
+    /**
+     * @param edge0 - brightness threshold where mask starts (below this: NormalBlending). Defaults to `0.3`
+     * @param edge1 - brightness threshold where mask is fully active (above this: full FXBlending effect). Defaults to `0.7`
+     */
+    constructor(edge0?: number, edge1?: number);
+    /** Brightness threshold where mask starts (below this: NormalBlending) */
+    get edge0(): number;
+    /** Brightness threshold where mask is fully active (above this: full FXBlending effect) */
+    get edge1(): number;
+    set edge0(value: number);
+    set edge1(value: number);
+}

package/dist/nodes/blending/FXNodeLightnessBlendingMask.js

@@ -0,0 +1,49 @@
+import { getNextInstanceId } from '../../miscellaneous/miscellaneous.js';
+import { CURRENT_EXPRESSION_VALUE_PLACEHOLDER, BLENDING_EXPRESSION_CURRENT_COLOR_PLACEHOLDER } from '../FXNode.js';
+import { FXNodeBlending } from './FXNodeBlending.js';
+
+class FXNodeLightnessBlendingMask extends FXNodeBlending {
+    /**
+     * @param edge0 - brightness threshold where mask starts (below this: NormalBlending). Defaults to `0.3`
+     * @param edge1 - brightness threshold where mask is fully active (above this: full FXBlending effect). Defaults to `0.7`
+     */
+    constructor(edge0 = 0.3, edge1 = 0.7) {
+        super();
+        /** @internal */
+        this.cacheKey = "lightness-blending-mask";
+        const id = getNextInstanceId();
+        this._private_uniformEdge0 = `u_LightnessBlendingMaskEdge0_${id}`;
+        this._private_uniformEdge1 = `u_LightnessBlendingMaskEdge1_${id}`;
+        this.uniformDeclarations = [
+            `uniform float ${this._private_uniformEdge0};`,
+            `uniform float ${this._private_uniformEdge1};`,
+        ];
+        this.uniforms = {
+            [this._private_uniformEdge0]: { value: edge0 },
+            [this._private_uniformEdge1]: { value: edge1 },
+        };
+        this.helperFunctions = `
+      float fxLightnessBlendingMask(vec4 color, float edge0, float edge1) {
+        float brightness = dot(color.rgb, vec3(0.2126, 0.7152, 0.0722));
+        return smoothstep(edge0, edge1, brightness);
+      }
+    `;
+        this.blendingExpression = `${CURRENT_EXPRESSION_VALUE_PLACEHOLDER} * fxLightnessBlendingMask(${BLENDING_EXPRESSION_CURRENT_COLOR_PLACEHOLDER}, ${this._private_uniformEdge0}, ${this._private_uniformEdge1})`;
+    }
+    /** Brightness threshold where mask starts (below this: NormalBlending) */
+    get edge0() {
+        return this.uniforms[this._private_uniformEdge0].value;
+    }
+    /** Brightness threshold where mask is fully active (above this: full FXBlending effect) */
+    get edge1() {
+        return this.uniforms[this._private_uniformEdge1].value;
+    }
+    set edge0(value) {
+        this.uniforms[this._private_uniformEdge0].value = value;
+    }
+    set edge1(value) {
+        this.uniforms[this._private_uniformEdge1].value = value;
+    }
+}
+
+export { FXNodeLightnessBlendingMask };

package/dist/nodes/color/FXNodeColor.d.ts

@@ -1,7 +1,6 @@
+import { FXNode } from "../FXNode";
 /**
  * Abstract base class for particle color nodes
  */
-export declare abstract class FXNodeColor {
-    /** Releases any GPU resources held by this node */
-    destroy?(): void;
+export declare abstract class FXNodeColor extends FXNode {
 }

package/dist/nodes/color/FXNodeColor.js

@@ -1,11 +1,9 @@
+import { FXNode } from '../FXNode.js';
+
 /**
  * Abstract base class for particle color nodes
  */
-class FXNodeColor {
-    constructor() {
-        /** @internal */
-        this.affectsDepth = false;
-    }
+class FXNodeColor extends FXNode {
 }
 
 export { FXNodeColor };

package/dist/nodes/color/FXNodeColorOverLife.d.ts

@@ -14,11 +14,6 @@ export declare class FXNodeColorOverLife extends FXNodeColor {
     constructor(curve: FXCurve1DConfig<FXColor>);
     /** Current color gradient curve */
     get curve(): FXCurve1D<FXColor>;
-    /**
-     * Replaces the color gradient curve and rebuilds the backing texture
-     *
-     * @param value - New color gradient configuration
-     */
     set curve(value: FXCurve1DConfig<FXColor>);
     /** Releases the backing gradient texture */
     destroy(): void;

package/dist/nodes/color/FXNodeColorOverLife.js

@@ -1,6 +1,7 @@
 import { FXCurve1D } from '../../miscellaneous/curve/FXCurve1D.js';
 import { buildGradientTexture, getNextInstanceId } from '../../miscellaneous/miscellaneous.js';
 import { checkSRGBSupport } from '../../miscellaneous/webglCapabilities.js';
+import { CURRENT_EXPRESSION_VALUE_PLACEHOLDER } from '../FXNode.js';
 import { FXNodeColor } from './FXNodeColor.js';
 
 /**
@@ -12,12 +13,14 @@ class FXNodeColorOverLife extends FXNodeColor {
      */
     constructor(curve) {
         super();
+        /** @internal */
+        this.affectsDepth = true;
+        /** @internal */
+        this.cacheKey = "color-over-life";
         const id = getNextInstanceId();
         this._private_uniformName = `u_ColorOverLife_${id}`;
         this._private_curveInternal = new FXCurve1D(curve);
         this._private_gradientTexture = buildGradientTexture(this._private_curveInternal);
-        this.affectsDepth = true;
-        this.cacheKey = "color-over-life";
         this.uniformDeclarations = [`uniform sampler2D ${this._private_uniformName};`];
         this.uniforms = {
             [this._private_uniformName]: { value: this._private_gradientTexture },
@@ -34,17 +37,12 @@ class FXNodeColorOverLife extends FXNodeColor {
         return color;
       }
     `;
-        this.colorExpression = `fxSampleColorOverLife(${this._private_uniformName})`;
+        this.colorExpression = `${CURRENT_EXPRESSION_VALUE_PLACEHOLDER} * fxSampleColorOverLife(${this._private_uniformName})`;
     }
     /** Current color gradient curve */
     get curve() {
         return this._private_curveInternal;
     }
-    /**
-     * Replaces the color gradient curve and rebuilds the backing texture
-     *
-     * @param value - New color gradient configuration
-     */
     set curve(value) {
         this._private_curveInternal = new FXCurve1D(value);
         this._private_gradientTexture.dispose();

package/dist/nodes/color/FXNodeSphericalClip.js

@@ -1,5 +1,6 @@
 import { assertValidNonNegativeNumber } from '../../miscellaneous/asserts.js';
 import { getNextInstanceId } from '../../miscellaneous/miscellaneous.js';
+import { CURRENT_EXPRESSION_VALUE_PLACEHOLDER } from '../FXNode.js';
 import { FXNodeColor } from './FXNodeColor.js';
 
 /**
@@ -15,11 +16,13 @@ class FXNodeSphericalClip extends FXNodeColor {
      */
     constructor(innerRadius = 0.5) {
         super();
+        /** @internal */
+        this.affectsDepth = true;
+        /** @internal */
+        this.cacheKey = "spherical-clip";
         assertValidNonNegativeNumber(innerRadius, "FXNodeSphericalClip.constructor.innerRadius");
         const id = getNextInstanceId();
         this._private_uniformInnerRadius = `u_SphericalClipInnerRadius_${id}`;
-        this.affectsDepth = true;
-        this.cacheKey = "spherical-clip";
         this.uniformDeclarations = [`uniform float ${this._private_uniformInnerRadius};`];
         this.uniforms = {
             [this._private_uniformInnerRadius]: { value: innerRadius },
@@ -30,7 +33,7 @@ class FXNodeSphericalClip extends FXNodeColor {
         return vec4(1.0, 1.0, 1.0, 1.0 - smoothstep(innerRadius, 0.5, distanceToCenter));
       }
     `;
-        this.colorExpression = `fxApplySphericalClip(${this._private_uniformInnerRadius})`;
+        this.colorExpression = `${CURRENT_EXPRESSION_VALUE_PLACEHOLDER} * fxApplySphericalClip(${this._private_uniformInnerRadius})`;
     }
     /** UV radius of the fully opaque inner area */
     get innerRadius() {

package/dist/nodes/normal/FXNodeFlatNormal.d.ts

@@ -3,5 +3,4 @@ import { FXNodeNormal } from "./FXNodeNormal";
  * Normal node that outputs a constant face-aligned normal pointing toward the camera
  */
 export declare class FXNodeFlatNormal extends FXNodeNormal {
-    constructor();
 }

package/dist/nodes/normal/FXNodeFlatNormal.js

@@ -1,3 +1,4 @@
+import { CURRENT_EXPRESSION_VALUE_PLACEHOLDER } from '../FXNode.js';
 import { FXNodeNormal } from './FXNodeNormal.js';
 
 /**
@@ -5,12 +6,11 @@ import { FXNodeNormal } from './FXNodeNormal.js';
  */
 class FXNodeFlatNormal extends FXNodeNormal {
     constructor() {
-        super();
+        super(...arguments);
+        /** @internal */
         this.cacheKey = "flat-normal";
-        this.uniformDeclarations = [];
-        this.uniforms = {};
-        this.helperFunctions = "";
-        this.normalExpression = "vec3(0.0, 0.0, 1.0)";
+        /** @internal */
+        this.normalExpression = `${CURRENT_EXPRESSION_VALUE_PLACEHOLDER} * vec3(0.0, 0.0, 1.0)`;
     }
 }
 

package/dist/nodes/normal/FXNodeNormal.d.ts

@@ -1,7 +1,6 @@
+import { FXNode } from "../FXNode";
 /**
  * Abstract base class for particle normal nodes
  */
-export declare abstract class FXNodeNormal {
-    /** Releases any GPU resources held by this node */
-    destroy?(): void;
+export declare abstract class FXNodeNormal extends FXNode {
 }

package/dist/nodes/normal/FXNodeNormal.js

@@ -1,7 +1,9 @@
+import { FXNode } from '../FXNode.js';
+
 /**
  * Abstract base class for particle normal nodes
  */
-class FXNodeNormal {
+class FXNodeNormal extends FXNode {
 }
 
 export { FXNodeNormal };

package/dist/nodes/normal/FXNodeSphericalNormal.d.ts

@@ -3,5 +3,4 @@ import { FXNodeNormal } from "./FXNodeNormal";
  * Normal node that makes flat billboard particles appear as spheres under directional lighting
  */
 export declare class FXNodeSphericalNormal extends FXNodeNormal {
-    constructor();
 }

package/dist/nodes/normal/FXNodeSphericalNormal.js

@@ -1,3 +1,4 @@
+import { CURRENT_EXPRESSION_VALUE_PLACEHOLDER } from '../FXNode.js';
 import { FXNodeNormal } from './FXNodeNormal.js';
 
 /**
@@ -5,17 +6,18 @@ import { FXNodeNormal } from './FXNodeNormal.js';
  */
 class FXNodeSphericalNormal extends FXNodeNormal {
     constructor() {
-        super();
+        super(...arguments);
+        /** @internal */
         this.cacheKey = "spherical-normal";
-        this.uniformDeclarations = [];
-        this.uniforms = {};
+        /** @internal */
         this.helperFunctions = `
-      vec3 fxComputeSphericalNormal(vec2 uv) {
-        vec2 centeredUV = uv * 2.0 - 1.0;
-        return normalize(vec3(centeredUV, sqrt(max(0.0, 1.0 - dot(centeredUV, centeredUV)))));
-      }
-    `;
-        this.normalExpression = "fxComputeSphericalNormal(p_uv)";
+    vec3 fxComputeSphericalNormal(vec2 uv) {
+      vec2 centeredUV = uv * 2.0 - 1.0;
+      return normalize(vec3(centeredUV, sqrt(max(0.0, 1.0 - dot(centeredUV, centeredUV)))));
+    }
+  `;
+        /** @internal */
+        this.normalExpression = `${CURRENT_EXPRESSION_VALUE_PLACEHOLDER} * fxComputeSphericalNormal(p_uv)`;
     }
 }
 

package/dist/nodes/texture/FXNodeAnimatedTexture.d.ts

@@ -30,18 +30,18 @@ export declare class FXNodeAnimatedTexture extends FXNodeTexture {
     private readonly uniformUVTransform;
     private readonly uniformColumns;
     private readonly uniformRows;
-    private readonly textureViewInternal;
+    private readonly textureInternal;
     /**
      * @param options - Sprite sheet configuration
      */
     constructor({ texture, columns, rows, interpolate }: FXNodeAnimatedTextureOptions);
     /** View describing the texture and its atlas region */
-    get textureView(): FXTextureView;
+    get texture(): FXTextureView;
     /** Number of frame columns in the sprite sheet */
     get columns(): number;
     /** Number of frame rows in the sprite sheet */
     get rows(): number;
-    set textureView(config: FXTextureConfig);
+    set texture(config: FXTextureConfig);
     set columns(value: number);
     set rows(value: number);
 }

package/dist/nodes/texture/FXNodeAnimatedTexture.js

@@ -2,6 +2,7 @@ import { assertValidPositiveNumber } from '../../miscellaneous/asserts.js';
 import { getNextInstanceId } from '../../miscellaneous/miscellaneous.js';
 import { FXTextureView } from '../../miscellaneous/texture/FXTextureView.js';
 import { checkSRGBSupport } from '../../miscellaneous/webglCapabilities.js';
+import { CURRENT_EXPRESSION_VALUE_PLACEHOLDER } from '../FXNode.js';
 import { FXNodeTexture } from './FXNodeTexture.js';
 
 /**
@@ -17,6 +18,8 @@ class FXNodeAnimatedTexture extends FXNodeTexture {
      */
     constructor({ texture, columns, rows, interpolate = false }) {
         super();
+        /** @internal */
+        this.affectsDepth = true;
         assertValidPositiveNumber(columns, "FXNodeAnimatedTexture.constructor.columns");
         assertValidPositiveNumber(rows, "FXNodeAnimatedTexture.constructor.rows");
         const idx = getNextInstanceId();
@@ -24,14 +27,13 @@ class FXNodeAnimatedTexture extends FXNodeTexture {
         this._private_uniformUVTransform = `u_AnimatedTextureUVTransform_${idx}`;
         this._private_uniformColumns = `u_AnimatedTextureColumns_${idx}`;
         this._private_uniformRows = `u_AnimatedTextureRows_${idx}`;
-        this._private_textureViewInternal = new FXTextureView(texture);
-        const uvTransform = this._private_textureViewInternal.calculateUVTransform();
-        this._private_textureViewInternal.setTextureDirtyFalse();
-        this._private_textureViewInternal.setUVTransformDirtyFalse();
+        this._private_textureInternal = new FXTextureView(texture);
+        const uvTransform = this._private_textureInternal.calculateUVTransform();
+        this._private_textureInternal.setTextureDirtyFalse();
+        this._private_textureInternal.setUVTransformDirtyFalse();
         const gammaCorrection = checkSRGBSupport()
             ? ""
             : "color = vec4(pow(color.rgb, vec3(2.2)), color.a);";
-        this.affectsDepth = true;
         this.cacheKey = interpolate ? "animated-texture-interpolated" : "animated-texture";
         this.uniformDeclarations = [
             `uniform sampler2D ${this._private_uniformTexture};`,
@@ -40,7 +42,7 @@ class FXNodeAnimatedTexture extends FXNodeTexture {
             `uniform float ${this._private_uniformRows};`,
         ];
         this.uniforms = {
-            [this._private_uniformTexture]: { value: this._private_textureViewInternal.texture },
+            [this._private_uniformTexture]: { value: this._private_textureInternal.texture },
             [this._private_uniformUVTransform]: { value: uvTransform },
             [this._private_uniformColumns]: { value: columns },
             [this._private_uniformRows]: { value: rows },
@@ -99,11 +101,11 @@ class FXNodeAnimatedTexture extends FXNodeTexture {
           return color;
         }
       `;
-        this.colorExpression = `fxSampleAnimatedTexture(${this._private_uniformTexture}, ${this._private_uniformUVTransform}, p_uv, ${this._private_uniformColumns}, ${this._private_uniformRows})`;
+        this.colorExpression = `${CURRENT_EXPRESSION_VALUE_PLACEHOLDER} * fxSampleAnimatedTexture(${this._private_uniformTexture}, ${this._private_uniformUVTransform}, p_uv, ${this._private_uniformColumns}, ${this._private_uniformRows})`;
     }
     /** View describing the texture and its atlas region */
-    get textureView() {
-        return this._private_textureViewInternal;
+    get texture() {
+        return this._private_textureInternal;
     }
     /** Number of frame columns in the sprite sheet */
     get columns() {
@@ -113,15 +115,15 @@ class FXNodeAnimatedTexture extends FXNodeTexture {
     get rows() {
         return this.uniforms[this._private_uniformRows].value;
     }
-    set textureView(config) {
-        this._private_textureViewInternal.set(config);
-        if (this._private_textureViewInternal.textureDirty) {
-            this.uniforms[this._private_uniformTexture].value = this._private_textureViewInternal.texture;
-            this._private_textureViewInternal.setTextureDirtyFalse();
+    set texture(config) {
+        this._private_textureInternal.set(config);
+        if (this._private_textureInternal.textureDirty) {
+            this.uniforms[this._private_uniformTexture].value = this._private_textureInternal.texture;
+            this._private_textureInternal.setTextureDirtyFalse();
         }
-        if (this._private_textureViewInternal.uvTransformDirty) {
-            this._private_textureViewInternal.calculateUVTransform(this.uniforms[this._private_uniformUVTransform].value);
-            this._private_textureViewInternal.setUVTransformDirtyFalse();
+        if (this._private_textureInternal.uvTransformDirty) {
+            this._private_textureInternal.calculateUVTransform(this.uniforms[this._private_uniformUVTransform].value);
+            this._private_textureInternal.setUVTransformDirtyFalse();
         }
     }
     set columns(value) {

package/dist/nodes/texture/FXNodeStaticTexture.d.ts

@@ -7,12 +7,12 @@ import { FXNodeTexture } from "./FXNodeTexture";
 export declare class FXNodeStaticTexture extends FXNodeTexture {
     private readonly uniformTexture;
     private readonly uniformUVTransform;
-    private readonly textureViewInternal;
+    private readonly textureInternal;
     /**
      * @param config - Texture or atlas configuration applied to every particle
      */
     constructor(config: FXTextureConfig);
     /** View describing the texture and its atlas region */
-    get textureView(): FXTextureView;
-    set textureView(config: FXTextureConfig);
+    get texture(): FXTextureView;
+    set texture(config: FXTextureConfig);
 }

package/dist/nodes/texture/FXNodeStaticTexture.js

@@ -1,6 +1,7 @@
 import { getNextInstanceId } from '../../miscellaneous/miscellaneous.js';
 import { FXTextureView } from '../../miscellaneous/texture/FXTextureView.js';
 import { checkSRGBSupport } from '../../miscellaneous/webglCapabilities.js';
+import { CURRENT_EXPRESSION_VALUE_PLACEHOLDER } from '../FXNode.js';
 import { FXNodeTexture } from './FXNodeTexture.js';
 
 /**
@@ -12,21 +13,23 @@ class FXNodeStaticTexture extends FXNodeTexture {
      */
     constructor(config) {
         super();
+        /** @internal */
+        this.affectsDepth = true;
+        /** @internal */
+        this.cacheKey = "static-texture";
         const id = getNextInstanceId();
         this._private_uniformTexture = `u_StaticTexture_${id}`;
         this._private_uniformUVTransform = `u_StaticTextureUVTransform_${id}`;
-        this._private_textureViewInternal = new FXTextureView(config);
-        const uvTransform = this._private_textureViewInternal.calculateUVTransform();
-        this._private_textureViewInternal.setTextureDirtyFalse();
-        this._private_textureViewInternal.setUVTransformDirtyFalse();
-        this.affectsDepth = true;
-        this.cacheKey = "static-texture";
+        this._private_textureInternal = new FXTextureView(config);
+        const uvTransform = this._private_textureInternal.calculateUVTransform();
+        this._private_textureInternal.setTextureDirtyFalse();
+        this._private_textureInternal.setUVTransformDirtyFalse();
         this.uniformDeclarations = [
             `uniform sampler2D ${this._private_uniformTexture};`,
             `uniform mat3 ${this._private_uniformUVTransform};`,
         ];
         this.uniforms = {
-            [this._private_uniformTexture]: { value: this._private_textureViewInternal.texture },
+            [this._private_uniformTexture]: { value: this._private_textureInternal.texture },
             [this._private_uniformUVTransform]: { value: uvTransform },
         };
         this.helperFunctions = `
@@ -38,21 +41,21 @@ class FXNodeStaticTexture extends FXNodeTexture {
         return color;
       }
     `;
-        this.colorExpression = `fxSampleStaticTexture(${this._private_uniformTexture}, ${this._private_uniformUVTransform}, p_uv)`;
+        this.colorExpression = `${CURRENT_EXPRESSION_VALUE_PLACEHOLDER} * fxSampleStaticTexture(${this._private_uniformTexture}, ${this._private_uniformUVTransform}, p_uv)`;
     }
     /** View describing the texture and its atlas region */
-    get textureView() {
-        return this._private_textureViewInternal;
+    get texture() {
+        return this._private_textureInternal;
     }
-    set textureView(config) {
-        this._private_textureViewInternal.set(config);
-        if (this._private_textureViewInternal.textureDirty) {
-            this.uniforms[this._private_uniformTexture].value = this._private_textureViewInternal.texture;
-            this._private_textureViewInternal.setTextureDirtyFalse();
+    set texture(config) {
+        this._private_textureInternal.set(config);
+        if (this._private_textureInternal.textureDirty) {
+            this.uniforms[this._private_uniformTexture].value = this._private_textureInternal.texture;
+            this._private_textureInternal.setTextureDirtyFalse();
         }
-        if (this._private_textureViewInternal.uvTransformDirty) {
-            this._private_textureViewInternal.calculateUVTransform(this.uniforms[this._private_uniformUVTransform].value);
-            this._private_textureViewInternal.setUVTransformDirtyFalse();
+        if (this._private_textureInternal.uvTransformDirty) {
+            this._private_textureInternal.calculateUVTransform(this.uniforms[this._private_uniformUVTransform].value);
+            this._private_textureInternal.setUVTransformDirtyFalse();
         }
     }
 }

package/dist/nodes/texture/FXNodeTexture.d.ts

@@ -1,7 +1,6 @@
+import { FXNode } from "../FXNode";
 /**
  * Abstract base class for particle texture nodes
  */
-export declare abstract class FXNodeTexture {
-    /** Releases any GPU resources held by this node */
-    destroy?(): void;
+export declare abstract class FXNodeTexture extends FXNode {
 }

package/dist/nodes/texture/FXNodeTexture.js

@@ -1,11 +1,9 @@
+import { FXNode } from '../FXNode.js';
+
 /**
  * Abstract base class for particle texture nodes
  */
-class FXNodeTexture {
-    constructor() {
-        /** @internal */
-        this.affectsDepth = false;
-    }
+class FXNodeTexture extends FXNode {
 }
 
 export { FXNodeTexture };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sparcoon",
-  "version": "0.6.1",
+  "version": "0.7.1",
   "description": "Instanced-mesh particle system for Three.js.",
   "keywords": [
     "particles",