sparcoon 0.1.0 → 0.2.0

package/dist/miscellaneous/texture/FXTextureView.js

@@ -1,234 +0,0 @@
-import { Ferrsign3 } from 'ferrsign';
-import { Matrix3, Vector2, Texture } from 'three';
-import { assertValidPositiveNumber, assertValidNonNegativeNumber } from '../asserts.js';
-import { TEXTURE_DEFAULT_TEXTURE, TEXTURE_DEFAULT_SIZE } from './FXTextureView.Internal.js';
-
-/** Wrapper for Three.js texture with atlas and trim support. Does not own the underlying texture; user must dispose it. */
-class FXTextureView {
-    /** @param config Texture or atlas configuration */
-    constructor(config) {
-        this._private_textureInternal = TEXTURE_DEFAULT_TEXTURE;
-        this._private_sourceWidth = TEXTURE_DEFAULT_SIZE;
-        this._private_sourceHeight = TEXTURE_DEFAULT_SIZE;
-        this._private_frameX = 0;
-        this._private_frameY = 0;
-        this._private_frameWidth = TEXTURE_DEFAULT_SIZE;
-        this._private_frameHeight = TEXTURE_DEFAULT_SIZE;
-        this._private_rotatedInternal = false;
-        this._private_scaleInternal = 1;
-        this._private_trimLeft = 0;
-        this._private_trimRight = 0;
-        this._private_trimTop = 0;
-        this._private_trimBottom = 0;
-        this._private_textureDirtyInternal = false;
-        this._private_uvTransformDirtyInternal = false;
-        this._private_trimDirtyInternal = false;
-        this._private_signalDiminsionsChangedInternal = new Ferrsign3();
-        if (config !== undefined) {
-            this.set(config);
-        }
-    }
-    /** Original width before trimming in world units */
-    get width() {
-        return this._private_sourceWidth / this._private_scaleInternal;
-    }
-    /** Original height before trimming in world units */
-    get height() {
-        return this._private_sourceHeight / this._private_scaleInternal;
-    }
-    /** Visible width after trimming in world units */
-    get trimmedWidth() {
-        const frameSize = this._private_rotatedInternal ? this._private_frameHeight : this._private_frameWidth;
-        return frameSize / this._private_scaleInternal;
-    }
-    /** Visible height after trimming in world units */
-    get trimmedHeight() {
-        const frameSize = this._private_rotatedInternal ? this._private_frameWidth : this._private_frameHeight;
-        return frameSize / this._private_scaleInternal;
-    }
-    /** Underlying Three.js texture */
-    get texture() {
-        return this._private_textureInternal;
-    }
-    /** Whether sprite is rotated in atlas */
-    get rotated() {
-        return this._private_rotatedInternal;
-    }
-    /** Scale factor for resolution independence */
-    get scale() {
-        return this._private_scaleInternal;
-    }
-    /** Transparent padding around visible content */
-    get trim() {
-        const scale = this._private_scaleInternal;
-        return {
-            left: this._private_trimLeft / scale,
-            right: this._private_trimRight / scale,
-            top: this._private_trimTop / scale,
-            bottom: this._private_trimBottom / scale,
-        };
-    }
-    get textureDirty() {
-        return this._private_textureDirtyInternal;
-    }
-    /** Whether UV transform inputs changed since last check */
-    get uvTransformDirty() {
-        return this._private_uvTransformDirtyInternal;
-    }
-    /** Whether trim values changed since last check */
-    get trimDirty() {
-        return this._private_trimDirtyInternal;
-    }
-    get signalDiminsionsChanged() {
-        return this._private_signalDiminsionsChangedInternal;
-    }
-    setTextureDirtyFalse() {
-        this._private_textureDirtyInternal = false;
-    }
-    /** Marks UV transform as clean. @internal */
-    setUVTransformDirtyFalse() {
-        this._private_uvTransformDirtyInternal = false;
-    }
-    /** Marks trim as clean. @internal */
-    setTrimDirtyFalse() {
-        this._private_trimDirtyInternal = false;
-    }
-    /**
-     * Calculates UV transform matrix for shader sampling.
-     * @param result Matrix to store result in
-     * @returns UV transform matrix
-     */
-    calculateUVTransform(result = new Matrix3()) {
-        const atlasWidth = this._private_textureInternal.image?.naturalWidth ?? TEXTURE_DEFAULT_SIZE;
-        const atlasHeight = this._private_textureInternal.image?.naturalHeight ?? TEXTURE_DEFAULT_SIZE;
-        if (this._private_rotatedInternal) {
-            const physicalWidth = this._private_frameHeight;
-            const physicalHeight = this._private_frameWidth;
-            const u0 = this._private_frameX / atlasWidth;
-            const v0 = (atlasHeight - this._private_frameY - physicalHeight) / atlasHeight;
-            const uSize = physicalWidth / atlasWidth;
-            const vSize = physicalHeight / atlasHeight;
-            result.set(0, uSize, u0, -vSize, 0, v0 + vSize, 0, 0, 1);
-        }
-        else {
-            const u0 = this._private_frameX / atlasWidth;
-            const v0 = (atlasHeight - this._private_frameY - this._private_frameHeight) / atlasHeight;
-            const uSize = this._private_frameWidth / atlasWidth;
-            const vSize = this._private_frameHeight / atlasHeight;
-            result.set(uSize, 0, u0, 0, vSize, v0, 0, 0, 1);
-        }
-        return result;
-    }
-    /**
-     * Gets original dimensions before trimming.
-     * @param result Vector to store result in
-     * @returns Width and height in world units
-     */
-    getResolution(result = new Vector2()) {
-        return result.set(this.width, this.height);
-    }
-    /**
-     * Replaces texture with new configuration.
-     * @param config Texture or atlas configuration
-     */
-    set(config) {
-        const lastWidth = this.width;
-        const lastHeight = this.height;
-        if (config instanceof Texture) {
-            this._private_setFromTexture(config);
-        }
-        else {
-            this._private_setFromAtlasConfig(config);
-        }
-        if (this.width !== lastWidth || this.height !== lastHeight) {
-            this._private_signalDiminsionsChangedInternal.emit(this.width, this.height, this);
-        }
-    }
-    _private_setFromTexture(texture) {
-        const width = texture.image?.naturalWidth ?? TEXTURE_DEFAULT_SIZE;
-        const height = texture.image?.naturalHeight ?? TEXTURE_DEFAULT_SIZE;
-        this._private_sourceWidth = width;
-        this._private_sourceHeight = height;
-        if (this.texture !== texture) {
-            this._private_textureInternal = texture;
-            this._private_textureDirtyInternal = true;
-        }
-        if (this._private_frameX !== 0 ||
-            this._private_frameY !== 0 ||
-            this._private_frameWidth !== width ||
-            this._private_frameHeight !== height ||
-            this._private_scaleInternal !== 1 || this._private_rotatedInternal) {
-            this._private_frameX = 0;
-            this._private_frameY = 0;
-            this._private_frameWidth = width;
-            this._private_frameHeight = height;
-            this._private_rotatedInternal = false;
-            this._private_scaleInternal = 1;
-            this._private_uvTransformDirtyInternal = true;
-        }
-        if (this._private_trimLeft !== 0 ||
-            this._private_trimRight !== 0 ||
-            this._private_trimTop !== 0 ||
-            this._private_trimBottom !== 0) {
-            this._private_trimLeft = 0;
-            this._private_trimRight = 0;
-            this._private_trimTop = 0;
-            this._private_trimBottom = 0;
-            this._private_trimDirtyInternal = true;
-        }
-    }
-    _private_setFromAtlasConfig(config) {
-        assertValidPositiveNumber(config.sourceSize.w, "FXTextureView.setFromAtlasConfig.config.sourceSize.w");
-        assertValidPositiveNumber(config.sourceSize.h, "FXTextureView.setFromAtlasConfig.config.sourceSize.h");
-        assertValidNonNegativeNumber(config.frame.x, "FXTextureView.setFromAtlasConfig.config.frame.x");
-        assertValidNonNegativeNumber(config.frame.y, "FXTextureView.setFromAtlasConfig.config.frame.y");
-        assertValidPositiveNumber(config.frame.w, "FXTextureView.setFromAtlasConfig.config.frame.w");
-        assertValidPositiveNumber(config.frame.h, "FXTextureView.setFromAtlasConfig.config.frame.h");
-        assertValidNonNegativeNumber(config.spriteSourceSize.x, "FXTextureView.setFromAtlasConfig.config.spriteSourceSize.x");
-        assertValidNonNegativeNumber(config.spriteSourceSize.y, "FXTextureView.setFromAtlasConfig.config.spriteSourceSize.y");
-        assertValidPositiveNumber(config.spriteSourceSize.w, "FXTextureView.setFromAtlasConfig.config.spriteSourceSize.w");
-        assertValidPositiveNumber(config.spriteSourceSize.h, "FXTextureView.setFromAtlasConfig.config.spriteSourceSize.h");
-        if (config.scale !== undefined) {
-            assertValidPositiveNumber(config.scale, "FXTextureView.setFromAtlasConfig.config.scale");
-        }
-        this._private_sourceWidth = config.sourceSize.w;
-        this._private_sourceHeight = config.sourceSize.h;
-        if (this.texture !== config.texture) {
-            this._private_textureInternal = config.texture;
-            this._private_textureDirtyInternal = true;
-        }
-        const scale = config.scale ?? 1;
-        const rotated = config.rotated ?? false;
-        if (this._private_frameX !== 0 ||
-            this._private_frameY !== 0 ||
-            this._private_frameWidth !== config.frame.w ||
-            this._private_frameHeight !== config.frame.h ||
-            this._private_scaleInternal !== scale ||
-            this._private_rotatedInternal !== rotated) {
-            this._private_frameX = config.frame.x;
-            this._private_frameY = config.frame.y;
-            this._private_frameWidth = config.frame.w;
-            this._private_frameHeight = config.frame.h;
-            this._private_scaleInternal = scale;
-            this._private_rotatedInternal = rotated;
-            this._private_uvTransformDirtyInternal = true;
-        }
-        const spriteSource = config.spriteSourceSize;
-        const trimLeft = spriteSource.x;
-        const trimTop = spriteSource.y;
-        const trimRight = this._private_sourceWidth - spriteSource.x - spriteSource.w;
-        const trimBottom = this._private_sourceHeight - spriteSource.y - spriteSource.h;
-        if (this._private_trimLeft !== trimLeft ||
-            this._private_trimRight !== trimRight ||
-            this._private_trimTop !== trimTop ||
-            this._private_trimBottom !== trimBottom) {
-            this._private_trimLeft = trimLeft;
-            this._private_trimRight = trimRight;
-            this._private_trimTop = trimTop;
-            this._private_trimBottom = trimBottom;
-            this._private_trimDirtyInternal = true;
-        }
-    }
-}
-
-export { FXTextureView };

package/dist/renderingModules/FXRenderingAnimatedTexture.d.ts

@@ -1,5 +0,0 @@
-import { type Texture } from "three";
-import { FXRenderingModule } from "./FXRenderingModule";
-export declare class FXRenderingAnimatedTexture extends FXRenderingModule {
-    constructor(texture: Texture, horizontalCount: number, verticalCount: number);
-}

package/dist/renderingModules/FXRenderingAnimatedTexture.js

@@ -1,14 +0,0 @@
-import { Vector2 } from 'three';
-import source from '../shaders/FXRenderingAnimatedTexture.glsl.js';
-import { FXRenderingModule } from './FXRenderingModule.js';
-
-class FXRenderingAnimatedTexture extends FXRenderingModule {
-    constructor(texture, horizontalCount, verticalCount) {
-        super();
-        /** @internal */
-        this.source = source;
-        this.requiredUniforms = { texture, count: new Vector2(horizontalCount, verticalCount) };
-    }
-}
-
-export { FXRenderingAnimatedTexture };

package/dist/renderingModules/FXRenderingColorOverLife.d.ts

@@ -1,14 +0,0 @@
-import type { FXColor } from "../color/FXColor";
-import { FXRenderingModule } from "./FXRenderingModule";
-/**
- * Colors particles based on lifetime progression.
- *
- * Interpolates through color gradient as particles age from birth to death.
- */
-export declare class FXRenderingColorOverLife extends FXRenderingModule {
-    /**
-     * @param colors - Color gradient stops from birth to death
-     */
-    constructor(colors: FXColor[]);
-    destroy(): void;
-}

package/dist/renderingModules/FXRenderingColorOverLife.js

@@ -1,32 +0,0 @@
-import { buildGradientTexture } from '../miscellaneous/miscellaneous.js';
-import source from '../shaders/FXRenderingColorOverLife.glsl.js';
-import { FXRenderingModule } from './FXRenderingModule.js';
-
-/**
- * Colors particles based on lifetime progression.
- *
- * Interpolates through color gradient as particles age from birth to death.
- */
-class FXRenderingColorOverLife extends FXRenderingModule {
-    /**
-     * @param colors - Color gradient stops from birth to death
-     */
-    constructor(colors) {
-        super();
-        /** @internal */
-        this.requiredProperties = {
-            builtin: "Matrix4",
-        };
-        /** @internal */
-        this.source = source;
-        if (colors.length === 0) {
-            throw new Error("FXRenderingColorOverLife: colors array cannot be empty");
-        }
-        this.requiredUniforms = { colorOverLifeTexture: buildGradientTexture(colors) };
-    }
-    destroy() {
-        this.requiredUniforms.colorOverLifeTexture.dispose();
-    }
-}
-
-export { FXRenderingColorOverLife };

package/dist/renderingModules/FXRenderingColorOverVelocity.d.ts

@@ -1,15 +0,0 @@
-import type { FXColor } from "../color/FXColor";
-import { FXRenderingModule } from "./FXRenderingModule";
-/**
- * Colors particles based on velocity magnitude.
- *
- * Maps velocity from 0 to maxVelocity across the color gradient.
- */
-export declare class FXRenderingColorOverVelocity extends FXRenderingModule {
-    /**
-     * @param colors - Color gradient from slow to fast
-     * @param maxVelocity - Velocity mapped to final color
-     */
-    constructor(colors: FXColor[], maxVelocity: number);
-    destroy(): void;
-}

package/dist/renderingModules/FXRenderingColorOverVelocity.js

@@ -1,37 +0,0 @@
-import { buildGradientTexture } from '../miscellaneous/miscellaneous.js';
-import source from '../shaders/FXRenderingColorOverVelocity.glsl.js';
-import { FXRenderingModule } from './FXRenderingModule.js';
-
-/**
- * Colors particles based on velocity magnitude.
- *
- * Maps velocity from 0 to maxVelocity across the color gradient.
- */
-class FXRenderingColorOverVelocity extends FXRenderingModule {
-    /**
-     * @param colors - Color gradient from slow to fast
-     * @param maxVelocity - Velocity mapped to final color
-     */
-    constructor(colors, maxVelocity) {
-        super();
-        /** @internal */
-        this.requiredProperties = {
-            builtin: "Matrix4",
-        };
-        /** @internal */
-        this.source = source;
-        if (colors.length === 0) {
-            throw new Error("FXRenderingColorOverVelocity: colors array cannot be empty");
-        }
-        if (maxVelocity <= 0) {
-            throw new Error("FXRenderingColorOverVelocity: maxVelocity must be greater than 0");
-        }
-        this.source = source.replace("COLOR_OVER_VELOCITY_MAX", `COLOR_OVER_VELOCITY_MAX ${maxVelocity.toFixed(2)}`);
-        this.requiredUniforms = { colorOverVelocityTexture: buildGradientTexture(colors) };
-    }
-    destroy() {
-        this.requiredUniforms.colorOverVelocityTexture.dispose();
-    }
-}
-
-export { FXRenderingColorOverVelocity };

package/dist/renderingModules/FXRenderingModule.d.ts

@@ -1,8 +0,0 @@
-/**
- * Base class for particle rendering modules.
- *
- * Rendering modules provide fragment shader code and uniforms for particle appearance.
- */
-export declare abstract class FXRenderingModule {
-    destroy?(): void;
-}

package/dist/renderingModules/FXRenderingModule.js

@@ -1,9 +0,0 @@
-/**
- * Base class for particle rendering modules.
- *
- * Rendering modules provide fragment shader code and uniforms for particle appearance.
- */
-class FXRenderingModule {
-}
-
-export { FXRenderingModule };

package/dist/renderingModules/FXRenderingShadow.d.ts

@@ -1,12 +0,0 @@
-import { FXRenderingModule } from "./FXRenderingModule";
-/**
- * Applies directional light shadow attenuation to particles.
- *
- * Samples the first directional light's shadow map per billboard fragment,
- * multiplying the particle color by the shadow factor.
- *
- * Requires a DirectionalLight with `castShadow = true` in the scene,
- * and `receiveShadow = true` on the emitter (or its parent).
- */
-export declare class FXRenderingShadow extends FXRenderingModule {
-}

package/dist/renderingModules/FXRenderingTexture.d.ts

@@ -1,14 +0,0 @@
-import type { FXTextureConfig } from "../miscellaneous/texture/FXTextureView.Internal";
-import { FXRenderingModule } from "./FXRenderingModule";
-/**
- * Renders particles with a texture.
- *
- * Samples the texture using particle UV coordinates.
- */
-export declare class FXRenderingTexture extends FXRenderingModule {
-    private readonly texture;
-    /**
-     * @param config - Texture configuration
-     */
-    constructor(config: FXTextureConfig);
-}

package/dist/renderingModules/FXRenderingTexture.js

@@ -1,26 +0,0 @@
-import { FXTextureView } from '../miscellaneous/texture/FXTextureView.js';
-import source from '../shaders/FXRenderingTexture.glsl.js';
-import { FXRenderingModule } from './FXRenderingModule.js';
-
-/**
- * Renders particles with a texture.
- *
- * Samples the texture using particle UV coordinates.
- */
-class FXRenderingTexture extends FXRenderingModule {
-    /**
-     * @param config - Texture configuration
-     */
-    constructor(config) {
-        super();
-        /** @internal */
-        this.source = source;
-        this._private_texture = new FXTextureView(config);
-        this.requiredUniforms = {
-            texture: this._private_texture.texture,
-            textureTransform: this._private_texture.calculateUVTransform(),
-        };
-    }
-}
-
-export { FXRenderingTexture };

package/dist/shaders/FXRenderingAnimatedTexture.glsl.js

@@ -1,3 +0,0 @@
-var source = "vec4 draw(){\n float totalFrames=p_count.x*p_count.y;\n float frame=floor(PARTICLE_AGE/PARTICLE_LIFETIME*totalFrames);\n frame=clamp(frame,0.0,totalFrames-1.0);\n float col=mod(frame,p_count.x);\n float row=floor(frame/p_count.x);\n vec2 frameSize=vec2(1.0/p_count.x,1.0/p_count.y);\n vec2 uv=(p_uv+vec2(col,(p_count.y-1.0-row)))*frameSize;\n return srgbTexture2D(p_texture,uv);\n}";
-
-export { source as default };

package/dist/shaders/FXRenderingColorOverLife.glsl.js

@@ -1,3 +0,0 @@
-var source = "vec4 draw(){\n float t=clamp(PARTICLE_AGE/PARTICLE_LIFETIME,0.0,1.0);\n return srgbTexture2D(p_colorOverLifeTexture,vec2(t,0.5));\n}";
-
-export { source as default };

package/dist/shaders/FXRenderingColorOverVelocity.glsl.js

@@ -1,3 +0,0 @@
-var source = "#define COLOR_OVER_VELOCITY_MAX \nvec4 draw(){\n float t=clamp(length(vec3(PARTICLE_VELOCITY_X,PARTICLE_VELOCITY_Y,PARTICLE_VELOCITY_Z))/COLOR_OVER_VELOCITY_MAX,0.0,1.0);\n return srgbTexture2D(p_colorOverVelocityTexture,vec2(t,0.5));\n}";
-
-export { source as default };

package/dist/shaders/FXRenderingTexture.glsl.js

@@ -1,3 +0,0 @@
-var source = "vec4 draw(){\n vec2 transformedUV=(p_textureTransform*vec3(p_uv,1.0)).xy;\n return srgbTexture2D(p_texture,transformedUV);\n}";
-
-export { source as default };