@galacean/effects-plugin-model 0.0.1-alpha.0 → 0.0.1-alpha.1

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/dist/gltf/loader-ext.d.ts

@@ -43,11 +43,7 @@ export declare function loadGLTFScene(options: LoadGLTFSceneOptions): Promise<{
     }[];
     gltf: never[];
     images: never[];
-    version: string;
     shapes: never[];
     plugins: string[];
-    type: string;
-    _imgs: {
-        '1': never[];
-    };
+    version: string;
 }>;

package/dist/gltf/loader-helper.d.ts

@@ -3,12 +3,12 @@ import type { BaseTransform as Transform } from '../index';
 import { Vector3, Matrix4, Quaternion, Euler } from '../math';
 export declare class LoaderHelper {
     static getTransformFromMat4(mat: Matrix4): Transform;
-    static getMarsTransformFromMat4(mat: Matrix4): Transform;
+    static getEffectsTransformFromMat4(mat: Matrix4): Transform;
     static getTransformFromTranslation(t: Vector3): Transform;
     static getTransformFromDirection(d: Vector3): Transform;
-    static getMarsTransformFromDirection(d: Vector3): Transform;
+    static getEffectsTransformFromDirection(d: Vector3): Transform;
     static getTransformFromTransDir(t: Vector3, d: Vector3): Transform;
-    static getMarsTransformFromTransDir(t: Vector3, d: Vector3): Transform;
+    static getEffectsTransformFromTransDir(t: Vector3, d: Vector3): Transform;
     static getEulerFromQuat(q: Quaternion): [number, number, number];
     static getQuatFromEuler(e: Euler): [number, number, number, number];
     static toPlayerColor3(color: spec.vec3): spec.vec3;

package/dist/gltf/loader-impl.d.ts

@@ -1,12 +1,12 @@
 import type { Texture, Engine } from '@galacean/effects';
 import { spec, Geometry } from '@galacean/effects';
 import type { Loader, LoaderOptions, SkyboxType, LoadSceneOptions, LoadSceneResult } from './protocol';
-import type { MarsAnimationOptions, MarsCameraOptions, MarsMaterialOptions, MarsLightOptions, MarsSkyboxOptions, MarsTreeOptions } from '../index';
+import type { ModelAnimationOptions, ModelCameraOptions, ModelMaterialOptions, ModelLightOptions, ModelSkyboxOptions, ModelTreeOptions } from '../index';
 import type { GLTFImage, GLTFMaterial, GLTFTexture, GLTFScene, GLTFPrimitive, GLTFTextureInfo, GLTFLight, GLTFCamera, GLTFAnimation, GLTFImageBasedLight } from '@vvfx/resource-detection';
 import { PSkyboxType } from '../runtime/skybox';
 import type { CubeImage } from '@vvfx/resource-detection/dist/src/gltf-tools/gltf-image-based-light';
-export declare function getDefaultMarsGLTFLoader(engine: Engine, options?: LoaderOptions): Loader;
-export declare function setDefaultMarsGLTFLoader(loader: Loader): void;
+export declare function getDefaultEffectsGLTFLoader(engine: Engine, options?: LoaderOptions): Loader;
+export declare function setDefaultEffectsGLTFLoader(loader: Loader): void;
 export declare class LoaderImpl implements Loader {
     private _sceneOptions;
     private _loaderOptions;
@@ -24,19 +24,19 @@ export declare class LoaderImpl implements Loader {
     private _skyboxOptions?;
     engine: Engine;
     initial(engine: Engine, options?: LoaderOptions): void;
-    processLight(lights: GLTFLight[], fromGLTFToMars: boolean): void;
-    processCamera(cameras: GLTFCamera[], fromGLTFToMars: boolean): void;
-    processMaterial(materials: GLTFMaterial[], fromGLTFToMars: boolean): void;
-    createTreeOptions(scene: GLTFScene): MarsTreeOptions;
-    createAnimations(animations: GLTFAnimation[]): MarsAnimationOptions[];
+    processLight(lights: GLTFLight[], fromGLTF: boolean): void;
+    processCamera(cameras: GLTFCamera[], fromGLTF: boolean): void;
+    processMaterial(materials: GLTFMaterial[], fromGLTF: boolean): void;
+    createTreeOptions(scene: GLTFScene): ModelTreeOptions;
+    createAnimations(animations: GLTFAnimation[]): ModelAnimationOptions[];
     createGeometry(primitive: GLTFPrimitive, hasSkinAnim: boolean): Geometry;
-    createMaterial(material: GLTFMaterial): MarsMaterialOptions;
+    createMaterial(material: GLTFMaterial): ModelMaterialOptions;
     createTexture2D(image: GLTFImage, texture: GLTFTexture, isBaseColor: boolean): Promise<Texture>;
     createTextureCube(cubeImages: CubeImage[], level0Size?: number): Promise<Texture>;
-    createSkybox(ibl: GLTFImageBasedLight): Promise<MarsSkyboxOptions>;
-    createDefaultSkybox(typeName: SkyboxType): Promise<MarsSkyboxOptions>;
-    scaleColorVal(val: number, fromGLTFToMars: boolean): number;
-    scaleColorVec(vec: number[], fromGLTFToMars: boolean): number[];
+    createSkybox(ibl: GLTFImageBasedLight): Promise<ModelSkyboxOptions>;
+    createDefaultSkybox(typeName: SkyboxType): Promise<ModelSkyboxOptions>;
+    scaleColorVal(val: number, fromGLTF: boolean): number;
+    scaleColorVec(vec: number[], fromGLTF: boolean): number[];
     loadScene(options: LoadSceneOptions): Promise<LoadSceneResult>;
     private _preprocess;
     tryAddTexture2D(matIndex: number, texInfo: GLTFTextureInfo | undefined, isBaseColor: boolean): Promise<void> | undefined;
@@ -48,8 +48,8 @@ export declare class LoaderImpl implements Loader {
     private _createItemCamera;
     private _createItemSkybox;
     private _computeSceneAABB;
-    createLightOptions(light: GLTFLight): MarsLightOptions;
-    createCameraOptions(camera: GLTFCamera): MarsCameraOptions | undefined;
+    createLightOptions(light: GLTFLight): ModelLightOptions;
+    createCameraOptions(camera: GLTFCamera): ModelCameraOptions | undefined;
     private _clear;
     /**
      * 按照传入的动画播放参数，计算需要播放的动画索引
@@ -57,7 +57,7 @@ export declare class LoaderImpl implements Loader {
      * @param treeOptions 节点树属性，需要初始化animations列表。
      * @returns 返回计算的动画索引，-1表示没有动画需要播放，-88888888表示播放所有动画。
      */
-    getPlayAnimationIndex(treeOptions: MarsTreeOptions): number;
+    getPlayAnimationIndex(treeOptions: ModelTreeOptions): number;
     isPlayAnimation(): boolean;
     isPlayAllAnimation(): boolean;
     getRemarkString(): string;

package/dist/gltf/protocol.d.ts

@@ -2,7 +2,7 @@ import type { GLTFMaterial, GLTFPrimitive, GLTFLight, GLTFScene, GLTFImage, GLTF
 import type { CubeImage } from '@vvfx/resource-detection/dist/src/gltf-tools/gltf-image-based-light';
 import type { GLTFResources } from '@vvfx/resource-detection/dist/src/gltf-tools';
 import type { spec, Renderer, Texture, Geometry } from '@galacean/effects';
-import type { MarsAnimationOptions, MarsMaterialOptions, MarsSkyboxOptions, MarsTreeOptions, MarsItemModelBase } from '../index';
+import type { ModelAnimationOptions, ModelMaterialOptions, ModelSkyboxOptions, ModelTreeOptions, ModelBaseItem } from '../index';
 /**
  * glTF 场景文件加载选项，主要用于 Demo 测试或外部测试调用
  */
@@ -37,9 +37,9 @@ export interface LoadSceneOptions {
          */
         ignoreSkybox?: boolean;
     };
-    mars: {
+    effects: {
         /**
-         * Mars Renderer
+         * Renderer
          */
         renderer?: Renderer;
         /**
@@ -62,7 +62,7 @@ export interface LoadSceneOptions {
 }
 export interface LoadSceneResult {
     source: string;
-    items: MarsItemModelBase[];
+    items: ModelBaseItem[];
     sceneAABB: {
         min: spec.vec3;
         max: spec.vec3;
@@ -74,17 +74,17 @@ export interface LoaderOptions {
 export type SkyboxType = 'NFT' | 'FARM';
 export interface Loader {
     loadScene(options: LoadSceneOptions): Promise<LoadSceneResult>;
-    processLight(lights: GLTFLight[], fromGLTFToMars: boolean): void;
-    processCamera(cameras: GLTFCamera[], fromGLTFToMars: boolean): void;
-    processMaterial(materials: GLTFMaterial[], fromGLTFToMars: boolean): void;
-    createTreeOptions(scene: GLTFScene): MarsTreeOptions;
-    createAnimations(animations: GLTFAnimation[]): MarsAnimationOptions[];
+    processLight(lights: GLTFLight[], fromGLTF: boolean): void;
+    processCamera(cameras: GLTFCamera[], fromGLTF: boolean): void;
+    processMaterial(materials: GLTFMaterial[], fromGLTF: boolean): void;
+    createTreeOptions(scene: GLTFScene): ModelTreeOptions;
+    createAnimations(animations: GLTFAnimation[]): ModelAnimationOptions[];
     createGeometry(primitive: GLTFPrimitive, hasSkinAnim: boolean): Geometry;
-    createMaterial(material: GLTFMaterial): MarsMaterialOptions;
+    createMaterial(material: GLTFMaterial): ModelMaterialOptions;
     createTexture2D(images: GLTFImage, textures: GLTFTexture, isBaseColor: boolean): Promise<Texture>;
     createTextureCube(cubeImages: CubeImage[], level0Size?: number): Promise<Texture>;
-    createSkybox(ibl: GLTFImageBasedLight): Promise<MarsSkyboxOptions>;
-    createDefaultSkybox(typeName: SkyboxType): Promise<MarsSkyboxOptions>;
-    scaleColorVal(val: number, fromGLTFToMars: boolean): number;
-    scaleColorVec(vec: number[], fromGLTFToMars: boolean): number[];
+    createSkybox(ibl: GLTFImageBasedLight): Promise<ModelSkyboxOptions>;
+    createDefaultSkybox(typeName: SkyboxType): Promise<ModelSkyboxOptions>;
+    scaleColorVal(val: number, fromGLTF: boolean): number;
+    scaleColorVec(vec: number[], fromGLTF: boolean): number[];
 }

package/dist/index.d.ts

@@ -1,35 +1,35 @@
 import type { spec } from '@galacean/effects';
 export declare const version: string;
 export type BaseTransform = spec.BaseItemTransform;
-export type MarsItemModelBase = spec.BaseItem;
-export type MarsItemCamera = spec.ModelCameraItem;
-export type MarsItemLight = spec.ModelLightItem;
-export type MarsTextureTransform = spec.ModelTextureTransform;
-export type MarsItemBoundingBox = spec.ModelItemBoundingBox;
-export type MarsItemBoundingSphere = spec.ModelItemBoundingSphere;
-export type MarsItemBounding = spec.ModelItemBounding;
-export type MarsCameraOptions = spec.ModelCameraOptions;
-export type MarsLightBaseOptions = spec.ModelLightBaseOptions;
-export type MarsLightPointOptions = spec.ModelLightPointOptions;
-export type MarsLightSpotOptions = spec.ModelLightSpotOptions;
-export type MarsLightDirOptions = spec.ModelLightDirOptions;
-export type MarsAmbientOptions = spec.ModelAmbientLightOptions;
-export type MarsLightOptions = spec.ModelLightOptions;
-export type MarsItemMesh = spec.ModelMeshItem<'studio'>;
-export type MarsItemSkybox = spec.ModelSkyboxItem<'studio'>;
-export type MarsItemTree = spec.ModelTreeItem<'studio'>;
-export type MarsMeshOptions = spec.ModelMeshOptions<'studio'>;
-export type MarsSkinOptions = spec.SkinOptions<'studio'>;
-export type MarsPrimitiveOptions = spec.PrimitiveOptions<'studio'>;
-export type MarsMaterialUnlitOptions = spec.MaterialUnlitOptions<'studio'>;
-export type MarsMaterialPBROptions = spec.MaterialPBROptions<'studio'>;
-export type MarsMaterialHariOptions = spec.MaterialHairOptions<'studio'>;
-export type MarsMaterialOptions = spec.MaterialOptions<'studio'>;
-export type MarsSkyboxOptions = spec.SkyboxOptions<'studio'>;
-export type MarsTreeOptions = spec.ModelTreeOptions<'studio'>;
-export type MarsTreeContent = spec.ModelTreeContent<'studio'>;
-export type MarsAnimTrackOptions = spec.ModelAnimTrackOptions<'studio'>;
-export type MarsAnimationOptions = spec.ModelAnimationOptions<'studio'>;
+export type ModelBaseItem = spec.BaseItem;
+export type ModelItemCamera = spec.ModelCameraItem;
+export type ModelItemLight = spec.ModelLightItem;
+export type ModelTextureTransform = spec.ModelTextureTransform;
+export type ModelItemBoundingBox = spec.ModelItemBoundingBox;
+export type ModelItemBoundingSphere = spec.ModelItemBoundingSphere;
+export type ModelItemBounding = spec.ModelItemBounding;
+export type ModelCameraOptions = spec.ModelCameraOptions;
+export type ModelLightBaseOptions = spec.ModelLightBaseOptions;
+export type ModelLightPointOptions = spec.ModelLightPointOptions;
+export type ModelLightSpotOptions = spec.ModelLightSpotOptions;
+export type ModelLightDirOptions = spec.ModelLightDirOptions;
+export type ModelAmbientLightOptions = spec.ModelAmbientLightOptions;
+export type ModelLightOptions = spec.ModelLightOptions;
+export type ModelItemMesh = spec.ModelMeshItem<'studio'>;
+export type ModelItemSkybox = spec.ModelSkyboxItem<'studio'>;
+export type ModelItemTree = spec.ModelTreeItem<'studio'>;
+export type ModelMeshOptions = spec.ModelMeshOptions<'studio'>;
+export type ModelSkinOptions = spec.SkinOptions<'studio'>;
+export type ModelPrimitiveOptions = spec.PrimitiveOptions<'studio'>;
+export type ModelMaterialUnlitOptions = spec.MaterialUnlitOptions<'studio'>;
+export type ModelMaterialPBROptions = spec.MaterialPBROptions<'studio'>;
+export type ModelMaterialHariOptions = spec.MaterialHairOptions<'studio'>;
+export type ModelMaterialOptions = spec.MaterialOptions<'studio'>;
+export type ModelSkyboxOptions = spec.SkyboxOptions<'studio'>;
+export type ModelTreeOptions = spec.ModelTreeOptions<'studio'>;
+export type ModelTreeContent = spec.ModelTreeContent<'studio'>;
+export type ModelAnimTrackOptions = spec.ModelAnimTrackOptions<'studio'>;
+export type ModelAnimationOptions = spec.ModelAnimationOptions<'studio'>;
 export * from './gesture';
 export * from './gltf';
 export * from './math';