@galacean/effects-plugin-editor-gizmo 0.0.0-experimental-downgrade624-20240904

package/LICENSE

@@ -0,0 +1,22 @@
+MIT LICENSE
+
+Copyright (c) 2019-present Ant Group Co., Ltd. https://www.antgroup.com/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,13 @@
+# Galacean Effects Editor Gizmo Plugin
+
+## Development
+
+### Getting Started
+
+``` bash
+# demo
+pnpm --filter @galacean/effects-plugin-editor-gizmo dev
+```
+
+> Open in browser: http://localhost:8081/demo/index.html
+

package/dist/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const color: {
+    xAxisColor: number[];
+    yAxisColor: number[];
+    zAxisColor: number[];
+};
+export declare const renderMode: 4;
+export declare const axisIconMap: Map<string, string>;

package/dist/define.d.ts

@@ -0,0 +1,37 @@
+import type { GeometryDrawMode, spec } from '@galacean/effects';
+export interface GizmoVFXItemOptions {
+    target: number;
+    subType: GizmoSubType;
+    renderMode?: GeometryDrawMode;
+    type: 'editor-gizmo';
+    color: spec.vec3;
+    size?: number;
+    depthTest?: boolean;
+}
+export declare const GizmoVFXItemType: spec.ItemType;
+/**
+ * Gizmo 类型
+ */
+export declare enum GizmoSubType {
+    particleEmitter = 1,
+    modelWireframe = 2,
+    box = 3,
+    sphere = 4,
+    cylinder = 5,
+    cone = 6,
+    torus = 7,
+    sprite = 8,
+    plane = 9,
+    rotation = 10,
+    translation = 11,
+    scale = 12,
+    viewHelper = 13,
+    camera = 14,
+    frustum = 15,
+    light = 16,
+    directionLight = 17,
+    pointLight = 18,
+    spotLight = 19,
+    boundingBox = 20,
+    floorGrid = 21
+}

package/dist/geometry/box.d.ts

@@ -0,0 +1,10 @@
+import { GeometryData } from './geometry';
+export declare class BoxGeometryData extends GeometryData {
+    /**
+     *
+     * @param width
+     * @param height
+     * @param depth
+     */
+    constructor(width?: number, height?: number, depth?: number);
+}

package/dist/geometry/cone.d.ts

@@ -0,0 +1,17 @@
+import { CylinderGeometryData } from './cylinder';
+/**
+ *
+ */
+export declare class ConeGeometryData extends CylinderGeometryData {
+    /**
+     *
+     * @param radius
+     * @param height
+     * @param radialSegments
+     * @param heightSegments
+     * @param openEnded
+     * @param thetaStart
+     * @param thetaLength
+     */
+    constructor(radius?: number, height?: number, radialSegments?: number, heightSegments?: number, openEnded?: boolean, thetaStart?: number, thetaLength?: number);
+}

package/dist/geometry/cylinder.d.ts

@@ -0,0 +1,18 @@
+import { GeometryData } from './geometry';
+/**
+ *
+ */
+export declare class CylinderGeometryData extends GeometryData {
+    /**
+     *
+     * @param radiusTop
+     * @param radiusBottom
+     * @param height
+     * @param radialSegments
+     * @param heightSegments
+     * @param openEnded
+     * @param thetaStart
+     * @param thetaLength
+     */
+    constructor(radiusTop?: number, radiusBottom?: number, height?: number, radialSegments?: number, heightSegments?: number, openEnded?: boolean, thetaStart?: number, thetaLength?: number);
+}

package/dist/geometry/direction-light.d.ts

@@ -0,0 +1,17 @@
+import { GeometryData } from './geometry';
+/**
+ * 方向光造型数据
+ * lines
+ */
+export declare class DirectionLightData extends GeometryData {
+    /**
+     * 构造函数
+     * @param radius - 圆半径
+     * @param length - 光线长度
+     * @param segments - 圆精度
+     * @param linesNumber - 光线数量
+     * @param thetaStart - 起始弧度
+     * @param thetaLength - 终止弧度
+     */
+    constructor(radius?: number, length?: number, segments?: number, linesNumber?: number, thetaStart?: number, thetaLength?: number);
+}

package/dist/geometry/floor-line-edge.d.ts

@@ -0,0 +1,13 @@
+import { GeometryData } from './geometry';
+/**
+ * 地板线边框造型数据
+ * lines
+ */
+export declare class FloorLineEdgeGeometryData extends GeometryData {
+    /**
+     *
+     * @param sideLength
+     * @param parts
+     */
+    constructor(sideLength?: number, parts?: number);
+}

package/dist/geometry/floor-line.d.ts

@@ -0,0 +1,14 @@
+import { GeometryData } from './geometry';
+/**
+ * 地板线造型数据
+ * lines
+ */
+export declare class FloorLineGeometryData extends GeometryData {
+    /**
+     *
+     * @param sideLength
+     * @param parts
+     * @param subparts
+     */
+    constructor(sideLength?: number, parts?: number, subparts?: number);
+}

package/dist/geometry/frustum.d.ts

@@ -0,0 +1,17 @@
+import type { spec } from '@galacean/effects';
+import { GeometryData } from './geometry';
+/**
+ *
+ */
+export declare class FrustumGeometryData extends GeometryData {
+    /**
+     *
+     * @param position
+     * @param rotation
+     * @param fov
+     * @param aspect
+     * @param near
+     * @param far
+     */
+    constructor(position: spec.vec3, rotation: spec.vec3, fov: number, aspect: number, near: number, far: number);
+}

package/dist/geometry/geometry.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 基础几何数据[抽象类，不可以直接用来初始化]
+ */
+export declare abstract class GeometryData {
+    points: number[];
+    uvs: number[];
+    normals: number[];
+    indices: number[];
+    /**
+     * 构件 XY 平面圆（圆心为(0, 0, z)）
+     * @param radius - 圆半径
+     * @param z - z 值
+     * @param segments - 圆精度
+     * @param thetaStart - 起始弧度
+     * @param thetaLength - 终止弧度
+     * @param startIndex - 索引起始值
+     * @param points - 点数据
+     * @param indices - 索引数据
+     */
+    createXYPlaneCircle(radius: number, z: number, segments: number, thetaStart: number, thetaLength: number, startIndex: number, points: number[], indices: number[]): void;
+    /**
+     * 构件 XZ 平面圆（圆心为(0, y, 0)）
+     * @param radius - 圆半径
+     * @param y - y 值
+     * @param segments - 圆精度
+     * @param thetaStart - 起始弧度
+     * @param thetaLength - 终止弧度
+     * @param startIndex - 索引起始值
+     * @param points - 点数据
+     * @param indices - 索引数据
+     */
+    createXZPlaneCircle(radius: number, y: number, segments: number, thetaStart: number, thetaLength: number, startIndex: number, points: number[], indices: number[]): void;
+    /**
+     * 构件 YZ 平面圆（圆心为(x, 0, 0)）
+     * @param radius - 圆半径
+     * @param x - x 值
+     * @param segments - 圆精度
+     * @param thetaStart - 起始弧度
+     * @param thetaLength - 终止弧度
+     * @param startIndex - 索引起始值
+     * @param points - 点数据
+     * @param indices - 索引数据
+     */
+    createYZPlaneCircle(radius: number, x: number, segments: number, thetaStart: number, thetaLength: number, startIndex: number, points: number[], indices: number[]): void;
+}

package/dist/geometry/index.d.ts

@@ -0,0 +1,43 @@
+import type { Engine, GeometryDrawMode, spec } from '@galacean/effects';
+import { Geometry } from '@galacean/effects';
+/**
+ * 几何体类型
+ */
+export declare enum GeometryType {
+    Box = 0,
+    Sphere = 1,
+    Cylinder = 2,
+    Cone = 3,
+    Torus = 4,
+    Frustum = 5,
+    Sprite = 6,
+    Plane = 7,
+    DirectionLight = 8,
+    SpotLight = 9,
+    PointLight = 10,
+    FloorGrid = 11
+}
+/**
+ * 几何体参数
+ */
+export interface MeshOption {
+    size: any;
+    color?: spec.vec3;
+    renderMode: GeometryDrawMode;
+    depthTest?: boolean;
+    name?: string;
+    alpha?: number;
+}
+/**
+ * 合并多个几何体数据
+ * @param geometries - 几何体数据数组
+ * @returns 合并后的几何体数据
+ */
+/**
+ * 创建几何体对象
+ * @param type - 几何体类型
+ * @param size - 几何体尺寸
+ * @param renderMode - 绘制模式：`gl.TRIANGLES`、`gl.LINES`
+ * @returns
+ */
+export declare function createGeometry(engine: Engine, type: GeometryType, size: Record<string, any>, renderMode?: GeometryDrawMode): Geometry;

package/dist/geometry/plane.d.ts

@@ -0,0 +1,14 @@
+import { GeometryData } from './geometry';
+/**
+ *
+ */
+export declare class PlaneGeometryData extends GeometryData {
+    /**
+     *
+     * @param width
+     * @param height
+     * @param widthSegments
+     * @param heightSegments
+     */
+    constructor(width?: number, height?: number, widthSegments?: number, heightSegments?: number);
+}

package/dist/geometry/point-light.d.ts

@@ -0,0 +1,15 @@
+import { GeometryData } from './geometry';
+/**
+ * 点光源造型数据
+ * lines
+ */
+export declare class PointLightData extends GeometryData {
+    /**
+     * 构造函数
+     * @param range - 光照范围
+     * @param segments - 圆精度
+     * @param thetaStart - 起始弧度
+     * @param thetaLength - 终止弧度
+     */
+    constructor(range?: number, segments?: number, thetaStart?: number, thetaLength?: number);
+}

package/dist/geometry/sphere.d.ts

@@ -0,0 +1,17 @@
+import { GeometryData } from './geometry';
+/**
+ *
+ */
+export declare class SphereGeometryData extends GeometryData {
+    /**
+     *
+     * @param radius
+     * @param widthSegments
+     * @param heightSegments
+     * @param phiStart
+     * @param phiLength
+     * @param thetaStart
+     * @param thetaLength
+     */
+    constructor(radius?: number, widthSegments?: number, heightSegments?: number, phiStart?: number, phiLength?: number, thetaStart?: number, thetaLength?: number);
+}

package/dist/geometry/spot-light.d.ts

@@ -0,0 +1,16 @@
+import { GeometryData } from './geometry';
+/**
+ * 聚光灯造型数据
+ * lines
+ */
+export declare class SpotLightData extends GeometryData {
+    /**
+     * 构造函数
+     * @param range - 光线范围
+     * @param spotAngle - 光线范围[角度]
+     * @param segments - 圆精度
+     * @param thetaStart - 起始弧度
+     * @param thetaLength - 终止弧度
+     */
+    constructor(range?: number, spotAngle?: number, segments?: number, thetaStart?: number, thetaLength?: number);
+}

package/dist/geometry/torus.d.ts

@@ -0,0 +1,15 @@
+import { GeometryData } from './geometry';
+/**
+ *
+ */
+export declare class TorusGeometryData extends GeometryData {
+    /**
+     *
+     * @param radius
+     * @param tube
+     * @param radialSegments
+     * @param tubularSegments
+     * @param arc
+     */
+    constructor(radius?: number, tube?: number, radialSegments?: number, tubularSegments?: number, arc?: number);
+}

package/dist/gizmo-loader.d.ts

@@ -0,0 +1,19 @@
+import type { Composition, Mesh, RenderFrame, Scene, VFXItem } from '@galacean/effects';
+import { AbstractPlugin, RenderPass } from '@galacean/effects';
+import { GizmoVFXItem } from './gizmo-vfx-item';
+export declare class EditorGizmoPlugin extends AbstractPlugin {
+    meshToAdd: Mesh[];
+    meshToRemove: Mesh[];
+    order: number;
+    static prepareResource(scene: Scene): Promise<any>;
+    static onPlayerDestroy(): void;
+    onCompositionConstructed(composition: Composition, scene: Scene): void;
+    onCompositionReset(composition: Composition): void;
+    onCompositionItemLifeBegin(composition: Composition, item: VFXItem<any>): void;
+    onCompositionItemRemoved(composition: Composition, item: VFXItem<any>): void;
+    removeGizmoItem(composition: Composition, gizmoVFXItem: GizmoVFXItem): void;
+    prepareRenderFrame(composition: Composition, renderFrame: RenderFrame): boolean;
+    getBehindRenderPass(pipeline: RenderFrame): RenderPass;
+    getEditorRenderPass(pipeline: RenderFrame): RenderPass;
+    getFrontRenderPass(pipeline: RenderFrame): RenderPass;
+}

package/dist/gizmo-vfx-item.d.ts

@@ -0,0 +1,124 @@
+import type { GeometryDrawMode, HitTestCustomParams, Mesh, SpriteMesh, Texture } from '@galacean/effects';
+import { spec, Transform, VFXItem, math } from '@galacean/effects';
+import { GizmoSubType } from './define';
+type vec3 = spec.vec3;
+type TriangleLike = math.TriangleLike;
+type Vector3 = math.Vector3;
+declare const Vector3: typeof math.Vector3;
+/**
+ * 包围盒类型
+ */
+export declare enum BoundingType {
+    box = 0,
+    sphere = 1,
+    triangle = 2,
+    line = 3
+}
+/**
+ * 线条包围盒类型
+ */
+export interface GizmoItemBoundingLine {
+    type: BoundingType.line;
+    points: [Vector3, Vector3];
+    width: number;
+}
+/**
+ * 立方体包围盒类型
+ */
+export interface GizmoItemBoundingBox {
+    type: BoundingType.box;
+    center?: Vector3;
+    size: Vector3;
+}
+/**
+ * 球体包围盒类型
+ */
+export interface GizmoItemBoundingSphere {
+    type: BoundingType.sphere;
+    center?: Vector3;
+    radius: number;
+}
+/**
+ * 三角数组包围盒类型
+ */
+export interface GizmoItemBoundingTriangle {
+    type: BoundingType.triangle;
+    triangles: TriangleLike[];
+    backfaceCulling?: boolean;
+}
+export type GizmoItemBounding = GizmoItemBoundingBox | GizmoItemBoundingSphere | GizmoItemBoundingTriangle | GizmoItemBoundingLine;
+/**
+ *
+ */
+export declare class GizmoVFXItem extends VFXItem<Mesh | undefined> {
+    duration: number;
+    target: number;
+    subType: GizmoSubType;
+    color: vec3;
+    renderMode: GeometryDrawMode;
+    depthTest?: boolean;
+    size: any;
+    contents?: Map<Mesh, Transform>;
+    targetItem?: VFXItem<any>;
+    boundingMap: Map<string, GizmoItemBounding>;
+    hitBounding?: {
+        key: string;
+        position: Vector3;
+    };
+    mat: math.Matrix4;
+    wireframeMesh?: Mesh;
+    wireframeMeshes: Mesh[];
+    spriteMesh?: SpriteMesh;
+    private engine;
+    get type(): spec.ItemType;
+    set type(t: spec.ItemType);
+    set content(content: Mesh | undefined);
+    get content(): Mesh | undefined;
+    onConstructed(options: {
+        content: {
+            options: any;
+            transform?: any;
+        };
+    }): void;
+    /**
+     * 获取默认绘制模式
+     * @returns 绘制模式常量
+     */
+    getDefaultRenderMode(): GeometryDrawMode;
+    /**
+     * 获取默认尺寸
+     * @returns 几何体尺寸
+     */
+    getDefaultSize(): {};
+    createModelContent(item: VFXItem<any>, meshesToAdd: Mesh[]): void;
+    createParticleContent(item: VFXItem<any>, meshesToAdd: Mesh[]): void;
+    /**
+     * 创建 BoundingBox 几何体模型
+     * @param item - VFXItem
+     * @param meshesToAdd - 插件缓存的 Mesh 数组
+     */
+    createBoundingBoxContent(item: VFXItem<any>, meshesToAdd: Mesh[]): void;
+    /**
+     * 创建基础几何体模型
+     * @param item - VFXItem
+     * @param meshesToAdd - 插件缓存的 Mesh 数组
+     * @param subType - GizmoSubType 类型
+     */
+    createBasicContent(item: VFXItem<Mesh | undefined>, meshesToAdd: Mesh[], subType: GizmoSubType, iconTextures?: Map<string, Texture>): void;
+    /**
+     * 创建组合几何体模型
+     * @param item - VFXItem
+     * @param meshesToAdd - 插件缓存的 Mesh 数组
+     * @param subType - GizmoSubType 类型
+     * @param iconTextures - XYZ 图标纹理（viewHelper 专用）
+     */
+    createCombinationContent(item: VFXItem<Mesh | undefined>, meshesToAdd: Mesh[], subType: GizmoSubType, iconTextures?: Map<string, Texture>): void;
+    onItemUpdate(): void;
+    updateRenderData(): void;
+    /**
+     * 射线检测算法
+     * @returns 包含射线检测算法回调方法的参数
+     */
+    getHitTestParams(): void | HitTestCustomParams;
+}
+export {};

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import { GizmoVFXItem } from './gizmo-vfx-item';
+import { GizmoSubType } from './define';
+import { GeometryType, createGeometry } from './geometry';
+export { DirectionLightData } from './geometry/direction-light';
+export { GizmoSubType, GeometryType, createGeometry, GizmoVFXItem, };
+export declare const version: string;