@soonspacejs/plugin-effect 2.13.10 → 2.13.11

package/dist/index.d.ts

@@ -1,196 +1,196 @@
-import { Blending } from 'three';
-import SoonSpace, { IVector3, IColor } from 'soonspacejs';
-import type { PluginObject, PluginObjectInfo } from 'soonspacejs';
-import { ParticleCluster, ParticleClusterOptions } from '@three3d/particle';
-export * from '@three3d/particle';
-import { InnerCircleWaveOptions } from './circle-wave';
-import { InnerCylinderWaveOptions } from './cylinder-wave';
-import { WaterOptions } from './water';
-export interface FlameOptions extends PluginObjectInfo {
-    magnitude?: number;
-    gain?: number;
-    imgUrl?: string;
-}
-export interface SmokeOptions extends PluginObjectInfo {
-    imgUrl?: string;
-    count?: number;
-    maxAge?: number;
-    size?: number;
-    acceleration?: number;
-    velocity?: IVector3;
-    color?: IColor[];
-}
-export interface Smoke2Options extends PluginObjectInfo {
-    imgUrl?: string;
-    radius?: number;
-    maxLife?: number;
-    maxSize?: number;
-    rate?: number;
-    colors?: IColor[];
-    blending?: Blending;
-}
-export interface SparklesOptions extends PluginObjectInfo {
-    count?: number;
-    speed?: number | Float32Array;
-    opacity?: number | Float32Array;
-    color?: IColor | Float32Array;
-    size?: number | Float32Array;
-    scalar?: number | [number, number, number] | IVector3;
-    noise?: number | [number, number, number] | IVector3 | Float32Array;
-}
-export interface CreateWaterOptions extends PluginObjectInfo, Omit<WaterOptions, 'userData'> {
-    /**
-     * 是否开启水的动画
-     * @remarks
-     * 如果开启，则会一直触发场景渲染
-     * 如果关闭，则不会主动触发场景渲染，但在渲染渲染时仍会有动画效果，只是不会主动触发场景渲染
-     */
-    animation?: boolean;
-}
-export interface ContactShadowsOptions extends Omit<PluginObjectInfo, 'scale'> {
-    opacity?: number;
-    width?: number;
-    height?: number;
-    blur?: number;
-    far?: number;
-    resolution?: number;
-    frames?: number;
-    scale?: number | [x: number, y: number];
-    darkness?: number;
-}
-export interface WeatherOptions {
-    /**
-     * 粒子贴图
-     */
-    imgUrl?: string;
-    /**
-     * 颜色
-     */
-    color?: IColor;
-    /**
-     * 大小
-     */
-    size?: number;
-    /**
-     * 不透明度
-     */
-    opacity?: number;
-    /**
-     * 粒子数量
-     */
-    count?: number;
-    /**
-     * 粒子范围
-     */
-    range?: number;
-    /**
-     * 粒子左右速度的随机范围
-     */
-    velocityX?: [number, number];
-    /**
-     * 粒子上下速度的随机范围
-     */
-    velocityY?: [number, number];
-}
-export type CircleWaveOptions = InnerCircleWaveOptions & PluginObjectInfo;
-export type CylinderWaveOptions = InnerCylinderWaveOptions & PluginObjectInfo;
-export interface PointsWaveOptions extends PluginObjectInfo {
-    xAxisCount?: number;
-    zAxisCount?: number;
-    showDistance?: number;
-    separation?: number;
-    size?: number;
-    maxFluctua?: number;
-    color?: IColor;
-    opacity?: number;
-}
-export interface BuildsOptions extends PluginObjectInfo {
-    buildWidth?: number;
-    buildHeigh?: number;
-    buildDepth?: number;
-    count?: number;
-    gapX?: number;
-    gapZ?: number;
-    showDistance?: number;
-    randShift?: number;
-    color?: IColor;
-}
-declare class EffectPlugin {
-    readonly ssp: SoonSpace;
-    [x: string]: any;
-    /**
-     * 天气预设图片
-     */
-    readonly weatherPresetImgs: {
-        rain: string;
-        snow: any;
-    };
-    private _weatherId;
-    constructor(ssp: SoonSpace);
-    /**
-     * 创建火焰
-     * @params params
-     * @returns
-     */
-    createFlame(params: FlameOptions): PluginObject;
-    /**
-     * 创建烟雾
-     * @param params
-     * @returns
-     */
-    createSmoke(params: SmokeOptions): PluginObject;
-    createSmoke2(params: Smoke2Options): PluginObject;
-    /**
-     * 创建星星
-     * @param params
-     * @returns
-     */
-    createSparkles(params: SparklesOptions): PluginObject;
-    /**
-     * 创建接触阴影
-     * @params params
-     */
-    createContactShadows({ scale, frames, opacity, width, height, blur, darkness, far, resolution, ...props }: ContactShadowsOptions): PluginObject;
-    /**
-     * 开启天气
-     * @param param0
-     */
-    openWeather(params?: WeatherOptions): void;
-    /**
-     * 关闭天气
-     */
-    closeWeather(): void;
-    /**
-     * 创建粒子簇
-     * @param options
-     * @returns
-     */
-    createParticleCluster(options: ParticleClusterOptions): ParticleCluster;
-    /**
-     * 创建圆形光波
-     * @param options
-     * @returns
-     */
-    createCircleWave(options: CircleWaveOptions): PluginObject;
-    /**
-     * 创建立柱光波
-     * @param options
-     * @returns
-     */
-    createCylinderWave(options: CylinderWaveOptions): PluginObject;
-    /**
-     * 创建粒子波浪
-     * @param options
-     * @returns
-     */
-    createPointsWave(options: PointsWaveOptions): PluginObject;
-    /**
-     * 创建建筑
-     * @param options
-     * @returns
-     */
-    createBuilds(options: BuildsOptions): PluginObject;
-    createWater(options: CreateWaterOptions): PluginObject;
-    removeEffect(id: PluginObjectInfo['id']): boolean;
-}
-export default EffectPlugin;
+import { Blending } from 'three';
+import SoonSpace, { IVector3, IColor } from 'soonspacejs';
+import type { PluginObject, PluginObjectInfo } from 'soonspacejs';
+import { ParticleClusterOptions } from '@three3d/particle';
+export * from '@three3d/particle';
+import { InnerCircleWaveOptions } from './circle-wave';
+import { InnerCylinderWaveOptions } from './cylinder-wave';
+import { WaterOptions } from './water';
+export interface FlameOptions extends PluginObjectInfo {
+    magnitude?: number;
+    gain?: number;
+    imgUrl?: string;
+}
+export interface SmokeOptions extends PluginObjectInfo {
+    imgUrl?: string;
+    count?: number;
+    maxAge?: number;
+    size?: number;
+    acceleration?: number;
+    velocity?: IVector3;
+    color?: IColor[];
+}
+export interface Smoke2Options extends PluginObjectInfo {
+    imgUrl?: string;
+    radius?: number;
+    maxLife?: number;
+    maxSize?: number;
+    rate?: number;
+    colors?: IColor[];
+    blending?: Blending;
+}
+export interface SparklesOptions extends PluginObjectInfo {
+    count?: number;
+    speed?: number | Float32Array;
+    opacity?: number | Float32Array;
+    color?: IColor | Float32Array;
+    size?: number | Float32Array;
+    scalar?: number | [number, number, number] | IVector3;
+    noise?: number | [number, number, number] | IVector3 | Float32Array;
+}
+export interface CreateWaterOptions extends PluginObjectInfo, Omit<WaterOptions, 'userData'> {
+    /**
+     * 是否开启水的动画
+     * @remarks
+     * 如果开启，则会一直触发场景渲染
+     * 如果关闭，则不会主动触发场景渲染，但在渲染渲染时仍会有动画效果，只是不会主动触发场景渲染
+     */
+    animation?: boolean;
+}
+export interface ContactShadowsOptions extends Omit<PluginObjectInfo, 'scale'> {
+    opacity?: number;
+    width?: number;
+    height?: number;
+    blur?: number;
+    far?: number;
+    resolution?: number;
+    frames?: number;
+    scale?: number | [x: number, y: number];
+    darkness?: number;
+}
+export interface WeatherOptions {
+    /**
+     * 粒子贴图
+     */
+    imgUrl?: string;
+    /**
+     * 颜色
+     */
+    color?: IColor;
+    /**
+     * 大小
+     */
+    size?: number;
+    /**
+     * 不透明度
+     */
+    opacity?: number;
+    /**
+     * 粒子数量
+     */
+    count?: number;
+    /**
+     * 粒子范围
+     */
+    range?: number;
+    /**
+     * 粒子左右速度的随机范围
+     */
+    velocityX?: [number, number];
+    /**
+     * 粒子上下速度的随机范围
+     */
+    velocityY?: [number, number];
+}
+export type CircleWaveOptions = InnerCircleWaveOptions & PluginObjectInfo;
+export type CylinderWaveOptions = InnerCylinderWaveOptions & PluginObjectInfo;
+export interface PointsWaveOptions extends PluginObjectInfo {
+    xAxisCount?: number;
+    zAxisCount?: number;
+    showDistance?: number;
+    separation?: number;
+    size?: number;
+    maxFluctua?: number;
+    color?: IColor;
+    opacity?: number;
+}
+export interface BuildsOptions extends PluginObjectInfo {
+    buildWidth?: number;
+    buildHeigh?: number;
+    buildDepth?: number;
+    count?: number;
+    gapX?: number;
+    gapZ?: number;
+    showDistance?: number;
+    randShift?: number;
+    color?: IColor;
+}
+declare class EffectPlugin {
+    readonly ssp: SoonSpace;
+    [x: string]: any;
+    /**
+     * 天气预设图片
+     */
+    readonly weatherPresetImgs: {
+        rain: string;
+        snow: any;
+    };
+    private _weatherId;
+    constructor(ssp: SoonSpace);
+    /**
+     * 创建火焰
+     * @params params
+     * @returns
+     */
+    createFlame(params: FlameOptions): PluginObject;
+    /**
+     * 创建烟雾
+     * @param params
+     * @returns
+     */
+    createSmoke(params: SmokeOptions): PluginObject;
+    createSmoke2(params: Smoke2Options): PluginObject;
+    /**
+     * 创建星星
+     * @param params
+     * @returns
+     */
+    createSparkles(params: SparklesOptions): PluginObject;
+    /**
+     * 创建接触阴影
+     * @params params
+     */
+    createContactShadows({ scale, frames, opacity, width, height, blur, darkness, far, resolution, ...props }: ContactShadowsOptions): PluginObject;
+    /**
+     * 开启天气
+     * @param param0
+     */
+    openWeather(params?: WeatherOptions): void;
+    /**
+     * 关闭天气
+     */
+    closeWeather(): void;
+    /**
+     * 创建粒子簇
+     * @param options
+     * @returns
+     */
+    createParticleCluster(options: ParticleClusterOptions): any;
+    /**
+     * 创建圆形光波
+     * @param options
+     * @returns
+     */
+    createCircleWave(options: CircleWaveOptions): PluginObject;
+    /**
+     * 创建立柱光波
+     * @param options
+     * @returns
+     */
+    createCylinderWave(options: CylinderWaveOptions): PluginObject;
+    /**
+     * 创建粒子波浪
+     * @param options
+     * @returns
+     */
+    createPointsWave(options: PointsWaveOptions): PluginObject;
+    /**
+     * 创建建筑
+     * @param options
+     * @returns
+     */
+    createBuilds(options: BuildsOptions): PluginObject;
+    createWater(options: CreateWaterOptions): PluginObject;
+    removeEffect(id: PluginObjectInfo['id']): boolean;
+}
+export default EffectPlugin;