@soonspacejs/plugin-flow 2.16.8 → 3.0.0-alpha.0

package/dist/index.d.ts

@@ -1,3 +1,402 @@
-export * from './flows';
-export * from './triggers';
-export * from './types';
+import { AnimationModeType } from 'soonspacejs';
+import { default as default_2 } from 'soonspacejs';
+import { EventDispatcher } from 'three';
+import { FlowType as FlowType_2 } from '@soonspacejs/plugin-flow';
+import { Interaction as Interaction_2 } from '@soonspacejs/plugin-flow';
+import { IVector3 } from 'soonspacejs';
+import { Model } from 'soonspacejs';
+import { ModelEventParams } from 'soonspacejs';
+import { Node as Node_3 } from '@soonspacejs/plugin-flow';
+import { Object3D } from 'three';
+import SoonSpace from 'soonspacejs';
+import { TriggerOptions as TriggerOptions_2 } from '@soonspacejs/plugin-flow';
+import { Tween } from 'three/examples/jsm/libs/tween.module.js';
+
+export declare class AnimationPlayer extends EventDispatcher<TEventMap> {
+    readonly ssp: SoonSpace;
+    readonly target: Object3D;
+    tweenSet: Set<TTweenType>;
+    constructor(ssp: SoonSpace, target: Object3D);
+    initTransform(defaultTransform?: TTransformObject): TTransformObject;
+    getInitialTransform(): TTransformObject | undefined;
+    play(frames: TAnimationFrame[]): Promise<void>;
+    stop(): void;
+    reset(): void;
+    dispose(): void;
+}
+
+export declare class ComponentFlowParser extends FlowParser {
+    flow: ComponentFlowType;
+    constructor(ssp: default_2, flow: ComponentFlowType);
+}
+
+/**
+ * 组件流程数据
+ */
+export declare type ComponentFlowType = FlowType & {
+    editionId: string;
+};
+
+export declare class ComponentTrigger extends Trigger {
+    flows: ComponentFlowType[];
+    flowsMap: Map<string, ComponentFlowType[]>;
+    constructor(ssp: default_2, interaction: Interaction, flows: ComponentFlowType[], options: TriggerOptions);
+    protected init(): void;
+    getComponentObsTarget(currentNode?: Node_2): Promise<Model | null>;
+    modelHandler(params: ModelEventParams): void;
+    componentThingModelHandler(params: {
+        propKey: string;
+    }): void;
+    runFlowByIds(flowIds: string[]): void;
+    execBehavior(): Promise<void>;
+    initLoaded(): void;
+    initThingPropChange(): void;
+    initThingEvent(): void;
+    onThingPropChange(newProps: string): void;
+}
+
+declare class Edge {
+    id: string;
+    source: string;
+    target: string;
+    sourceHandle?: string | null;
+    constructor(edge: EdgeType);
+}
+
+/**
+ * 连接数据
+ */
+export declare type EdgeType = {
+    id: string;
+    source: string;
+    target: string;
+    sourceHandle?: string | null;
+};
+
+export declare class FlowParser extends EventDispatcher<FlowParserEventMap> {
+    ssp: default_2;
+    flow: FlowType;
+    nodes: Node_2[];
+    nodesMap: Map<Node_2['id'], Node_2>;
+    edges: Edge[];
+    edgesMap: Map<Edge['id'], Edge>;
+    onNodeBefore: Node_2['onBefore'];
+    onNodeAfter: Node_2['onAfter'];
+    constructor(ssp: default_2, flow: FlowType);
+    addNode(node: Node_2): void;
+    addEdge(edge: Edge): void;
+    getNodeById(id: string): Node_2 | undefined;
+    getEdgeById(id: string): Edge | undefined;
+    clear(): void;
+    /**
+     * 解析流程
+     */
+    parse(): void;
+    /**
+     * 执行流程
+     * @param startNode
+     * @param ctx
+     */
+    run(global?: NodeGlobalType, options?: {
+        preload: boolean;
+    }): Promise<void>;
+    /**
+     * 调试流程
+     */
+    debug(global?: NodeGlobalType, time?: number): Promise<void>;
+    /**
+     * 停止流程
+     */
+    stop(): void;
+    /**
+     * 清理流程
+     */
+    cleanup(): void;
+    getVariableNameById(id: string): any;
+    dispose(): void;
+}
+
+export declare type FlowParserEventMap = {};
+
+/**
+ * 流程数据
+ */
+export declare type FlowType = {
+    id: string;
+    sid: string;
+    name: string;
+    portal: string;
+    nodes: NodeType[];
+    edges: EdgeType[];
+};
+
+export declare interface IAnimation {
+    id: string;
+    sid: string;
+    modelId: string;
+    name: string;
+    keyframes: TAnimationFrame[];
+}
+
+export declare interface IComponentAnimation {
+    id: string;
+    sid: string;
+    name: string;
+    refId: string;
+    editionId: string;
+    keyframes: TAnimationFrame[];
+}
+
+export declare type Interaction = {
+    id: string;
+    sid: string;
+    name: string;
+    modelId: string;
+    type: InteractionType;
+    obsType: InteractionObsType;
+    obsTargets: string[] | null;
+    obsProps: string[] | null;
+    behaviors: InteractionBehavior[] | null;
+    active: boolean;
+    editionId?: string;
+};
+
+export declare enum InteractionAction {
+    FLOW = "FLOW",
+    ANIMATION = "ANIMATION",
+    DELAY = "DELAY"
+}
+
+export declare enum InteractionActionType {
+    GLOBAL = "GLOBAL",
+    SELF = "SELF",
+    OTHER = "OTHER"
+}
+
+export declare type InteractionBehavior = {
+    id: string;
+    uuid: string;
+    actionType: InteractionActionType;
+    action: InteractionAction;
+    actionTargets: string[] | null;
+    actionRefs: string[] | null;
+};
+
+export declare enum InteractionObsType {
+    GLOBAL = "GLOBAL",
+    INSTANCE = "INSTANCE",
+    FAMILY = "FAMILY"
+}
+
+export declare enum InteractionType {
+    MOUSE_CLICK = "MOUSE_CLICK",
+    MOUSE_DB_CLICK = "MOUSE_DB_CLICK",
+    MOUSE_RIGHT_CLICK = "MOUSE_RIGHT_CLICK",
+    THING_PROP_CHANGE = "THING_PROP_CHANGE",
+    THING_EVENT = "THING_EVENT",
+    LOADED = "LOADED",
+    MODEL_PROP_CHANGE = "MODEL_PROP_CHANGE"
+}
+
+declare class Node_2 {
+    parser: FlowParser;
+    ssp: default_2;
+    id: string;
+    type: NodeTypeEnum;
+    props: NodeType['props'];
+    prevNodes: Node_2[];
+    postNodes: Node_2[];
+    execOrder: number;
+    ctx: NodeCtxType;
+    promise: Promise<void>;
+    resolve: () => void;
+    reject: (reason?: any) => void;
+    cleanSets: Set<() => void>;
+    onBefore: ((node: Node_2) => (Promise<void> | void)) | null;
+    onAfter: ((node: Node_2) => (Promise<void> | void)) | null;
+    rejected: boolean;
+    constructor(parser: FlowParser, node: NodeType);
+    init(): void;
+    readContext<T = any>(key: string): T | undefined;
+    writeContext(key: string, value: any): void;
+    findProp(name: string, type: NodePropType['type'] | NodePropType['type'][]): undefined | NodePropType;
+    /**
+     * 等待前置节点执行完毕
+     */
+    waitForPrevNodes(): Promise<void[]>;
+    /**
+     * 合并上下文
+     */
+    mergeContext(): void;
+    /**
+     * 执行节点逻辑
+     * @param global
+     */
+    exec(_global: NodeGlobalType): Promise<void>;
+    /**
+     * 运行节点
+     * @param global
+     * @param options
+     */
+    run(global: NodeGlobalType, options?: {
+        preload: boolean;
+    }): Promise<void>;
+    cleanup(): void;
+    protected getValue(prop: NodePropType, object?: Object3D | null): any;
+    private _mergeUserDataMap;
+}
+export { Node_2 as Node }
+
+/**
+ * 节点上下文对象
+ */
+export declare type NodeCtxType = {
+    [x: string]: any;
+};
+
+/**
+ * 节点全局对象
+ * 由运行时动态定义接口
+ */
+export declare type NodeGlobalType = {
+    getTarget?: (currentNode: Node_2) => Promise<Model | null>;
+    getAnimations?: (currentNode: Node_2, object: Object3D, animationId: string) => Promise<IAnimation[] | null>;
+    getComponentAnimations?: (currentNode: Node_2, object: Object3D, animationId: string) => Promise<IComponentAnimation[] | null>;
+    [s: symbol]: any;
+};
+
+/**
+ * 节点 props 数据
+ */
+export declare type NodePropType = {
+    name: string;
+    type: NodePropTypeEnum;
+    value: string;
+    valueType: string;
+};
+
+export declare enum NodePropTypeEnum {
+    LOCAL = "LOCAL",
+    READ_CTX = "READ_CTX",
+    WRITE_CTX = "WRITE_CTX"
+}
+
+/**
+ * 节点数据
+ */
+export declare type NodeType = {
+    id: string;
+    type: NodeTypeEnum;
+    props: NodePropType[];
+};
+
+export declare enum NodeTypeEnum {
+    START = "START",
+    COLOR = "COLOR",
+    NUMBER = "NUMBER",
+    HIGHLIGHT = "HIGHLIGHT",
+    UN_HIGHLIGHT = "UN_HIGHLIGHT",
+    OPACITY = "OPACITY",
+    UN_OPACITY = "UN_OPACITY",
+    EMISSIVE = "EMISSIVE",
+    UN_EMISSIVE = "UN_EMISSIVE",
+    MESH = "MESH",
+    MESHES = "MESHES",
+    MODEL = "MODEL",
+    MODELS = "MODELS",
+    SHOW = "SHOW",
+    HIDE = "HIDE",
+    CLIP_ANIMATION = "CLIP_ANIMATION",
+    UN_CLIP_ANIMATION = "UN_CLIP_ANIMATION",
+    TWEEN_ANIMATION = "TWEEN_ANIMATION",
+    UN_TWEEN_ANIMATION = "UN_TWEEN_ANIMATION",
+    COMPONENT_TWEEN_ANIMATION = "COMPONENT_TWEEN_ANIMATION",
+    UN_COMPONENT_TWEEN_ANIMATION = "UN_COMPONENT_TWEEN_ANIMATION",
+    SPACE = "SPACE",
+    SPACES = "SPACES",
+    PATH = "PATH",
+    PATHS = "PATHS",
+    POI = "POI",
+    POIS = "POIS",
+    FLY_TO = "FLY_TO",
+    TRANSLATE = "TRANSLATE",
+    ROTATE = "ROTATE",
+    SCALE = "SCALE",
+    DATA_FILTER = "DATA_FILTER",
+    DATA_EXTRACTION = "DATA_EXTRACTION",
+    CONDITION_NODE = "CONDITION_NODE",
+    DELAY = "DELAY",
+    USER_DATA_NODE = "USER_DATA_NODE"
+}
+
+export declare type TAnimationFrame = {
+    position: IVector3;
+    rotation: IVector3;
+    scale: IVector3;
+    duration: number;
+    delay: number;
+    repeat: number;
+    yoyo: boolean;
+    easing: AnimationModeType;
+};
+
+export declare type TEventMap = {
+    update: {
+        source: TTweenSource;
+        tween: TTweenType;
+    };
+    start: {
+        tween: TTweenType;
+    };
+};
+
+export declare class Trigger {
+    ssp: default_2;
+    interaction: Interaction_2;
+    flows: FlowType_2[];
+    flowsMap: Map<string, FlowType_2[]>;
+    options: TriggerOptions_2;
+    disposables: (() => void)[];
+    status: 'ready' | 'running' | 'error';
+    target?: Model;
+    constructor(ssp: default_2, interaction: Interaction_2, flows: FlowType_2[], options: TriggerOptions_2);
+    protected init(): void;
+    getObsTarget(currentNode: Node_3): Promise<null>;
+    modelHandler(params: ModelEventParams): void;
+    runFlowByIds(flowIds: string[]): void;
+    execBehavior(): Promise<void>;
+    initMouseClick(): void;
+    initMouseDbClick(): void;
+    initMouseRightClick(): void;
+    initLoaded(): void;
+    modelPropChangeHandler(properties: any): void;
+    initModelPropChange(): void;
+    initThingPropChange(): void;
+    initThingEvent(): void;
+    dispose(): void;
+}
+
+export declare type TriggerOptions = {
+    onError?: (e: Error) => void;
+    onTrigger?: (interaction: Interaction) => void;
+    getAnimations?: (currentNode: Node_2, object: Object3D, animationId: string) => Promise<IAnimation[] | null>;
+    getComponentAnimations?: (currentNode: Node_2, object: Object3D, animationId: string) => Promise<IComponentAnimation[] | null>;
+};
+
+export declare type TTransformObject = Pick<TAnimationFrame, 'position' | 'rotation' | 'scale'>;
+
+export declare type TTweenSource = {
+    x: number;
+    y: number;
+    z: number;
+    rotationX: number;
+    rotationY: number;
+    rotationZ: number;
+    scaleX: number;
+    scaleY: number;
+    scaleZ: number;
+};
+
+export declare type TTweenType = Tween<TTweenSource>;
+
+export { }