@wolffo/three-fire 1.0.1 → 1.0.2

package/README.md

@@ -1,7 +1,8 @@
 # Three fire
 
-[![CI](https://github.com/username/threeFire/workflows/CI/badge.svg)](https://github.com/username/threeFire/actions)
-[![npm version](https://badge.fury.io/js/@wolffo%2Fthree-fire.svg)](https://badge.fury.io/js/@wolffo%2Fthree-fire)
+[![CI](https://github.com/typeWolffo/THREE.Fire/workflows/CI/badge.svg)](https://github.com/typeWolffo/THREE.Fire/actions)
+[![npm version](https://img.shields.io/npm/v/@wolffo/three-fire.svg)](https://www.npmjs.com/package/@wolffo/three-fire)
+[![npm downloads](https://img.shields.io/npm/dm/@wolffo/three-fire.svg)](https://www.npmjs.com/package/@wolffo/three-fire)
 
 Modern TypeScript volumetric fire effect for Three.js and React Three Fiber.
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wolffo/three-fire",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "type": "module",
     "description": "Modern TypeScript volumetric fire effect for Three.js and React Three Fiber",
     "main": "dist/index.js",
@@ -67,5 +67,8 @@
         "src",
         "README.md",
         "LICENSE"
-    ]
+    ],
+    "publishConfig": {
+        "access": "public"
+    }
 }

package/dist/Fire.d.ts

@@ -1,31 +0,0 @@
-import { Mesh, ShaderMaterial, Texture, Color } from 'three';
-import { FireShaderUniforms } from './FireShader';
-export interface FireProps {
-    fireTex: Texture;
-    color?: Color | string | number;
-    iterations?: number;
-    octaves?: number;
-    noiseScale?: [number, number, number, number];
-    magnitude?: number;
-    lacunarity?: number;
-    gain?: number;
-}
-export declare class Fire extends Mesh {
-    material: ShaderMaterial & {
-        uniforms: FireShaderUniforms;
-    };
-    private _time;
-    constructor({ fireTex, color, iterations, octaves, noiseScale, magnitude, lacunarity, gain, }: FireProps);
-    update(time?: number): void;
-    get time(): number;
-    set time(value: number);
-    get fireColor(): Color;
-    set fireColor(color: Color | string | number);
-    get magnitude(): number;
-    set magnitude(value: number);
-    get lacunarity(): number;
-    set lacunarity(value: number);
-    get gain(): number;
-    set gain(value: number);
-}
-//# sourceMappingURL=Fire.d.ts.map

package/dist/Fire.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Fire.d.ts","sourceRoot":"","sources":["../src/Fire.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EAEJ,cAAc,EACd,OAAO,EACP,KAAK,EAMN,MAAM,OAAO,CAAA;AACd,OAAO,EAAc,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAE7D,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAA;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,qBAAa,IAAK,SAAQ,IAAI;IACb,QAAQ,EAAE,cAAc,GAAG;QAAE,QAAQ,EAAE,kBAAkB,CAAA;KAAE,CAAA;IAC1E,OAAO,CAAC,KAAK,CAAI;gBAEL,EACV,OAAO,EACP,KAAgB,EAChB,UAAe,EACf,OAAW,EACX,UAA2B,EAC3B,SAAe,EACf,UAAgB,EAChB,IAAU,GACX,EAAE,SAAS;IAkCL,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAWlC,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,IAAI,CAAC,KAAK,EAAE,MAAM,EAG5B;IAED,IAAW,SAAS,IAAI,KAAK,CAE5B;IAED,IAAW,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,EAElD;IAED,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED,IAAW,SAAS,CAAC,KAAK,EAAE,MAAM,EAEjC;IAED,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED,IAAW,UAAU,CAAC,KAAK,EAAE,MAAM,EAElC;IAED,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,IAAI,CAAC,KAAK,EAAE,MAAM,EAE5B;CACF"}

package/dist/FireComponent.d.ts

@@ -1,30 +0,0 @@
-import React from 'react';
-import { ReactThreeFiber } from '@react-three/fiber';
-import { Fire as FireMesh, FireProps as FireMeshProps } from './Fire';
-declare module '@react-three/fiber' {
-    interface ThreeElements {
-        fire: ReactThreeFiber.Object3DNode<FireMesh, typeof FireMesh>;
-    }
-}
-export interface FireProps extends Omit<FireMeshProps, 'fireTex'> {
-    /** Fire texture URL or texture object */
-    texture: string | THREE.Texture;
-    /** Auto-update time from useFrame (default: true) */
-    autoUpdate?: boolean;
-    /** Custom update function */
-    onUpdate?: (fire: FireMesh, time: number) => void;
-    children?: React.ReactNode;
-}
-export interface FireRef {
-    /** Fire mesh instance */
-    fire: FireMesh | null;
-    /** Update fire manually */
-    update: (time?: number) => void;
-}
-export declare const FireComponent: React.ForwardRefExoticComponent<FireProps & React.RefAttributes<FireRef>>;
-export declare const useFire: () => {
-    ref: React.RefObject<FireRef>;
-    fire: FireMesh | null;
-    update: (time?: number) => void | undefined;
-};
-//# sourceMappingURL=FireComponent.d.ts.map

package/dist/FireComponent.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FireComponent.d.ts","sourceRoot":"","sources":["../src/FireComponent.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA2D,MAAM,OAAO,CAAA;AAC/E,OAAO,EAAoB,eAAe,EAAa,MAAM,oBAAoB,CAAA;AACjF,OAAO,EAAE,IAAI,IAAI,QAAQ,EAAE,SAAS,IAAI,aAAa,EAAE,MAAM,QAAQ,CAAA;AASrE,OAAO,QAAQ,oBAAoB,CAAC;IAClC,UAAU,aAAa;QACrB,IAAI,EAAE,eAAe,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,QAAQ,CAAC,CAAA;KAC9D;CACF;AAED,MAAM,WAAW,SAAU,SAAQ,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC;IAC/D,yCAAyC;IACzC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,OAAO,CAAA;IAC/B,qDAAqD;IACrD,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;IACjD,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B;AAED,MAAM,WAAW,OAAO;IACtB,yBAAyB;IACzB,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAA;IACrB,2BAA2B;IAC3B,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;CAChC;AAED,eAAO,MAAM,aAAa,2EAsEzB,CAAA;AAKD,eAAO,MAAM,OAAO;;;oBAKA,MAAM;CAEzB,CAAA"}

package/dist/FireShader.d.ts

@@ -1,43 +0,0 @@
-import { Vector3, Vector4, Color, Matrix4, Texture } from 'three';
-export interface FireShaderUniforms {
-    fireTex: {
-        value: Texture | null;
-    };
-    color: {
-        value: Color;
-    };
-    time: {
-        value: number;
-    };
-    seed: {
-        value: number;
-    };
-    invModelMatrix: {
-        value: Matrix4;
-    };
-    scale: {
-        value: Vector3;
-    };
-    noiseScale: {
-        value: Vector4;
-    };
-    magnitude: {
-        value: number;
-    };
-    lacunarity: {
-        value: number;
-    };
-    gain: {
-        value: number;
-    };
-}
-export declare const FireShader: {
-    readonly defines: {
-        readonly ITERATIONS: "20";
-        readonly OCTAVES: "3";
-    };
-    readonly uniforms: FireShaderUniforms;
-    readonly vertexShader: "\n    varying vec3 vWorldPos;\n\n    void main() {\n      gl_Position = projectionMatrix * modelViewMatrix * vec4(position, 1.0);\n      vWorldPos = (modelMatrix * vec4(position, 1.0)).xyz;\n    }\n  ";
-    readonly fragmentShader: "\n    uniform vec3 color;\n    uniform float time;\n    uniform float seed;\n    uniform mat4 invModelMatrix;\n    uniform vec3 scale;\n    uniform vec4 noiseScale;\n    uniform float magnitude;\n    uniform float lacunarity;\n    uniform float gain;\n    uniform sampler2D fireTex;\n\n    varying vec3 vWorldPos;\n\n    // GLSL simplex noise function by ashima\n    vec3 mod289(vec3 x) {\n      return x - floor(x * (1.0 / 289.0)) * 289.0;\n    }\n\n    vec4 mod289(vec4 x) {\n      return x - floor(x * (1.0 / 289.0)) * 289.0;\n    }\n\n    vec4 permute(vec4 x) {\n      return mod289(((x * 34.0) + 1.0) * x);\n    }\n\n    vec4 taylorInvSqrt(vec4 r) {\n      return 1.79284291400159 - 0.85373472095314 * r;\n    }\n\n    float snoise(vec3 v) {\n      const vec2 C = vec2(1.0 / 6.0, 1.0 / 3.0);\n      const vec4 D = vec4(0.0, 0.5, 1.0, 2.0);\n\n      vec3 i = floor(v + dot(v, C.yyy));\n      vec3 x0 = v - i + dot(i, C.xxx);\n\n      vec3 g = step(x0.yzx, x0.xyz);\n      vec3 l = 1.0 - g;\n      vec3 i1 = min(g.xyz, l.zxy);\n      vec3 i2 = max(g.xyz, l.zxy);\n\n      vec3 x1 = x0 - i1 + C.xxx;\n      vec3 x2 = x0 - i2 + C.yyy;\n      vec3 x3 = x0 - D.yyy;\n\n      i = mod289(i);\n      vec4 p = permute(permute(permute(\n        i.z + vec4(0.0, i1.z, i2.z, 1.0))\n        + i.y + vec4(0.0, i1.y, i2.y, 1.0))\n        + i.x + vec4(0.0, i1.x, i2.x, 1.0));\n\n      float n_ = 0.142857142857;\n      vec3 ns = n_ * D.wyz - D.xzx;\n\n      vec4 j = p - 49.0 * floor(p * ns.z * ns.z);\n\n      vec4 x_ = floor(j * ns.z);\n      vec4 y_ = floor(j - 7.0 * x_);\n\n      vec4 x = x_ * ns.x + ns.yyyy;\n      vec4 y = y_ * ns.x + ns.yyyy;\n      vec4 h = 1.0 - abs(x) - abs(y);\n\n      vec4 b0 = vec4(x.xy, y.xy);\n      vec4 b1 = vec4(x.zw, y.zw);\n\n      vec4 s0 = floor(b0) * 2.0 + 1.0;\n      vec4 s1 = floor(b1) * 2.0 + 1.0;\n      vec4 sh = -step(h, vec4(0.0));\n\n      vec4 a0 = b0.xzyw + s0.xzyw * sh.xxyy;\n      vec4 a1 = b1.xzyw + s1.xzyw * sh.zzww;\n\n      vec3 p0 = vec3(a0.xy, h.x);\n      vec3 p1 = vec3(a0.zw, h.y);\n      vec3 p2 = vec3(a1.xy, h.z);\n      vec3 p3 = vec3(a1.zw, h.w);\n\n      vec4 norm = taylorInvSqrt(vec4(dot(p0, p0), dot(p1, p1), dot(p2, p2), dot(p3, p3)));\n      p0 *= norm.x;\n      p1 *= norm.y;\n      p2 *= norm.z;\n      p3 *= norm.w;\n\n      vec4 m = max(0.6 - vec4(dot(x0, x0), dot(x1, x1), dot(x2, x2), dot(x3, x3)), 0.0);\n      m = m * m;\n      return 42.0 * dot(m * m, vec4(dot(p0, x0), dot(p1, x1), dot(p2, x2), dot(p3, x3)));\n    }\n\n    float turbulence(vec3 p) {\n      float sum = 0.0;\n      float freq = 1.0;\n      float amp = 1.0;\n\n      for(int i = 0; i < OCTAVES; i++) {\n        sum += abs(snoise(p * freq)) * amp;\n        freq *= lacunarity;\n        amp *= gain;\n      }\n\n      return sum;\n    }\n\n    vec4 samplerFire(vec3 p, vec4 scale) {\n      vec2 st = vec2(sqrt(dot(p.xz, p.xz)), p.y);\n\n      if(st.x <= 0.0 || st.x >= 1.0 || st.y <= 0.0 || st.y >= 1.0) {\n        return vec4(0.0);\n      }\n\n      p.y -= (seed + time) * scale.w;\n      p *= scale.xyz;\n\n      st.y += sqrt(st.y) * magnitude * turbulence(p);\n\n      if(st.y <= 0.0 || st.y >= 1.0) {\n        return vec4(0.0);\n      }\n\n      return texture2D(fireTex, st);\n    }\n\n    vec3 localize(vec3 p) {\n      return (invModelMatrix * vec4(p, 1.0)).xyz;\n    }\n\n    void main() {\n      vec3 rayPos = vWorldPos;\n      vec3 rayDir = normalize(rayPos - cameraPosition);\n      float rayLen = 0.0288 * length(scale.xyz);\n\n      vec4 col = vec4(0.0);\n\n      for(int i = 0; i < ITERATIONS; i++) {\n        rayPos += rayDir * rayLen;\n        vec3 lp = localize(rayPos);\n        lp.y += 0.5;\n        lp.xz *= 2.0;\n        col += samplerFire(lp, noiseScale);\n      }\n\n      col.a = col.r;\n      gl_FragColor = col;\n    }\n  ";
-};
-//# sourceMappingURL=FireShader.d.ts.map

package/dist/FireShader.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FireShader.d.ts","sourceRoot":"","sources":["../src/FireShader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAA;AAEjE,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE;QAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;KAAE,CAAA;IAClC,KAAK,EAAE;QAAE,KAAK,EAAE,KAAK,CAAA;KAAE,CAAA;IACvB,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IACvB,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IACvB,cAAc,EAAE;QAAE,KAAK,EAAE,OAAO,CAAA;KAAE,CAAA;IAClC,KAAK,EAAE;QAAE,KAAK,EAAE,OAAO,CAAA;KAAE,CAAA;IACzB,UAAU,EAAE;QAAE,KAAK,EAAE,OAAO,CAAA;KAAE,CAAA;IAC9B,SAAS,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAC5B,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7B,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CACxB;AAED,eAAO,MAAM,UAAU;;;;;uBAiBhB,kBAAkB;;;CA8Jf,CAAA"}

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,IAAI,QAAQ,EAAE,KAAK,SAAS,IAAI,aAAa,EAAE,MAAM,QAAQ,CAAA;AAC1E,OAAO,EAAE,UAAU,EAAE,KAAK,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAGlE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAGtF,OAAO,EAAE,aAAa,IAAI,IAAI,EAAE,MAAM,iBAAiB,CAAA"}