@zephyr3d/scene 0.1.0 → 0.1.1

package/dist/render/cull_visitor.js

@@ -3,21 +3,21 @@ import { OctreeNode } from '../scene/octree.js';
 import { RENDER_PASS_TYPE_SHADOWMAP } from '../values.js';
 import { GraphNode } from '../scene/graph_node.js';
 
-/**
- * Node visitor for culling
- * @public
+/**
+ * Node visitor for culling
+ * @public
  */ class CullVisitor {
     /** @internal */ _primaryCamera;
     /** @internal */ _camera;
     /** @internal */ _skipClipTest;
     /** @internal */ _renderQueue;
     /** @internal */ _renderPass;
-    /**
-   * Creates an instance of CullVisitor
-   * @param renderPass - Render pass for the culling task
-   * @param camera - Camera that will be used for culling
-   * @param rendeQueue - RenderQueue
-   * @param viewPoint - Camera position of the primary render pass
+    /**
+   * Creates an instance of CullVisitor
+   * @param renderPass - Render pass for the culling task
+   * @param camera - Camera that will be used for culling
+   * @param rendeQueue - RenderQueue
+   * @param viewPoint - Camera position of the primary render pass
    */ constructor(renderPass, camera, renderQueue, primaryCamera){
         this._primaryCamera = primaryCamera;
         this._camera = camera;
@@ -46,9 +46,9 @@ import { GraphNode } from '../scene/graph_node.js';
     /** @internal */ push(camera, drawable, renderOrder) {
         this.renderQueue.push(camera, drawable, renderOrder);
     }
-    /**
-   * Visits a node
-   * @param target - The node to be visit
+    /**
+   * Visits a node
+   * @param target - The node to be visit
    */ visit(target) {
         if (target instanceof OctreeNode) {
             return this.visitOctreeNode(target);

package/dist/render/depth_pass.js

@@ -4,15 +4,15 @@ import { ShaderFramework } from '../shaders/framework.js';
 import '@zephyr3d/device';
 import { Application } from '../app.js';
 
-/**
- * Depth render pass
- *
- * Scene depth render pass
- *
- * @public
+/**
+ * Depth render pass
+ *
+ * Scene depth render pass
+ *
+ * @public
  */ class DepthRenderPass extends RenderPass {
-    /**
-   * Creates an instance of DepthRenderPass
+    /**
+   * Creates an instance of DepthRenderPass
    */ constructor(){
         super(RENDER_PASS_TYPE_DEPTH_ONLY);
     }

package/dist/render/envlight.js

@@ -1,50 +1,50 @@
 import { Vector4 } from '@zephyr3d/base';
 import { Application } from '../app.js';
 
-/**
- * Base class for any kind of environment light
- * @public
+/**
+ * Base class for any kind of environment light
+ * @public
  */ class EnvironmentLighting {
-    /**
-   * Whether this is an instance of EnvIBL
-   * @returns true if this is an instance of EnvIBL
+    /**
+   * Whether this is an instance of EnvIBL
+   * @returns true if this is an instance of EnvIBL
    */ isIBL() {
         return false;
     }
-    /**
-   * Whether this is an instance of EnvConstantAmbient
-   * @returns true if this is an instance of EnvConstantAmbient
+    /**
+   * Whether this is an instance of EnvConstantAmbient
+   * @returns true if this is an instance of EnvConstantAmbient
    */ isConstant() {
         return false;
     }
-    /**
-   * Whether this is an instance of EnvHemisphericAmbient
-   * @returns true if this is an instance of EnvHemisphericAmbient
+    /**
+   * Whether this is an instance of EnvHemisphericAmbient
+   * @returns true if this is an instance of EnvHemisphericAmbient
    */ isHemispheric() {
         return false;
     }
 }
-/**
- * IBL based environment lighting
- * @public
+/**
+ * IBL based environment lighting
+ * @public
  */ class EnvIBL extends EnvironmentLighting {
     /** @internal */ static USAGE_IBL_RADIANCE_MAP = 'usage_ibl_radiance_map';
     /** @internal */ static USAGE_IBL_RADIANCE_MAP_MAX_LOD = 'usage_ibl_radiance_map_maxlod';
     /** @internal */ static USAGE_IBL_IRRADIANCE_MAP = 'usage_ibl_irradiance_map';
     /** @internal */ _radianceMap;
     /** @internal */ _irradianceMap;
-    /**
-   * Creates an instance of EnvIBL
-   * @param radianceMap - The radiance map
-   * @param irradianceMap - The irradiance map
+    /**
+   * Creates an instance of EnvIBL
+   * @param radianceMap - The radiance map
+   * @param irradianceMap - The irradiance map
    */ constructor(radianceMap, irradianceMap){
         super();
         this._radianceMap = radianceMap || null;
         this._irradianceMap = irradianceMap || null;
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.getType}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.getType}
+   * @override
    */ getType() {
         return 'ibl';
     }
@@ -60,9 +60,9 @@ import { Application } from '../app.js';
     set irradianceMap(tex) {
         this._irradianceMap = tex;
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.initShaderBindings}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.initShaderBindings}
+   * @override
    */ initShaderBindings(pb) {
         if (pb.shaderKind === 'fragment') {
             pb.getGlobalScope().iblRadianceMap = pb.texCube().uniform(0).tag(EnvIBL.USAGE_IBL_RADIANCE_MAP);
@@ -70,9 +70,9 @@ import { Application } from '../app.js';
             pb.getGlobalScope().radianceMaxLod = pb.float('radianceMaxLod').uniform(0).tag(EnvIBL.USAGE_IBL_RADIANCE_MAP_MAX_LOD);
         }
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.updateBindGroup}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.updateBindGroup}
+   * @override
    */ updateBindGroup(bg) {
         if (this._radianceMap) {
             bg.setValue('radianceMaxLod', this._radianceMap.mipLevelCount - 1);
@@ -82,49 +82,49 @@ import { Application } from '../app.js';
             bg.setTexture('iblIrradianceMap', this._irradianceMap);
         }
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.getRadiance}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.getRadiance}
+   * @override
    */ getRadiance(scope, refl, roughness) {
         const pb = scope.$builder;
         return Application.instance.device.getDeviceCaps().shaderCaps.supportShaderTextureLod ? pb.textureSampleLevel(scope.iblRadianceMap, refl, pb.mul(roughness, scope.radianceMaxLod)).rgb : pb.textureSample(scope.iblRadianceMap, refl).rgb;
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.getIrradiance}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.getIrradiance}
+   * @override
    */ getIrradiance(scope, normal) {
         const pb = scope.$builder;
         return pb.textureSampleLevel(scope.iblIrradianceMap, normal, 0).rgb;
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.hasRadiance}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.hasRadiance}
+   * @override
    */ hasRadiance() {
         return !!this._radianceMap;
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.hasIrradiance}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.hasIrradiance}
+   * @override
    */ hasIrradiance() {
         return !!this._irradianceMap;
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.isIBL}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.isIBL}
+   * @override
    */ isIBL() {
         return true;
     }
 }
-/**
- * Constant ambient light
- * @public
+/**
+ * Constant ambient light
+ * @public
  */ class EnvConstantAmbient extends EnvironmentLighting {
     /** @internal */ static USAGE_CONSTANT_AMBIENT_LIGHTING = 'usage_env_constant_ambient';
     /** @internal */ static funcNameGetAmbient = 'lib_getConstantAmbient';
     /** @internal */ _ambientColor;
-    /**
-   * Creates an instance of EnvConstantAmbient
-   * @param ambientColor - The ambient color
+    /**
+   * Creates an instance of EnvConstantAmbient
+   * @param ambientColor - The ambient color
    */ constructor(ambientColor){
         super();
         this._ambientColor = ambientColor ? new Vector4(ambientColor) : new Vector4(0, 0, 0, 1);
@@ -137,70 +137,70 @@ import { Application } from '../app.js';
             this._ambientColor.set(ambientColor);
         }
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.getType}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.getType}
+   * @override
    */ getType() {
         return 'constant';
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.initShaderBindings}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.initShaderBindings}
+   * @override
    */ initShaderBindings(pb) {
         if (pb.shaderKind === 'fragment') {
             pb.getGlobalScope().ambientLight = pb.vec4().uniform(0).tag(EnvConstantAmbient.USAGE_CONSTANT_AMBIENT_LIGHTING);
         }
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.updateBindGroup}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.updateBindGroup}
+   * @override
    */ updateBindGroup(bg) {
         bg.setValue('ambientLight', this._ambientColor);
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.getRadiance}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.getRadiance}
+   * @override
    */ getRadiance(scope, refl, roughness) {
         return null;
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.getIrradiance}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.getIrradiance}
+   * @override
    */ getIrradiance(scope, normal) {
         return scope.ambientLight.rgb;
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.hasRadiance}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.hasRadiance}
+   * @override
    */ hasRadiance() {
         return false;
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.hasIrradiance}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.hasIrradiance}
+   * @override
    */ hasIrradiance() {
         return true;
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.isConstant}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.isConstant}
+   * @override
    */ isConstant() {
         return true;
     }
 }
-/**
- * Hemispheric ambient light
- * @public
+/**
+ * Hemispheric ambient light
+ * @public
  */ class EnvHemisphericAmbient extends EnvironmentLighting {
     /** @internal */ static USAGE_CONSTANT_AMBIENT_UP = 'usage_env_ambient_up';
     /** @internal */ static USAGE_CONSTANT_AMBIENT_DOWN = 'usage_env_ambient_down';
     /** @internal */ static funcNameGetAmbient = 'lib_getConstantAmbient';
     /** @internal */ _ambientUp;
     /** @internal */ _ambientDown;
-    /**
-   * Creates an instance of EnvConstantAmbient
-   * @param ambientUp - The upside ambient color
-   * @param ambientDown - The downside ambient color
+    /**
+   * Creates an instance of EnvConstantAmbient
+   * @param ambientUp - The upside ambient color
+   * @param ambientDown - The downside ambient color
    */ constructor(ambientUp, ambientDown){
         super();
         this._ambientUp = new Vector4(ambientUp);
@@ -222,57 +222,57 @@ import { Application } from '../app.js';
             this._ambientDown.set(color);
         }
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.getType}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.getType}
+   * @override
    */ getType() {
         return 'hemisphere';
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.initShaderBindings}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.initShaderBindings}
+   * @override
    */ initShaderBindings(pb) {
         if (pb.shaderKind === 'fragment') {
             pb.getGlobalScope().ambientUp = pb.vec4().uniform(0).tag(EnvHemisphericAmbient.USAGE_CONSTANT_AMBIENT_UP);
             pb.getGlobalScope().ambientDown = pb.vec4().uniform(0).tag(EnvHemisphericAmbient.USAGE_CONSTANT_AMBIENT_DOWN);
         }
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.updateBindGroup}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.updateBindGroup}
+   * @override
    */ updateBindGroup(bg) {
         bg.setValue('ambientUp', this._ambientUp);
         bg.setValue('ambientDown', this._ambientDown);
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.getRadiance}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.getRadiance}
+   * @override
    */ getRadiance(scope, refl, roughness) {
         return null;
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.getIrradiance}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.getIrradiance}
+   * @override
    */ getIrradiance(scope, normal) {
         const pb = scope.$builder;
         const factor = pb.add(pb.mul(normal.y, 0.5), 0.5);
         return pb.mix(scope.ambientDown, scope.ambientUp, factor).rgb;
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.hasRadiance}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.hasRadiance}
+   * @override
    */ hasRadiance() {
         return false;
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.hasIrradiance}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.hasIrradiance}
+   * @override
    */ hasIrradiance() {
         return true;
     }
-    /**
-   * {@inheritDoc EnvironmentLighting.isHemispheric}
-   * @override
+    /**
+   * {@inheritDoc EnvironmentLighting.isHemispheric}
+   * @override
    */ isHemispheric() {
         return true;
     }

package/dist/render/render_queue.js

@@ -1,17 +1,17 @@
 import { Application } from '../app.js';
 
-/**
- * A queue that contains the items to be rendered
- * @public
+/**
+ * A queue that contains the items to be rendered
+ * @public
  */ class RenderQueue {
     /** @internal */ _itemLists;
     /** @internal */ _renderPass;
     /** @internal */ _shadowedLightList;
     /** @internal */ _unshadowedLightList;
     /** @internal */ _sunLight;
-    /**
-   * Creates an instance of a render queue
-   * @param renderPass - The render pass to which the render queue belongs
+    /**
+   * Creates an instance of a render queue
+   * @param renderPass - The render pass to which the render queue belongs
    */ constructor(renderPass){
         this._itemLists = {};
         this._renderPass = renderPass;
@@ -28,32 +28,32 @@ import { Application } from '../app.js';
     /** The render pass to which the render queue belongs */ get renderPass() {
         return this._renderPass;
     }
-    /**
-   * Gets the items of the render queue
+    /**
+   * Gets the items of the render queue
    */ get items() {
         return this._itemLists;
     }
-    /**
-   * Gets the shadowed lights
+    /**
+   * Gets the shadowed lights
    */ get shadowedLights() {
         return this._shadowedLightList;
     }
-    /**
-   * Gets the unshadowed lights
+    /**
+   * Gets the unshadowed lights
    */ get unshadowedLights() {
         return this._unshadowedLightList;
     }
-    /**
-   * Gets the maximum batch size of a given device
-   * @returns The maximum batch size of the device
-   *
-   * @internal
+    /**
+   * Gets the maximum batch size of a given device
+   * @returns The maximum batch size of the device
+   *
+   * @internal
    */ getMaxBatchSize() {
         return Application.instance.device.getDeviceCaps().shaderCaps.maxUniformBufferSize / 64;
     }
-    /**
-   * Push a punctual light
-   * @param light - The light to be pushed
+    /**
+   * Push a punctual light
+   * @param light - The light to be pushed
    */ pushLight(light) {
         if (light.castShadow) {
             this._shadowedLightList.push(light);
@@ -64,11 +64,11 @@ import { Application } from '../app.js';
             this.sunLight = light;
         }
     }
-    /**
-   * Push an item to the render queue
-   * @param camera - The camera for drawing the item
-   * @param drawable - The object to be drawn
-   * @param renderOrder - Render order of the object
+    /**
+   * Push an item to the render queue
+   * @param camera - The camera for drawing the item
+   * @param drawable - The object to be drawn
+   * @param renderOrder - Render order of the object
    */ push(camera, drawable, renderOrder) {
         if (drawable) {
             let itemList = this._itemLists[renderOrder];
@@ -111,16 +111,16 @@ import { Application } from '../app.js';
             }
         }
     }
-    /**
-   * Removes all items in the render queue
+    /**
+   * Removes all items in the render queue
    */ clear() {
         this._itemLists = {};
         this._shadowedLightList = [];
         this._unshadowedLightList = [];
         this._sunLight = null;
     }
-    /**
-   * Sorts the items in the render queue for rendering
+    /**
+   * Sorts the items in the render queue for rendering
    */ sortItems() {
         for (const list of Object.values(this._itemLists)){
             list.opaqueList.sort((a, b)=>a.sortDistance - b.sortDistance);
@@ -133,10 +133,10 @@ import { Application } from '../app.js';
         outColor[2] = (index >> 8 && 255) / 255;
         outColor[3] = (index >> 0 && 255) / 255;
     }
-    /*
-  private decodeInstanceColor(value: Float32Array): number {
-    return (value[0] << 24) + (value[1] << 16) + (value[2] << 8) + value[3];
-  }
+    /*
+  private decodeInstanceColor(value: Float32Array): number {
+    return (value[0] << 24) + (value[1] << 16) + (value[2] << 8) + value[3];
+  }
   */ setInstanceColors() {
         const nodes = [];
         let id = 0;

package/dist/render/renderpass.js

@@ -11,18 +11,18 @@ import '../material/unlit.js';
 import '../material/lightmodel.js';
 import { RenderQueue } from './render_queue.js';
 
-/**
- * Base class for any kind of render passes
- * @public
+/**
+ * Base class for any kind of render passes
+ * @public
  */ class RenderPass {
     /** @internal */ _type;
     /** @internal */ _globalBindGroups;
     /** @internal */ _clearColor;
     /** @internal */ _clearDepth;
     /** @internal */ _clearStencil;
-    /**
-   * Creates an instanceof RenderPass
-   * @param type - Render pass type
+    /**
+   * Creates an instanceof RenderPass
+   * @param type - Render pass type
    */ constructor(type){
         this._type = type;
         this._clearColor = new Vector4(0, 0, 0, 1);
@@ -48,17 +48,17 @@ import { RenderQueue } from './render_queue.js';
     set clearStencil(stencil) {
         this._clearStencil = stencil ?? null;
     }
-    /**
-   * The render pass type
+    /**
+   * The render pass type
    */ get type() {
         return this._type;
     }
     /** @internal */ isAutoFlip() {
         return !!(Application.instance.device.getFramebuffer() && Application.instance.device.type === 'webgpu');
     }
-    /**
-   * Renders a scene
-   * @param ctx - Drawing context
+    /**
+   * Renders a scene
+   * @param ctx - Drawing context
    */ render(ctx, cullCamera, renderQueue) {
         ctx.renderPass = this;
         this.drawScene(ctx, cullCamera ?? ctx.camera, renderQueue);
@@ -92,8 +92,8 @@ import { RenderQueue } from './render_queue.js';
         }
         return bindGroup;
     }
-    /**
-   * Disposes the render pass
+    /**
+   * Disposes the render pass
    */ dispose() {
         for(const k in this._globalBindGroups){
             Material.bindGroupGarbageCollect(this._globalBindGroups[k].bindGroup);
@@ -114,11 +114,11 @@ import { RenderQueue } from './render_queue.js';
             device.reverseVertexWindingOrder(windingReversed);
         }
     }
-    /**
-   * Culls a scene by a given camera
-   * @param ctx - The draw context
-   * @param cullCamera - The camera that will be used to cull the scene
-   * @returns The cull result
+    /**
+   * Culls a scene by a given camera
+   * @param ctx - The draw context
+   * @param cullCamera - The camera that will be used to cull the scene
+   * @returns The cull result
    */ cullScene(ctx, cullCamera) {
         if (cullCamera) {
             const renderQueue = new RenderQueue(this);

package/dist/render/renderscheme.js

@@ -1,14 +1,14 @@
 import { Application } from '../app.js';
 
-/**
- * Base class for any kind of render scheme
- * @public
+/**
+ * Base class for any kind of render scheme
+ * @public
  */ class RenderScheme {
     /** @internal */ _shadowMapFormat;
     /** @internal */ _enableDepthPass;
     /** @internal */ _currentScene;
-    /**
-   * Creates an instance of RenderScheme
+    /**
+   * Creates an instance of RenderScheme
    */ constructor(){
         this._shadowMapFormat = null;
         this._enableDepthPass = false;
@@ -23,10 +23,10 @@ import { Application } from '../app.js';
     /** The scene that is currently been rendered */ get currentScene() {
         return this._currentScene;
     }
-    /**
-   * Renders a scene by given camera
-   * @param scene - The scene to be rendered
-   * @param camera - The camera that will be used to render the scene
+    /**
+   * Renders a scene by given camera
+   * @param scene - The scene to be rendered
+   * @param camera - The camera that will be used to render the scene
    */ renderScene(scene, camera, compositor) {
         this._currentScene = scene;
         const ctx = {
@@ -40,14 +40,14 @@ import { Application } from '../app.js';
         }
         this._currentScene = null;
     }
-    /**
-   * Disposes the render scheme
+    /**
+   * Disposes the render scheme
    */ dispose() {
         this._dispose();
     }
-    /**
-   * Gets the texture format for shadow maps
-   * @returns Texture format for shadow maps
+    /**
+   * Gets the texture format for shadow maps
+   * @returns Texture format for shadow maps
    */ getShadowMapFormat() {
         if (!this._shadowMapFormat) {
             const device = Application.instance.device;