tres-vfx 0.1.0 → 0.3.0

package/dist/index.d.ts

@@ -1,2 +1,670 @@
+import * as vue from 'vue';
+import { PropType, Ref } from 'vue';
+import * as THREE from 'three/webgpu';
+import * as core_vfx from 'core-vfx';
+import { VFXParticleSystemOptions, FrictionConfig, FlipbookConfig, Rotation3DInput, StretchConfig, TurbulenceConfig, AttractorConfig, CollisionConfig, EmitterControllerOptions, CoreState } from 'core-vfx';
+export { Appearance, AttractorConfig, AttractorType, BaseParticleProps, Blending, CollisionConfig, CurveChannel, CurveData, CurvePoint, CurveTextureResolved, CurveTextureResult, Easing, EmitterController, EmitterControllerOptions, EmitterShape, FlipbookConfig, FrictionConfig, Lighting, NormalizedParticleProps, ParticleData, Rotation3DInput, StretchConfig, TurbulenceConfig, VFXParticleSystem, VFXParticleSystemOptions, bakeCurveToArray, buildCurveTextureBin, createCombinedCurveTexture, isNonDefaultRotation, isWebGPUBackend, normalizeProps, resolveCurveTexture } from 'core-vfx';
 
-export {  }
+declare const VFXParticles: vue.DefineComponent<vue.ExtractPropTypes<{
+    name: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    debug: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    maxParticles: {
+        type: NumberConstructor;
+        default: number;
+    };
+    size: {
+        type: PropType<[number, number] | number>;
+        default: () => number[];
+    };
+    colorStart: {
+        type: PropType<string[]>;
+        default: () => string[];
+    };
+    colorEnd: {
+        type: PropType<string[] | null>;
+        default: null;
+    };
+    fadeSize: {
+        type: PropType<[number, number]>;
+        default: () => number[];
+    };
+    fadeSizeCurve: {
+        type: PropType<unknown[] | null>;
+        default: null;
+    };
+    fadeOpacity: {
+        type: PropType<[number, number]>;
+        default: () => number[];
+    };
+    fadeOpacityCurve: {
+        type: PropType<unknown[] | null>;
+        default: null;
+    };
+    velocityCurve: {
+        type: PropType<unknown[] | null>;
+        default: null;
+    };
+    gravity: {
+        type: PropType<[number, number, number]>;
+        default: () => number[];
+    };
+    lifetime: {
+        type: PropType<[number, number]>;
+        default: () => number[];
+    };
+    direction: {
+        type: PropType<VFXParticleSystemOptions["direction"]>;
+        default: () => number[][];
+    };
+    startPosition: {
+        type: PropType<VFXParticleSystemOptions["startPosition"]>;
+        default: () => number[][];
+    };
+    speed: {
+        type: PropType<[number, number] | number>;
+        default: () => number[];
+    };
+    friction: {
+        type: PropType<FrictionConfig>;
+        default: () => {
+            intensity: number;
+            easing: string;
+        };
+    };
+    appearance: {
+        type: PropType<string | number>;
+        default: "gradient";
+    };
+    alphaMap: {
+        type: PropType<THREE.Texture | null>;
+        default: null;
+    };
+    flipbook: {
+        type: PropType<FlipbookConfig | null>;
+        default: null;
+    };
+    rotation: {
+        type: PropType<Rotation3DInput>;
+        default: () => number[];
+    };
+    rotationSpeed: {
+        type: PropType<Rotation3DInput>;
+        default: () => number[];
+    };
+    rotationSpeedCurve: {
+        type: PropType<unknown[] | null>;
+        default: null;
+    };
+    geometry: {
+        type: PropType<THREE.BufferGeometry | null>;
+        default: null;
+    };
+    orientToDirection: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    orientAxis: {
+        type: StringConstructor;
+        default: string;
+    };
+    stretchBySpeed: {
+        type: PropType<StretchConfig | null>;
+        default: null;
+    };
+    lighting: {
+        type: PropType<string | number>;
+        default: "standard";
+    };
+    shadow: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    blending: {
+        type: PropType<string | number>;
+        default: 1;
+    };
+    intensity: {
+        type: NumberConstructor;
+        default: number;
+    };
+    position: {
+        type: PropType<[number, number, number]>;
+        default: () => number[];
+    };
+    autoStart: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    delay: {
+        type: NumberConstructor;
+        default: number;
+    };
+    backdropNode: {
+        type: PropType<unknown>;
+        default: null;
+    };
+    opacityNode: {
+        type: PropType<unknown>;
+        default: null;
+    };
+    colorNode: {
+        type: PropType<unknown>;
+        default: null;
+    };
+    alphaTestNode: {
+        type: PropType<unknown>;
+        default: null;
+    };
+    castShadowNode: {
+        type: PropType<unknown>;
+        default: null;
+    };
+    emitCount: {
+        type: NumberConstructor;
+        default: number;
+    };
+    emitterShape: {
+        type: PropType<string | number>;
+        default: 1;
+    };
+    emitterRadius: {
+        type: PropType<[number, number]>;
+        default: () => number[];
+    };
+    emitterAngle: {
+        type: NumberConstructor;
+        default: number;
+    };
+    emitterHeight: {
+        type: PropType<[number, number]>;
+        default: () => number[];
+    };
+    emitterSurfaceOnly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    emitterDirection: {
+        type: PropType<[number, number, number]>;
+        default: () => number[];
+    };
+    turbulence: {
+        type: PropType<TurbulenceConfig | null>;
+        default: null;
+    };
+    attractors: {
+        type: PropType<AttractorConfig[] | null>;
+        default: null;
+    };
+    attractToCenter: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    startPositionAsDirection: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    softParticles: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    softDistance: {
+        type: NumberConstructor;
+        default: number;
+    };
+    collision: {
+        type: PropType<CollisionConfig | null>;
+        default: null;
+    };
+    curveTexturePath: {
+        type: PropType<string | null>;
+        default: null;
+    };
+    depthTest: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    renderOrder: {
+        type: NumberConstructor;
+        default: number;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    name: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    debug: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    maxParticles: {
+        type: NumberConstructor;
+        default: number;
+    };
+    size: {
+        type: PropType<[number, number] | number>;
+        default: () => number[];
+    };
+    colorStart: {
+        type: PropType<string[]>;
+        default: () => string[];
+    };
+    colorEnd: {
+        type: PropType<string[] | null>;
+        default: null;
+    };
+    fadeSize: {
+        type: PropType<[number, number]>;
+        default: () => number[];
+    };
+    fadeSizeCurve: {
+        type: PropType<unknown[] | null>;
+        default: null;
+    };
+    fadeOpacity: {
+        type: PropType<[number, number]>;
+        default: () => number[];
+    };
+    fadeOpacityCurve: {
+        type: PropType<unknown[] | null>;
+        default: null;
+    };
+    velocityCurve: {
+        type: PropType<unknown[] | null>;
+        default: null;
+    };
+    gravity: {
+        type: PropType<[number, number, number]>;
+        default: () => number[];
+    };
+    lifetime: {
+        type: PropType<[number, number]>;
+        default: () => number[];
+    };
+    direction: {
+        type: PropType<VFXParticleSystemOptions["direction"]>;
+        default: () => number[][];
+    };
+    startPosition: {
+        type: PropType<VFXParticleSystemOptions["startPosition"]>;
+        default: () => number[][];
+    };
+    speed: {
+        type: PropType<[number, number] | number>;
+        default: () => number[];
+    };
+    friction: {
+        type: PropType<FrictionConfig>;
+        default: () => {
+            intensity: number;
+            easing: string;
+        };
+    };
+    appearance: {
+        type: PropType<string | number>;
+        default: "gradient";
+    };
+    alphaMap: {
+        type: PropType<THREE.Texture | null>;
+        default: null;
+    };
+    flipbook: {
+        type: PropType<FlipbookConfig | null>;
+        default: null;
+    };
+    rotation: {
+        type: PropType<Rotation3DInput>;
+        default: () => number[];
+    };
+    rotationSpeed: {
+        type: PropType<Rotation3DInput>;
+        default: () => number[];
+    };
+    rotationSpeedCurve: {
+        type: PropType<unknown[] | null>;
+        default: null;
+    };
+    geometry: {
+        type: PropType<THREE.BufferGeometry | null>;
+        default: null;
+    };
+    orientToDirection: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    orientAxis: {
+        type: StringConstructor;
+        default: string;
+    };
+    stretchBySpeed: {
+        type: PropType<StretchConfig | null>;
+        default: null;
+    };
+    lighting: {
+        type: PropType<string | number>;
+        default: "standard";
+    };
+    shadow: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    blending: {
+        type: PropType<string | number>;
+        default: 1;
+    };
+    intensity: {
+        type: NumberConstructor;
+        default: number;
+    };
+    position: {
+        type: PropType<[number, number, number]>;
+        default: () => number[];
+    };
+    autoStart: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    delay: {
+        type: NumberConstructor;
+        default: number;
+    };
+    backdropNode: {
+        type: PropType<unknown>;
+        default: null;
+    };
+    opacityNode: {
+        type: PropType<unknown>;
+        default: null;
+    };
+    colorNode: {
+        type: PropType<unknown>;
+        default: null;
+    };
+    alphaTestNode: {
+        type: PropType<unknown>;
+        default: null;
+    };
+    castShadowNode: {
+        type: PropType<unknown>;
+        default: null;
+    };
+    emitCount: {
+        type: NumberConstructor;
+        default: number;
+    };
+    emitterShape: {
+        type: PropType<string | number>;
+        default: 1;
+    };
+    emitterRadius: {
+        type: PropType<[number, number]>;
+        default: () => number[];
+    };
+    emitterAngle: {
+        type: NumberConstructor;
+        default: number;
+    };
+    emitterHeight: {
+        type: PropType<[number, number]>;
+        default: () => number[];
+    };
+    emitterSurfaceOnly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    emitterDirection: {
+        type: PropType<[number, number, number]>;
+        default: () => number[];
+    };
+    turbulence: {
+        type: PropType<TurbulenceConfig | null>;
+        default: null;
+    };
+    attractors: {
+        type: PropType<AttractorConfig[] | null>;
+        default: null;
+    };
+    attractToCenter: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    startPositionAsDirection: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    softParticles: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    softDistance: {
+        type: NumberConstructor;
+        default: number;
+    };
+    collision: {
+        type: PropType<CollisionConfig | null>;
+        default: null;
+    };
+    curveTexturePath: {
+        type: PropType<string | null>;
+        default: null;
+    };
+    depthTest: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    renderOrder: {
+        type: NumberConstructor;
+        default: number;
+    };
+}>> & Readonly<{}>, {
+    direction: Rotation3DInput;
+    startPosition: Rotation3DInput;
+    name: string;
+    debug: boolean;
+    maxParticles: number;
+    size: number | [number, number];
+    colorStart: string[];
+    colorEnd: string[] | null;
+    fadeSize: [number, number];
+    fadeSizeCurve: unknown[] | null;
+    fadeOpacity: [number, number];
+    fadeOpacityCurve: unknown[] | null;
+    velocityCurve: unknown[] | null;
+    gravity: [number, number, number];
+    lifetime: [number, number];
+    speed: number | [number, number];
+    friction: FrictionConfig;
+    appearance: string | number;
+    alphaMap: THREE.Texture<unknown> | null;
+    flipbook: FlipbookConfig;
+    rotation: Rotation3DInput;
+    rotationSpeed: Rotation3DInput;
+    rotationSpeedCurve: unknown[] | null;
+    geometry: THREE.BufferGeometry<THREE.NormalBufferAttributes, THREE.BufferGeometryEventMap> | null;
+    orientToDirection: boolean;
+    orientAxis: string;
+    stretchBySpeed: StretchConfig;
+    lighting: string | number;
+    shadow: boolean;
+    blending: string | number;
+    intensity: number;
+    position: [number, number, number];
+    autoStart: boolean;
+    delay: number;
+    backdropNode: null;
+    opacityNode: null;
+    colorNode: null;
+    alphaTestNode: null;
+    castShadowNode: null;
+    emitCount: number;
+    emitterShape: string | number;
+    emitterRadius: [number, number];
+    emitterAngle: number;
+    emitterHeight: [number, number];
+    emitterSurfaceOnly: boolean;
+    emitterDirection: [number, number, number];
+    turbulence: TurbulenceConfig;
+    attractors: AttractorConfig[] | null;
+    attractToCenter: boolean;
+    startPositionAsDirection: boolean;
+    softParticles: boolean;
+    softDistance: number;
+    collision: CollisionConfig;
+    curveTexturePath: string | null;
+    depthTest: boolean;
+    renderOrder: number;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+type VFXParticlesProps = InstanceType<typeof VFXParticles>['$props'];
+
+declare const VFXEmitter: vue.DefineComponent<vue.ExtractPropTypes<{
+    name: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    particlesRef: {
+        type: ObjectConstructor;
+        default: undefined;
+    };
+    position: {
+        type: PropType<[number, number, number]>;
+        default: () => number[];
+    };
+    emitCount: {
+        type: NumberConstructor;
+        default: number;
+    };
+    delay: {
+        type: NumberConstructor;
+        default: number;
+    };
+    autoStart: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    loop: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    localDirection: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    direction: {
+        type: PropType<EmitterControllerOptions["direction"]>;
+        default: undefined;
+    };
+    overrides: {
+        type: PropType<Record<string, unknown> | null>;
+        default: null;
+    };
+    onEmit: {
+        type: PropType<EmitterControllerOptions["onEmit"]>;
+        default: undefined;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    name: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    particlesRef: {
+        type: ObjectConstructor;
+        default: undefined;
+    };
+    position: {
+        type: PropType<[number, number, number]>;
+        default: () => number[];
+    };
+    emitCount: {
+        type: NumberConstructor;
+        default: number;
+    };
+    delay: {
+        type: NumberConstructor;
+        default: number;
+    };
+    autoStart: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    loop: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    localDirection: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    direction: {
+        type: PropType<EmitterControllerOptions["direction"]>;
+        default: undefined;
+    };
+    overrides: {
+        type: PropType<Record<string, unknown> | null>;
+        default: null;
+    };
+    onEmit: {
+        type: PropType<EmitterControllerOptions["onEmit"]>;
+        default: undefined;
+    };
+}>> & Readonly<{}>, {
+    direction: [[number, number], [number, number], [number, number]] | undefined;
+    name: string;
+    position: [number, number, number];
+    autoStart: boolean;
+    delay: number;
+    emitCount: number;
+    onEmit: ((params: {
+        position: [number, number, number] | number[];
+        count: number;
+        direction: any;
+    }) => void) | undefined;
+    particlesRef: Record<string, any>;
+    loop: boolean;
+    localDirection: boolean;
+    overrides: Record<string, unknown> | null;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+/**
+ * Composable for programmatic emitter control
+ *
+ * Usage:
+ * const { emit, burst, start, stop } = useVFXEmitter("sparks");
+ *
+ * // Emit at a position
+ * emit([1, 2, 3], 50);
+ *
+ * // Burst with overrides
+ * burst([0, 0, 0], 100, { colorStart: ["#ff0000"] });
+ */
+declare function useVFXEmitter(name: string): {
+    emit: (position?: [number, number, number], count?: number, overrides?: Record<string, unknown> | null) => boolean;
+    burst: (position?: [number, number, number], count?: number, overrides?: Record<string, unknown> | null) => boolean;
+    start: () => boolean;
+    stop: () => boolean;
+    clear: () => boolean;
+    isEmitting: () => boolean;
+    getUniforms: () => Record<string, unknown> | null;
+    getParticles: () => core_vfx.ParticleSystemRef | null;
+};
+type VFXEmitterProps = InstanceType<typeof VFXEmitter>['$props'];
+
+declare function useVFXStore(): Ref<CoreState>;
+declare function useVFXStore<T>(selector: (state: CoreState) => T): Ref<T>;
+declare namespace useVFXStore {
+    var getState: () => CoreState;
+    var setState: {
+        (partial: CoreState | Partial<CoreState> | ((state: CoreState) => CoreState | Partial<CoreState>), replace?: false): void;
+        (state: CoreState | ((state: CoreState) => CoreState), replace: true): void;
+    };
+    var subscribe: (listener: (state: CoreState, prevState: CoreState) => void) => () => void;
+}
+
+export { VFXEmitter, type VFXEmitterProps, VFXParticles, type VFXParticlesProps, useVFXEmitter, useVFXStore };