@zephyr3d/scene 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,46 @@
+# @zephyr3d
+
+Zephyr3d is a set of API for 3D rendering within the browser. 
+
+Zephyr3d is released as ES6 modules and requires npm for installation. It is designed to be used in conjunction with front-end build tools such as Webpack or Vite for development.
+
+## Installation
+
+- @zephyr3d/base
+
+  The basic module includes a math library and content commonly used in other modules.
+
+  ```npm install --save @zephyr3d/base```
+
+- @zephyr3d/device
+
+  Includes the basic definitions and abstract interfaces of the rendering API.
+
+  ```npm install --save @zephyr3d/device```
+
+- @zephyr3d/backend-webgl
+
+  WebGL backend, WebGL/WebGL2 rendering.
+
+  ```npm install --save @zephyr3d/backend-webgl```
+
+- @zephyr3d/backend-webgpu
+
+  WebGPU backend.
+
+  ```npm install --save @zephyr3d/backend-webgpu```
+
+- @zephyr3d/scene
+
+  The SceneAPI module, built on top of the DeviceAPI module, facilitates rapid development of rendering projects.
+  
+  ```npm install --save @zephyr3d/scene```
+
+- @zephyr3d/imgui
+
+  To render a GUI, you can install the ImGui binding module.
+
+  ```npm install --save @zephyr3d/imgui```
+
+
+

package/dist/animation/animation.js

@@ -2,9 +2,9 @@ import { Quaternion, Vector3, Matrix4x4 } from '@zephyr3d/base';
 import { BoundingBox } from '../utility/bounding_volume.js';
 import { Application } from '../app.js';
 
-/**
- * Animation that contains multiple tracks
- * @public
+/**
+ * Animation that contains multiple tracks
+ * @public
  */ class AnimationClip {
     /** @internal */ _name;
     /** @internal */ _model;
@@ -20,10 +20,10 @@ import { Application } from '../app.js';
     /** @internal */ _tmpPosition;
     /** @internal */ _tmpRotation;
     /** @internal */ _tmpScale;
-    /**
-   * Creates an animation instance
-   * @param name - Name of the animation
-   * @param model - Parent node if this is a skeleton animation
+    /**
+   * Creates an animation instance
+   * @param name - Name of the animation
+   * @param model - Parent node if this is a skeleton animation
    */ constructor(name, model){
         this._name = name;
         this._model = model ?? null;
@@ -55,11 +55,11 @@ import { Application } from '../app.js';
     /** The duration of the animation */ get timeDuration() {
         return this._duration;
     }
-    /**
-   * Adds a skeleton to the animation
-   * @param skeleton - The skeleton to be added
-   * @param meshList - The meshes controlled by the skeleton
-   * @param boundingBoxInfo - Bounding box information for the skeleton
+    /**
+   * Adds a skeleton to the animation
+   * @param skeleton - The skeleton to be added
+   * @param meshList - The meshes controlled by the skeleton
+   * @param boundingBoxInfo - Bounding box information for the skeleton
    */ addSkeleton(skeleton, meshList, boundingBoxInfo) {
         let meshes = this._skeletons.get(skeleton);
         if (!meshes) {
@@ -74,11 +74,11 @@ import { Application } from '../app.js';
             });
         }
     }
-    /**
-   * Adds an animation track to the animation
-   * @param node - The node that will be controlled by the track
-   * @param track - The track to be added
-   * @returns self
+    /**
+   * Adds an animation track to the animation
+   * @param node - The node that will be controlled by the track
+   * @param track - The track to be added
+   * @returns self
    */ addTrack(node, track) {
         if (!track) {
             return;
@@ -97,14 +97,14 @@ import { Application } from '../app.js';
         this._duration = Math.max(this._duration, track.interpolator.maxTime);
         return this;
     }
-    /**
-   * Check if the animation is playing
-   * @returns true if the animation is playing, otherwise false
+    /**
+   * Check if the animation is playing
+   * @returns true if the animation is playing, otherwise false
    */ isPlaying() {
         return this._isPlaying;
     }
-    /**
-   * Updates the animation state
+    /**
+   * Updates the animation state
    */ update() {
         const device = Application.instance.device;
         if (!this._isPlaying || this._lastUpdateFrame === device.frameInfo.frameCounter) {
@@ -138,8 +138,8 @@ import { Application } from '../app.js';
             this.stop();
         }
     }
-    /**
-   * Starts playing the animation
+    /**
+   * Starts playing the animation
    */ play(repeat, speedRatio) {
         this._isPlaying = true;
         this._repeat = repeat;
@@ -147,8 +147,8 @@ import { Application } from '../app.js';
         this._currentPlayTime = speedRatio < 0 ? this._duration : 0;
         this.update();
     }
-    /**
-   * Stops the animation
+    /**
+   * Stops the animation
    */ stop() {
         this._isPlaying = false;
         this._skeletons.forEach((meshes, skeleton)=>{
@@ -162,8 +162,8 @@ import { Application } from '../app.js';
             }
         });
     }
-    /**
-   * Rewind the animation to the first frame
+    /**
+   * Rewind the animation to the first frame
    */ rewind() {
         this._currentPlayTime = 0;
     }

package/dist/animation/skeleton.js

@@ -5,9 +5,9 @@ const tmpV0 = new Vector3();
 const tmpV1 = new Vector3();
 const tmpV2 = new Vector3();
 const tmpV3 = new Vector3();
-/**
- * Skeleton for skinned animation
- * @public
+/**
+ * Skeleton for skinned animation
+ * @public
  */ class Skeleton {
     /** @internal */ _joints;
     /** @internal */ _inverseBindMatrices;
@@ -15,11 +15,11 @@ const tmpV3 = new Vector3();
     /** @internal */ _jointMatrices;
     /** @internal */ _jointMatrixArray;
     /** @internal */ _jointTexture;
-    /**
-   * Creates an instance of skeleton
-   * @param joints - The joint nodes
-   * @param inverseBindMatrices - The inverse binding matrices of the joints
-   * @param bindPoseMatrices - The binding pose matrices of the joints
+    /**
+   * Creates an instance of skeleton
+   * @param joints - The joint nodes
+   * @param inverseBindMatrices - The inverse binding matrices of the joints
+   * @param bindPoseMatrices - The binding pose matrices of the joints
    */ constructor(joints, inverseBindMatrices, bindPoseMatrices){
         this._joints = joints;
         this._inverseBindMatrices = inverseBindMatrices;
@@ -28,8 +28,8 @@ const tmpV3 = new Vector3();
         this._jointMatrices = null;
         this._jointTexture = null;
     }
-    /**
-   * Disposes self
+    /**
+   * Disposes self
    */ dispose() {
         this._jointTexture?.dispose();
         this._jointTexture = null;
@@ -39,13 +39,13 @@ const tmpV3 = new Vector3();
         this._jointMatrices = null;
         this._jointMatrixArray = null;
     }
-    /**
-   * The joint transform matrices
+    /**
+   * The joint transform matrices
    */ get jointMatrices() {
         return this._jointMatrices;
     }
-    /**
-   * The texture that contains the transform matrices of all the joints
+    /**
+   * The texture that contains the transform matrices of all the joints
    */ get jointTexture() {
         return this._jointTexture;
     }

package/dist/animation/usertrack.js

@@ -2,17 +2,17 @@ import { Interpolator } from '@zephyr3d/base';
 import { AnimationTrack } from './animationtrack.js';
 
 const tmpValue = new Float32Array(4);
-/**
- * User-defined animation track
- * @public
+/**
+ * User-defined animation track
+ * @public
  */ class UserTrack extends AnimationTrack {
     _handler;
-    /**
-   * Create an instance of UserTrack
-   * @param mode - Interpolation mode for keyframe values
-   * @param target - Type of keyframe values
-   * @param keyFrames - Keyframe values
-   * @param handler - Handler to apply the keyframe values
+    /**
+   * Create an instance of UserTrack
+   * @param mode - Interpolation mode for keyframe values
+   * @param target - Type of keyframe values
+   * @param keyFrames - Keyframe values
+   * @param handler - Handler to apply the keyframe values
    */ constructor(mode, target, keyFrames, handler){
         const stride = Interpolator.getTargetStride(target);
         if (!stride) {

package/dist/app.js

@@ -1,19 +1,19 @@
 import { InputManager } from './input/inputmgr.js';
 import { makeEventTarget } from '@zephyr3d/base';
 
-/**
- * Event that will be fired every frame
- *
- * @remarks
- * This is where all the rendering work is done.
- *
- * @public
+/**
+ * Event that will be fired every frame
+ *
+ * @remarks
+ * This is where all the rendering work is done.
+ *
+ * @public
  */ class AppTickEvent {
     type = 'tick';
 }
-/**
- * This event will be fired whenever the device size changes
- * @public
+/**
+ * This event will be fired whenever the device size changes
+ * @public
  */ class AppResizeEvent {
     width;
     height;
@@ -24,17 +24,17 @@ import { makeEventTarget } from '@zephyr3d/base';
         this.height = height;
     }
 }
-/**
- * Application class
- *
- * @remarks
- * This is the entry point of your application.
- * The Application is responsible for initializing the rendering device
- * and doing the rendering loop.
- * The Application can not be created more than once. You can get the
- * instance by calling the 'Application.instance' static method.
- *
- * @public
+/**
+ * Application class
+ *
+ * @remarks
+ * This is the entry point of your application.
+ * The Application is responsible for initializing the rendering device
+ * and doing the rendering loop.
+ * The Application can not be created more than once. You can get the
+ * instance by calling the 'Application.instance' static method.
+ *
+ * @public
  */ class Application extends makeEventTarget(Object)() {
     _options;
     _device;
@@ -46,9 +46,9 @@ import { makeEventTarget } from '@zephyr3d/base';
     _logger;
     _elapsed;
     static _instance;
-    /**
-   * Creates an instance of Application
-   * @param opt - The creation options
+    /**
+   * Creates an instance of Application
+   * @param opt - The creation options
    */ constructor(opt){
         super();
         if (Application._instance) {
@@ -89,16 +89,16 @@ import { makeEventTarget } from '@zephyr3d/base';
     /** The options that was used to create the application */ get options() {
         return this._options;
     }
-    /**
-   * Query if the device is ok to render objects now.
-   *
-   * @remarks
-   * False will be returned if the device is lost.
+    /**
+   * Query if the device is ok to render objects now.
+   *
+   * @remarks
+   * False will be returned if the device is lost.
    */ get canRender() {
         return this._canRender;
     }
-    /**
-   * Query time elapsed since last frame in seconds
+    /**
+   * Query time elapsed since last frame in seconds
    */ get timeElapsedInSeconds() {
         return this._elapsed;
     }

package/dist/asset/assetmanager.js

@@ -22,9 +22,9 @@ import { GraphNode } from '../scene/graph_node.js';
 import { BUILTIN_ASSET_TEXTURE_SHEEN_LUT, BUILTIN_ASSET_TEST_CUBEMAP } from '../values.js';
 import { TGALoader } from './loaders/image/tga_Loader.js';
 
-/**
- * The asset manager
- * @public
+/**
+ * The asset manager
+ * @public
  */ class AssetManager {
     /** @internal */ static _builtinTextures = {};
     /** @internal */ static _builtinTextureLoaders = {
@@ -38,8 +38,8 @@ import { TGALoader } from './loaders/image/tga_Loader.js';
     /** @internal */ _models;
     /** @internal */ _binaryDatas;
     /** @internal */ _textDatas;
-    /**
-   * Creates an instance of AssetManager
+    /**
+   * Creates an instance of AssetManager
    */ constructor(){
         this._httpRequest = new HttpRequest();
         this._textureLoaders = [
@@ -56,47 +56,47 @@ import { TGALoader } from './loaders/image/tga_Loader.js';
         this._binaryDatas = {};
         this._textDatas = {};
     }
-    /**
-   * HttpRequest instance of the asset manager
+    /**
+   * HttpRequest instance of the asset manager
    */ get httpRequest() {
         return this._httpRequest;
     }
-    /**
-   * Removes all cached assets
+    /**
+   * Removes all cached assets
    */ clearCache() {
         this._textures = {};
         this._models = {};
         this._binaryDatas = {};
         this._textDatas = {};
     }
-    /**
-   * Adds a texture loader to the asset manager
-   *
-   * @remarks
-   * TODO: this should be a static method
-   *
-   * @param loader - The texture loader to be added
+    /**
+   * Adds a texture loader to the asset manager
+   *
+   * @remarks
+   * TODO: this should be a static method
+   *
+   * @param loader - The texture loader to be added
    */ addTextureLoader(loader) {
         if (loader) {
             this._textureLoaders.unshift(loader);
         }
     }
-    /**
-   * Adds a model loader to the asset manager
-   *
-   * @remarks
-   * TODO: this should be a static method
-   *
-   * @param loader - The model loader to be added
+    /**
+   * Adds a model loader to the asset manager
+   *
+   * @remarks
+   * TODO: this should be a static method
+   *
+   * @param loader - The model loader to be added
    */ addModelLoader(loader) {
         if (loader) {
             this._modelLoaders.unshift(loader);
         }
     }
-    /**
-   * Fetches a text resource from a given URL
-   * @param url - The URL from where to fetch the resource
-   * @returns The fetched text
+    /**
+   * Fetches a text resource from a given URL
+   * @param url - The URL from where to fetch the resource
+   * @returns The fetched text
    */ async fetchTextData(url) {
         let P = this._textDatas[url];
         if (!P) {
@@ -105,10 +105,10 @@ import { TGALoader } from './loaders/image/tga_Loader.js';
         }
         return P;
     }
-    /**
-   * Fetches a binary resource from a given URL
-   * @param url - The URL from where to fetch the resource
-   * @returns
+    /**
+   * Fetches a binary resource from a given URL
+   * @param url - The URL from where to fetch the resource
+   * @returns
    */ async fetchBinaryData(url) {
         let P = this._binaryDatas[url];
         if (!P) {
@@ -117,11 +117,11 @@ import { TGALoader } from './loaders/image/tga_Loader.js';
         }
         return P;
     }
-    /**
-   * Fetches a texture resource from a given URL
-   * @param url - The URL from where to fetch the resource
-   * @param options - Options for texture fetching
-   * @returns The fetched texture
+    /**
+   * Fetches a texture resource from a given URL
+   * @param url - The URL from where to fetch the resource
+   * @param options - Options for texture fetching
+   * @returns The fetched texture
    */ async fetchTexture(url, options) {
         if (options?.texture) {
             return this.loadTexture(url, options.mimeType ?? null, !options.linearColorSpace, options.samplerOptions, options.texture);
@@ -149,12 +149,12 @@ import { TGALoader } from './loaders/image/tga_Loader.js';
         }
         return P;
     }
-    /**
-   * Fetches a model resource from a given URL and adds it to a scene
-   * @param scene - The scene to which the model node belongs
-   * @param url - The URL from where to fetch the resource
-   * @param mimeType - The MIME type of the model resource
-   * @returns The created model node
+    /**
+   * Fetches a model resource from a given URL and adds it to a scene
+   * @param scene - The scene to which the model node belongs
+   * @param url - The URL from where to fetch the resource
+   * @param mimeType - The MIME type of the model resource
+   * @returns The created model node
    */ async fetchModel(scene, url, mimeType) {
         const sharedModel = await this.fetchModelData(scene, url, mimeType);
         return this.createSceneNode(scene, sharedModel);
@@ -272,10 +272,10 @@ import { TGALoader } from './loaders/image/tga_Loader.js';
         }
         throw new Error(`Can not find loader for asset ${url}`);
     }
-    /**
-   * Fetches a built-in texture
-   * @param name - Name of the built-in texture
-   * @returns The built-in texture
+    /**
+   * Fetches a built-in texture
+   * @param name - Name of the built-in texture
+   * @returns The built-in texture
    */ async fetchBuiltinTexture(name, texture) {
         const loader = AssetManager._builtinTextureLoaders[name];
         if (!loader) {
@@ -346,10 +346,10 @@ import { TGALoader } from './loaders/image/tga_Loader.js';
             animationSet
         };
     }
-    /**
-   * Sets the loader for a given builtin-texture
-   * @param name - Name of the builtin texture
-   * @param loader - Loader for the builtin texture
+    /**
+   * Sets the loader for a given builtin-texture
+   * @param name - Name of the builtin texture
+   * @param loader - Loader for the builtin texture
    */ static setBuiltinTextureLoader(name, loader) {
         if (loader) {
             this._builtinTextureLoaders[name] = loader;