@manycore/custom-sdk 1.0.0-latest.0

package/index.d.ts

@@ -0,0 +1,449 @@
+import { IExportModelData } from '@manycore/custom-miniapp-sdk';
+import { Number3 } from '@manycore/custom-miniapp-sdk';
+
+export declare class Application {
+    constructor();
+    /**
+     * 启动当前应用
+     */
+    start(): Promise<void>;
+    /**
+     * 初始化语言类型
+     * @param lang
+     * @param resource
+     */
+    initLange(lang?: string, resource?: {}): void;
+    stop(): void;
+    getService<T extends BaseService>(serv: {
+        new (): T;
+    }): T;
+}
+
+declare class BaseService {
+}
+
+/**
+ * 配件附加参数数据类型
+ */
+export declare enum EFittingParametersType {
+    /**
+     * 字符串
+     */
+    string = "string",
+    double = "double",
+    long = "long",
+    int = "int",
+    float2 = "float2",
+    float3 = "float3"
+}
+
+/**
+ * 孔槽配件类型
+ */
+export declare enum EFittingType {
+    /**
+     * 槽
+     */
+    GROOVE = 1,
+    /**
+     * 孔
+     */
+    HOLE = 2,
+    /**
+     * 五金
+     */
+    HARDWARE = 3,
+    /**
+     * 交接面信息
+     */
+    INTERSECTED = 4
+}
+
+/**
+ * 交接面、交接体数据类型
+ */
+export declare enum EIntersectedType {
+    /**
+     * 交接体
+     */
+    SHELL = "1",
+    /**
+     * 交界面
+     */
+    FACE = "2"
+}
+
+export declare enum ELanguage {
+    ZH_CN = "zh_CN",
+    EN_US = "en_US",
+    DE_DE = "de_DE",
+    FR_FR = "fr_FR",
+    JA_JP = "ja_JP",
+    ZH_TW = "zh_TW",
+    RU_RU = "ru_RU",
+    KO_KR = "ko_KR",
+    ES_ES = "es_ES",
+    AR_EG = "ar_EG",
+    EN_CN = "en_CN",
+    VI = "vi"
+}
+
+export declare enum ESelectedType {
+    /**
+     * 未选中模型
+     */
+    NULL = 0,
+    /**
+     * 模型或商品
+     */
+    MODEL = 1,
+    /**
+     * 五金信息
+     */
+    CASBIN = 2
+}
+
+export declare class FittingDesignService extends BaseService {
+    /**
+     * 设置孔槽方案自动保存
+     *
+     * @param autoSave 默认开启自动保存
+     */
+    toggleAutoSave(autoSave?: boolean): void;
+    /**
+     * 是否开启了自动保存功能
+     */
+    isAutoSave(): boolean;
+    /**
+     *
+     * 槽方案数据
+     *
+     * @param modelid 模型ID，如果为空时，则表示传递的为查询当前模型的数据
+     * @param casbin 是否为五金，当modelid为五金的id时，需要为true
+     */
+    getConnectedFittingDesign(modelid?: string, casbin?: boolean): Promise<IFittingDesignData | null>;
+    /**
+     * 往当前方案中，新增孔/槽数据
+     *
+     * 会自动merge数据，但同一块板上，会进行覆盖
+     *
+     * @param design
+     * @param option { timeout, save} 调用超时，save 是否立即保存至后端，默认为true
+         */
+     appendFittingDesign(design: Partial<IFittingDesignData>, option?: {
+         timeout?: number;
+         save?: boolean;
+     }): Promise<void>;
+     /**
+      * 保存孔/槽数据至方案
+      * 如果design不传，即表示将分步保存数据保存至后端
+      *
+      * @param design
+      * @param option
+      */
+     saveDesign(design?: IFittingDesignData, option?: {
+         timeout?: number;
+     }): Promise<void>;
+     /**
+      * 清空当前孔槽方案
+      *
+      * @param timeout
+      */
+     clearDesign(timeout?: number): Promise<void>;
+    }
+
+    /**
+     * 孔槽数据基础示意
+     */
+    export declare interface IBaseFittingData {
+        /**
+         * 孔槽的id
+         */
+        id: string;
+        /**
+         * 类型
+         */
+        fittingType: EFittingType;
+        /**
+         * 附加通用参数
+         */
+        params?: EFittingParametersType[];
+    }
+
+    /**
+     * 附加通用参数存储
+     */
+    export declare interface IBaseFittingParameters {
+        key: string;
+        value: string;
+        type: string;
+    }
+
+    /**
+     * 孔/槽的基础数据结构
+     */
+    export declare interface IBaseHoleGrooveData extends IBaseFittingData {
+        /**
+         * 孔/槽的深度
+         */
+        depth: number;
+        /**
+         * 所处的板面
+         */
+        plankFaceId: number;
+        /**
+         * 起点
+         */
+        start: Number3;
+        /**
+         * 终点
+         */
+        end: Number3;
+    }
+
+    export declare interface IBaseIntersected {
+        /**
+         * 板面
+         */
+        plankFaceId: number;
+        /**
+         * 所有点的信息
+         */
+        points: Number3[];
+        /**
+         * 关联的模型ID
+         */
+        linkedModelId: string;
+        /**
+         * 关联的父级模型ID
+         */
+        linkedParentModelId: string;
+        /**
+         * 交接类型
+         */
+        '@type': EIntersectedType;
+        /**
+         * 交接体的shell数据
+         */
+        shell?: string;
+    }
+
+    /**
+     * 孔/槽方案的数据结构
+     */
+    export declare interface IFittingDesignData {
+        /**
+         * 所属模型的id
+         */
+        id?: string;
+        /**
+         * 所有的孔的数据
+         */
+        holes: IFittingHoleCollect;
+        /**
+         * 槽的数据
+         */
+        grooves: IFittingGrooveCollect;
+        /**
+         * 五金数据
+         */
+        hardwares: IFittingHardwareCollect;
+    }
+
+    /**
+     * 方案中的所有槽的数据
+     */
+    export declare type IFittingGrooveCollect = Record<string, IGrooveData[]>;
+
+    /**
+     * 五金数据
+     */
+    export declare type IFittingHardwareCollect = Record<string, IHardwareData[]>;
+
+    /**
+     * 方案中，所有孔的数据
+     */
+    export declare type IFittingHoleCollect = Record<string, IHoleData[]>;
+
+    export declare interface IGrooveData extends IBaseHoleGrooveData {
+        width: number;
+    }
+
+    /**
+     * 五金相关的信息
+     */
+    export declare interface IHardwareData extends IBaseFittingData {
+        /**
+         * 建模原点在板件坐标系下的坐标
+         */
+        position: Number3;
+        /**
+         * 相对建模坐标系中夹角，不传默认没有任何基于板件坐标的旋转，会将五金以建模原点放在 position 上，五金建模方向和板件建模方向一致进行摆放。
+         */
+        rotate: Number3;
+        /**
+         * 相对建模坐标系中缩放，不传默认五金和上传大小完全一致
+         */
+        scale: Number3;
+        /**
+         * 商品ID
+         */
+        brandGoodId: string;
+        /**
+         * 关联孔槽ID
+         */
+        linkedIds: string[];
+    }
+
+    export declare interface IHoleData extends IBaseHoleGrooveData {
+        /**
+         * 孔直径
+         */
+        diameter: number;
+    }
+
+    export declare interface IIntersectedGroup {
+        /**
+         * 交接面ID
+         */
+        id: string;
+        /**
+         * 交接面信息
+         */
+        intersecteds: IBaseIntersected[];
+    }
+
+    /**
+     * 交接面信息
+     */
+    export declare interface IIntersectedResult {
+        intersectedGroups: IIntersectedGroup[];
+    }
+
+    export declare class IntersectedService extends BaseService {
+        /**
+         * 是否显示交接面信息
+         *
+         * @param flag
+         */
+        toggleModelViewIntersected(flag: boolean): void;
+        /**
+         * 切换展示的交接面、交接体坐标
+         *
+         * @param option
+         */
+        toggleModelViewedIntersected(option?: IToggleIntersectedViewOption): void;
+    }
+
+    export declare interface IPoint3d {
+        x: number;
+        y: number;
+        z: number;
+    }
+
+    export declare interface ISelected {
+        data: IExportModelData[] | IHardwareData[];
+        type: ESelectedType;
+    }
+
+    /**
+     * 处理场景当中
+     */
+    export declare interface ISettingColor {
+        /**
+         * 交接面展示时，使用的颜色表示
+         */
+        intersectedColor: number;
+        /**
+         * 交接体展示时，使用的颜色
+         */
+        intersectedBodyColor: number;
+        /**
+         * 孔展示
+         */
+        holeColor: number;
+        /**
+         * 槽展示颜色
+         */
+        grooveColor: number;
+    }
+
+    export declare interface IToggleIntersectedViewOption {
+        /**
+         * 是否展示
+         * 默认为false
+         */
+        references?: boolean;
+        plankFaceIds?: number[];
+    }
+
+    export declare class ModelService extends BaseService {
+        /**
+         * 获取当前整个模型数据信息
+         *
+         * @param timeout
+         */
+        getParamData(timeout?: number): Promise<any>;
+        /**
+         * 获取交接面信息
+         *
+         * @param timeout
+         */
+        getParamIntersected(timeout?: number): Promise<IIntersectedResult>;
+    }
+
+    export declare class ModelViewerSelectionService extends BaseService {
+        constructor();
+        /**
+         * 获取当前选中模型
+         */
+        getSelected(): ISelected;
+        /**
+         * 设置当前选中内容
+         */
+        select(selected: any[]): void;
+        /**
+         * 取消选中所有内容
+         */
+        unSelect(): void;
+        private onSelectedChanged;
+        on(fn: (param: ISelected) => any): void;
+        off(fn?: (param: ISelected) => any): void;
+        once(fn: (param: ISelected) => any): void;
+        __onDestroy(): void;
+    }
+
+    /**
+     * 模型展示的服务
+     */
+    export declare class ModelViewerService extends BaseService {
+        /**
+         * 查看当前选中的模型
+         */
+        viewSelected(): Promise<void>;
+        /**
+         * 通过模型的ID来显示某个模型
+         * @param id 模型ID
+         */
+        viewModelById(id: string | string[]): Promise<void>;
+        /**
+         * 重置视角
+         */
+        resetPerspective(): void;
+        /**
+         * 模型渲染是都显示边框
+         * @param flag
+         */
+        toggleModelBorder(flag: boolean): void;
+        /**
+         * 模型渲染是否半透明
+         * @param flag
+         */
+        toggleModelTransparent(flag: boolean): void;
+        /**
+         * 配置场景展示界面
+         */
+        setting(settings: Partial<ISettingColor>): void;
+    }
+
+    export { }