x_ite 8.4.3 → 8.5.3

package/docs/_posts/components/Networking/LoadSensor.md

@@ -0,0 +1,91 @@
+---
+title: LoadSensor
+date: 2022-01-07
+nav: components-Networking
+categories: [components, Networking]
+tags: [LoadSensor, Networking]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+LoadSensor generates events as watchList child nodes are either loaded or fail to load. Changing watchlist child nodes restarts the LoadSensor.
+
+The LoadSensor node belongs to the **Networking** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DSensorNode
+      + X3DNetworkSensorNode
+        + LoadSensor
+```
+
+## Fields
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### SFBool [in, out] **enabled** TRUE
+
+Enables/disables node operation.
+
+### SFTime [in, out] **timeOut**
+
+Time in seconds of maximum load duration prior to declaring failure. Default value zero means use browser defaults.
+
+### SFBool [out] **isActive**
+
+*isActive* true/false events are sent when sensing starts/stops.
+
+### SFBool [out] **isLoaded**
+
+Notify when all watchList child nodes are loaded, or at least one has failed. Sends true on successfully loading all watchList child nodes. Sends false on timeOut of any watchList child nodes, failure of any watchList child nodes to load, or no local copies available and no network present.
+
+#### Hint
+
+- Use multiple LoadSensor nodes to track multiple loading nodes individually.
+
+### SFFloat [out] **progress**
+
+Sends 0.0 on start and 1.0 on completion. Intermediate values are browser dependent and always increasing (may indicate fraction of bytes, fraction of expected time or another metric).
+
+#### Hint
+
+- Only 0 and 1 events are guaranteed.
+
+### SFTime [out] **loadTime**
+
+Time of successful load complete, not sent on failure.
+
+### MFNode [in, out] **watchList** [ ] <small>[X3DUrlObject]</small>
+
+Input/Output field watchList.
+
+## Description
+
+### Hints
+
+- Use multiple LoadSensor nodes to track multiple loading nodes individually.
+- Background is not sensed due to multiple-image ambiguity.
+- Use Inline 'load' field to prompt or defer loading.
+
+### Warnings
+
+- WatchList child nodes are not rendered, so normally USE copies of other nodes to sense load status.
+- New X3D node, not supported in VRML97.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Networking/LoadSensor/LoadSensor.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of LoadSensor](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/networking.html#LoadSensor){:target="_blank"}

package/docs/_posts/components/ParticleSystems/BoundedPhysicsModel.md

@@ -0,0 +1,54 @@
+---
+title: BoundedPhysicsModel
+date: 2022-01-07
+nav: components-ParticleSystems
+categories: [components, ParticleSystems]
+tags: [BoundedPhysicsModel, ParticleSystems]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+BoundedPhysicsModel provides user-defined geometrical boundaries for particle motion. A child geometry node specifies boundaries that constrain the location of the particles.
+
+The BoundedPhysicsModel node belongs to the **ParticleSystems** component and its default container field is *physics.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DParticlePhysicsModelNode
+    + BoundedPhysicsModel
+```
+
+## Fields
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### SFBool [in, out] **enabled** TRUE
+
+Enables/disables node operation.
+
+### SFNode [in, out] **geometry** NULL <small>[X3DGeometryNode]</small>
+
+The geometry node provides the geometry used for each particle when the parent ParticleSystem node has geometryType=GEOMETRY.
+
+#### Hint
+
+- Include `<component name='Geospatial' level='1'/>`
+
+## Description
+
+### Hint
+
+- When a particle touches the boundary surface, it is reflected by the geometry (either inside or outside).
+
+## External Links
+
+- [X3D Specification of BoundedPhysicsModel](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/particleSystems.html#BoundedPhysicsModel){:target="_blank"}

package/docs/_posts/components/ParticleSystems/ConeEmitter.md

@@ -0,0 +1,76 @@
+---
+title: ConeEmitter
+date: 2022-01-07
+nav: components-ParticleSystems
+categories: [components, ParticleSystems]
+tags: [ConeEmitter, ParticleSystems]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+ConeEmitter generates all available particles from a specific point in space. Particles are emitted from the single point specified by the position field emanating in a direction randomly distributed within the cone specified by the angle and direction fields.
+
+The ConeEmitter node belongs to the **ParticleSystems** component and its default container field is *emitter.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DParticleEmitterNode
+    + ConeEmitter
+```
+
+## Fields
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### SFVec3f [in, out] **position** 0 0 0
+
+Point from which particles emanate.
+
+### SFVec3f [in, out] **direction** 0 1 0
+
+Initial direction from which particles emanate.
+
+### SFFloat [in, out] **angle** π/4 <small>[0,π]</small>
+
+Cone boundary for random distribution of particles about initial direction.
+
+### SFFloat [in, out] **speed** 0 <small>[0,∞)</small>
+
+Initial linear speed (default is m/s) imparted to all particles along their direction of movement.
+
+### SFFloat [in, out] **variation** 0.25 <small>[0,∞)</small>
+
+Multiplier for the randomness used to control the range of possible output values. The bigger the value, the more random the output and the bigger the range of possible initial values possible.
+
+#### Hint
+
+- Variation of zero does not allow any randomness.
+
+### SFFloat [ ] **mass** 0 <small>[0,∞)</small>
+
+Field mass.
+
+### SFFloat [ ] **surfaceArea** 0 <small>[0,∞)</small>
+
+Particle surface area in area base units (default is meters squared). Surface area is used for calculations such as wind effects per particle.
+
+#### Hints
+
+- SurfaceArea value represents average frontal area presented to the wind. Assumes spherical model for each particle (i.e., surface area is the same regardless of direction).
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/ParticleSystems/ConeEmitter/ConeEmitter.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of ConeEmitter](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/particleSystems.html#ConeEmitter){:target="_blank"}

package/docs/_posts/components/ParticleSystems/ExplosionEmitter.md

@@ -0,0 +1,72 @@
+---
+title: ExplosionEmitter
+date: 2022-01-07
+nav: components-ParticleSystems
+categories: [components, ParticleSystems]
+tags: [ExplosionEmitter, ParticleSystems]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+ExplosionEmitter generates all particles from a specific point in space at the initial time enabled.
+
+The ExplosionEmitter node belongs to the **ParticleSystems** component and its default container field is *emitter.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DParticleEmitterNode
+    + ExplosionEmitter
+```
+
+## Fields
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### SFVec3f [in, out] **position** 0 0 0
+
+Point from which particles emanate.
+
+### SFFloat [in, out] **speed** 0 <small>[0,∞)</small>
+
+Initial linear speed (default is m/s) imparted to all particles along their direction of movement.
+
+### SFFloat [in, out] **variation** 0.25 <small>[0,∞)</small>
+
+Multiplier for the randomness used to control the range of possible output values. The bigger the value, the more random the output and the bigger the range of initial values possible.
+
+#### Hint
+
+- Variation of zero does not allow any randomness.
+
+### SFFloat [ ] **mass** 0 <small>[0,∞)</small>
+
+Basic mass of each particle in mass base units (default is grams).
+
+#### Hint
+
+- Mass is needed if gravity or other force-related calculations are performed per-particle.
+
+### SFFloat [ ] **surfaceArea** 0 <small>[0,∞)</small>
+
+Particle surface area in area base units (default is meters squared). Surface area is used for calculations such as wind effects per particle.
+
+#### Hints
+
+- SurfaceArea value represents average frontal area presented to the wind. Assumes spherical model for each particle (i.e., surface area is the same regardless of direction).
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/ParticleSystems/ExplosionEmitter/ExplosionEmitter.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of ExplosionEmitter](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/particleSystems.html#ExplosionEmitter){:target="_blank"}

package/docs/_posts/components/ParticleSystems/ForcePhysicsModel.md

@@ -0,0 +1,58 @@
+---
+title: ForcePhysicsModel
+date: 2022-01-07
+nav: components-ParticleSystems
+categories: [components, ParticleSystems]
+tags: [ForcePhysicsModel, ParticleSystems]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+ForcePhysicsModel applies a constant force value to the particles.
+
+The ForcePhysicsModel node belongs to the **ParticleSystems** component and its default container field is *physics.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DParticlePhysicsModelNode
+    + ForcePhysicsModel
+```
+
+## Fields
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### SFBool [in, out] **enabled** TRUE
+
+Enables/disables node operation.
+
+### SFVec3f [in, out] **force** 0 -9.8 0 <small>(∞,∞)</small>
+
+Force field indicates strength and direction of the propelling force on the particles (e.g. default is Earth's gravity).
+
+#### Hints
+
+- Force is specified in force base units (usually newtons). If particles have zero mass, ForcePhysicsModel node has no effect.
+
+## Description
+
+### Hint
+
+- Force may act in any given direction vector at any strength.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/ParticleSystems/ForcePhysicsModel/ForcePhysicsModel.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of ForcePhysicsModel](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/particleSystems.html#ForcePhysicsModel){:target="_blank"}

package/docs/_posts/components/ParticleSystems/ParticleSystem.md

@@ -0,0 +1,177 @@
+---
+title: ParticleSystem
+date: 2022-01-07
+nav: components-ParticleSystems
+categories: [components, ParticleSystems]
+tags: [ParticleSystem, ParticleSystems]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+ParticleSystem specifies a complete particle system. It can contain Appearance for particle appearance, a geometry node if gemoetryType='GEOMETRY', a colorRamp Color/ColorRGBA node for changing base color over each particle's lifetime, a texcoordRamp TextureCoordinate node to control texture coordinates of provided texture(s) in the Appearance node over time, a single emitter X3DParticleEmitterNode, and an array of physics X3DParticlePhysicsModelNode nodes.
+
+The ParticleSystem node belongs to the **ParticleSystems** component and its default container field is *children.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DShapeNode (X3DBoundedObject)*
+      + ParticleSystem
+```
+
+<small>\* Derived from multiple interfaces.</small>
+
+## Fields
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### SFBool [in, out] **enabled** TRUE
+
+Enables/disables node operation.
+
+### SFString [ ] **geometryType** "QUAD" <small>["LINE"|"POINT"|"QUAD"|"SPRITE"|"TRIANGLE"|"GEOMETRY"|...]</small>
+
+Field geometryType.
+
+### SFInt32 [in, out] **maxParticles** 200 <small>[0,∞)</small>
+
+Maximum number of particles to be generated at one time (subject to player limitations).
+
+### SFBool [in, out] **createParticles** TRUE
+
+Enables/disables creation of new particles, while any existing particles remain in existence and continue to animate until the end of their lifetimes.
+
+#### Hint
+
+- If no particles are left in scene, system is considered both active and enabled.
+
+### SFFloat [in, out] **particleLifetime** 5 <small>[0,∞)</small>
+
+TODO not properly defined in X3D spedification. Particle animation lifetime in base time units (default is seconds).
+
+### SFFloat [in, out] **lifetimeVariation** 0.25 <small>[0,1]</small>
+
+TODO not properly defined in X3D spedification. Multiplier for the randomness used to control the range of possible output values. The bigger the value, the more random the output and the bigger the range of initial values possible.
+
+#### Hint
+
+- Variation of zero does not allow any randomness.
+
+### SFVec2f [in, out] **particleSize** 0.02 0.02 <small>[0,∞)</small>
+
+*particleSize* describes width and height dimensions for each particle in length base units (default is meters). Changing this value dynamically will only change new particles created after the change.
+
+#### Hints
+
+- Particles created before this timestamp will remain at the old size. His field only effects particles using LINE, QUAD, SPRITE, and TRIANGLE geometry types.
+
+### SFNode [ ] **emitter** NULL <small>[X3DParticleEmitterNode]</small>
+
+The emitter field specifies the type of emitter geometry and properties that the particles are given for their initial positions.
+
+### MFNode [ ] **physics** [ ] <small>[X3DParticlePhysicsModelNode]</small>
+
+After being created, the individual particles are then manipulated according to the physics model(s) specified in the physics field.
+
+### MFFloat [ ] **colorKey** [ ] <small>[0,∞)</small>
+
+Array of time intervals in seconds, corresponding to particle lifetime, that are used to interpolate colorRamp array values.
+
+#### Hints
+
+- Color values are interpolated in linear Hue Saturation Value (HSV) space, similar to ColorInterpolator node. Color values are defined as per-vertex colour values. Number of colorKey values must match length of the per-vertex colorRamp arrays!
+
+#### Warning
+
+- If an Appearance and Material nodes are provided, those material properties override colorRamp interpolation.
+
+#### See Also
+
+- [X3D Scene Authoring Hints, Color](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color){:target="_blank"}
+
+### SFNode [ ] **colorRamp** NULL <small>[X3DColorNode]</small>
+
+The colorRamp Color/ColorRGBA node holds a series of colour values to be used at the given colorKey points in time.
+
+#### Hints
+
+- Color values are defined as per-vertex colour values. Number of colorKey values must match length of the per-vertex colorRamp arrays!
+
+#### Warning
+
+- If an Appearance and Material nodes are provided, those material properties override colorRamp interpolation.
+
+#### See Also
+
+- [X3D Scene Authoring Hints, Color](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color){:target="_blank"}
+
+### MFFloat [ ] **texCoordKey** [ ] <small>[0,∞)</small>
+
+Array of time intervals in seconds, corresponding to particle lifetime, that are used to sequence texCoordRamp array values.
+
+#### Hints
+
+- No interpolation is performed, texture coordinates are simply sequenced in order. Texture-coordinate values map textures to vertices in the geometry. Number of texCoordKey values must match length of the per-vertex texCoordRamp arrays!
+
+### SFNode [ ] **texCoordRamp** NULL <small>[TextureCoordinate]</small>
+
+Texture coordinates of the provided texture(s) in the Appearance node, over time. Particle systems frequently like to change the texture on a particle as it ages, yet there is no good way of accomplishing this through standard interpolators because interpolators have no concept of particle time. This pair of fields hold time-dependent values for the texture coordinates to be applied to the particle. When a particle reaches the next time stamp it moves to the next set of texture coordinates.
+
+#### Hints
+
+- Texture-coordinate values map textures to vertices in the geometry. Number of texCoordKey values must match length of the per-vertex texCoordRamp arrays!
+
+### SFBool [out] **isActive**
+
+*isActive* true/false events are sent when playback starts/stops.
+
+### SFVec3f [ ] **bboxSize** -1 -1 -1 <small>(0,∞) or -1 -1 -1</small>
+
+Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
+
+#### Hint
+
+- Can be useful for collision computations or inverse-kinematics (IK) engines.
+
+### SFVec3f [ ] **bboxCenter** 0 0 0
+
+Bounding box center: optional hint for position offset from origin of local coordinate system.
+
+### SFNode [in, out] **appearance** NULL <small>[X3DAppearanceNode]</small>
+
+The appearance field holds an Appearance node that is used for the geometry. All effects, such as material colours and/or multi-textures, are applied to each particle.
+
+#### Hints
+
+- If a texture coordinate ramp and key is supplied with this geometry, it shall be used in preference to any automatic texture coordinate generation. If automatic texture coordinate generation is used, results shall be based on the entire volume that the particles consume, not locally applied to each particle.
+
+### SFNode [in, out] **geometry** NULL <small>[X3DGeometryNode]</small>
+
+The geometry node provides geometry used for each particle when geometryType=GEOMETRY.
+
+#### Hint
+
+- Include `<component name='Geospatial' level='1'/>`
+
+## Hints
+
+- Always adjust bboxSize and boxCenter properly; bboxSize and bboxCenter cannot be automatically determined so it's up to the author to provide proper values.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/ParticleSystems/ParticleSystem/ParticleSystem.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of ParticleSystem](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/particleSystems.html#ParticleSystem){:target="_blank"}
+- [Event timing details are explained in 4.4.8.3 Execution model](https://www.web3d.org/files/specifications/19775-1/V3.3/Part01/concepts.html#ExecutionModel){:target="_blank"}
+- [Wikipedia, particle system](https://en.wikipedia.org/wiki/Particle_system){:target="_blank"}

package/docs/_posts/components/ParticleSystems/PointEmitter.md

@@ -0,0 +1,76 @@
+---
+title: PointEmitter
+date: 2022-01-07
+nav: components-ParticleSystems
+categories: [components, ParticleSystems]
+tags: [PointEmitter, ParticleSystems]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+PointEmitter generates particles from a specific point in space using the specified direction and speed.
+
+The PointEmitter node belongs to the **ParticleSystems** component and its default container field is *emitter.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DParticleEmitterNode
+    + PointEmitter
+```
+
+## Fields
+
+### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
+
+Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+
+### SFVec3f [in, out] **position** 0 0 0
+
+Point from which particles emanate.
+
+### SFVec3f [in, out] **direction** 0 1 0
+
+Initial direction from which particles emanate.
+
+### SFFloat [in, out] **speed** 0 <small>[0,∞)</small>
+
+Initial linear speed (default is m/s) imparted to all particles along their direction of movement.
+
+### SFFloat [in, out] **variation** 0.25 <small>[0,∞)</small>
+
+Multiplier for the randomness used to control the range of possible output values. The bigger the value, the more random the output and the bigger the range of possible initial values possible.
+
+#### Hint
+
+- Variation of zero does not allow any randomness.
+
+### SFFloat [ ] **mass** 0 <small>[0,∞)</small>
+
+Basic mass of each particle in mass base units (default is grams).
+
+#### Hint
+
+- Mass is needed if gravity or other force-related calculations are performed per-particle.
+
+### SFFloat [ ] **surfaceArea** 0 <small>[0,∞)</small>
+
+Particle surface area in area base units (default is meters squared). Surface area is used for calculations such as wind effects per particle.
+
+#### Hints
+
+- SurfaceArea value represents average frontal area presented to the wind. Assumes spherical model for each particle (i.e., surface area is the same regardless of direction).
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/ParticleSystems/PointEmitter/PointEmitter.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of PointEmitter](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/particleSystems.html#PointEmitter){:target="_blank"}