x_ite 8.4.3 → 8.5.3

package/docs/_posts/components/RigidBodyPhysics/SingleAxisHingeJoint.md

@@ -0,0 +1,108 @@
+---
+title: SingleAxisHingeJoint
+date: 2022-01-07
+nav: components-RigidBodyPhysics
+categories: [components, RigidBodyPhysics]
+tags: [SingleAxisHingeJoint, RigidBodyPhysics]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+SingleAxisHingeJoint has single axis about which to rotate, similar to a traditional door hinge. Contains two RigidBody nodes (containerField values body1, body2).
+
+The SingleAxisHingeJoint node belongs to the **RigidBodyPhysics** component and its default container field is *joints.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DRigidJointNode
+    + SingleAxisHingeJoint
+```
+
+## 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.
+
+### MFString [in, out] **forceOutput** "NONE" <small>["ALL","NONE",...]</small>
+
+*forceOutput* controls which output fields are generated for the next frame. Values are ALL, NONE, or exact names of output fields updated at start of next frame.
+
+### SFVec3f [in, out] **anchorPoint** 0 0 0
+
+*anchorPoint* is joint center, specified in world coordinates.
+
+### SFVec3f [in, out] **axis** 0 0 0
+
+*axis* defines vector of joint connection between body1 and body2.
+
+### SFFloat [in, out] **minAngle** [-π,π)<small> <span class="red">not supported</span></small>
+
+*minAngle* is minimum rotation angle for hinge.
+
+### SFFloat [in, out] **maxAngle** [-π,π) <small class="small"><span class="red">not supported</span></small>
+
+*maxAngle* is maximum rotation angle for hinge.
+
+### SFFloat [in, out] **stopBounce** 0 <small>[0,1] <span class="red">not supported</span>
+</small>
+
+StopBounce is velocity factor for bounce back once stop point is reached.
+
+#### Hint
+
+- 0 means no bounce, 1 means return velocity matches.
+
+### SFFloat [in, out] **stopErrorCorrection** 0.8 <small>[0,1] <span class="red">not supported</span>
+</small>
+
+StopErrorCorrection is fraction of error correction performed during time step once stop point is reached.
+
+#### Hint
+
+- 0 means no error correction, 1 means all error corrected in single step.
+
+### SFVec3f [out] **body1AnchorPoint**
+
+Output field body1AnchorPoint.
+
+### SFVec3f [out] **body2AnchorPoint**
+
+Output field body2AnchorPoint.
+
+### SFFloat [out] **angle**
+
+Output field angle.
+
+### SFFloat [out] **angleRate**
+
+Output field angleRate.
+
+### SFNode [in, out] **body1** NULL <small>[RigidBody]</small>
+
+Input/Output field body1.
+
+### SFNode [in, out] **body2** NULL <small>[RigidBody]</small>
+
+Input/Output field body2.
+
+## Description
+
+### Hint
+
+- RigidBodyPhysics component, level 2.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/RigidBodyPhysics/SingleAxisHingeJoint/SingleAxisHingeJoint.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of SingleAxisHingeJoint](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/rigidBodyPhysics.html#SingleAxisHingeJoint){:target="_blank"}

package/docs/_posts/components/RigidBodyPhysics/SliderJoint.md

@@ -0,0 +1,106 @@
+---
+title: SliderJoint
+date: 2022-01-07
+nav: components-RigidBodyPhysics
+categories: [components, RigidBodyPhysics]
+tags: [SliderJoint, RigidBodyPhysics]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+SliderJoint constrains all movement between body1 and body2 along a single axis. Contains two RigidBody nodes (containerField values body1, body2).
+
+The SliderJoint node belongs to the **RigidBodyPhysics** component and its default container field is *joints.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DRigidJointNode
+    + SliderJoint
+```
+
+## 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.
+
+### MFString [in, out] **forceOutput** "NONE" <small>["ALL","NONE",...]</small>
+
+*forceOutput* controls which output fields are generated for the next frame. Values are ALL, NONE, or exact names of output fields updated at start of next frame.
+
+### SFVec3f [in, out] **axis** 0 1 0
+
+*axis* is normalized vector specifying direction of motion.
+
+### SFFloat [in, out] **minSeparation** 0 <small>[0,∞)</small>
+
+*minSeparation* is minimum separation distance between the two bodies.
+
+#### Hint
+
+- If (minSeparation is less than maxSeparation) then no stop is effective.
+
+### SFFloat [in, out] **maxSeparation** 1 <small>[0,∞)</small>
+
+*maxSeparation* is maximum separation distance between the two bodies.
+
+#### Hint
+
+- If (minSeparation is less than maxSeparation) then no stop is effective.
+
+### SFFLoat [in, out] **sliderForce** 0 <span class="red"><small class="small">not supported</small></span>
+
+Input/Output field sliderForce.
+
+### SFFloat [in, out] **stopBounce** 0 <small>[0,1] <span class="red">not supported</span></small>
+
+*stopBounce* is velocity factor for bounce back once stop point is reached.
+
+#### Hint
+
+- 0 means no bounce, 1 means return velocity matches.
+
+### SFFloat [in, out] **stopErrorCorrection** 1 <small>[0,1] <span class="red">not supported</span></small>
+
+*stopErrorCorrection* is fraction of error correction performed during time step once stop point is reached.
+
+#### Hint
+
+- 0 means no error correction, 1 means all error corrected in single step.
+
+### SFFloat [out] **separation** <span class="red"><small class="small">not supported</small></span>
+
+*separation* indicates final separation distance between the two bodies.
+
+### SFFloat [out] **separationRate** <span class="red"><small class="small">not supported</small></span>
+
+*separationRate* indicates change in separation distance over time between the two bodies.
+
+### SFNode [in, out] **body1** NULL <small>[RigidBody]</small>
+
+Input/Output field body1.
+
+### SFNode [in, out] **body2** NULL <small>[RigidBody]</small>
+
+Input/Output field body2.
+
+## Description
+
+### Hint
+
+- RigidBodyPhysics component, level 2.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/RigidBodyPhysics/SliderJoint/SliderJoint.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of SliderJoint](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/rigidBodyPhysics.html#SliderJoint){:target="_blank"}

package/docs/_posts/components/RigidBodyPhysics/UniversalJoint.md

@@ -0,0 +1,119 @@
+---
+title: UniversalJoint
+date: 2022-01-07
+nav: components-RigidBodyPhysics
+categories: [components, RigidBodyPhysics]
+tags: [UniversalJoint, RigidBodyPhysics]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+UniversalJoint is like a BallJoint that constrains an extra degree of rotational freedom. Contains two RigidBody nodes (containerField values body1, body2).
+
+The UniversalJoint node belongs to the **RigidBodyPhysics** component and its default container field is *joints.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DRigidJointNode
+    + UniversalJoint
+```
+
+## 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.
+
+### MFString [in, out] **forceOutput** "NONE" <small>["ALL","NONE",...]</small>
+
+*forceOutput* controls which output fields are generated for the next frame. Values are ALL, NONE, or exact names of output fields updated at start of next frame.
+
+### SFVec3f [in, out] **anchorPoint** 0 0 0
+
+*anchorPoint* is joint center, specified in world coordinates.
+
+### SFVec3f [in, out] **axis1** 0 0 0
+
+*axis1* defines axis vector of joint connection to body1.
+
+#### Hint
+
+- 0 0 0 means motor disabled.
+
+### SFVec3f [in, out] **axis2** 0 0 0
+
+*axis2* defines axis vector of joint connection to body2.
+
+#### Hint
+
+- 0 0 0 means motor disabled.
+
+### SFFloat [in, out] **stop1Bounce** 0 <small>[0,1]</small>
+
+Input/Output field stop1Bounce.
+
+### SFFloat [in, out] **stop2Bounce** 0 <small>[0,1]</small>
+
+*stop2Bounce* is velocity factor for bounce back once stop point is reached.
+
+#### Hint
+
+- 0 means no bounce, 1 means return velocity matches.
+
+### SFFloat [in, out] **stop1ErrorCorrection** 0.8 <small>[0,1]</small>
+
+*stop1ErrorCorrection* is fraction of error correction performed during time step once stop point is reached.
+
+#### Hint
+
+- 0 means no error correction, 1 means all error corrected in single step.
+
+### SFFloat [in, out] **stop2ErrorCorrection** 0.8 <small>[0,1]</small>
+
+*stop2ErrorCorrection* is fraction of error correction performed during time step once stop point is reached.
+
+#### Hint
+
+- 0 means no error correction, 1 means all error corrected in single step.
+
+### SFVec3f [out] **body1AnchorPoint**
+
+Output field body1AnchorPoint.
+
+### SFVec3f [out] **body2AnchorPoint**
+
+Output field body2AnchorPoint.
+
+### SFVec3f [out] **body1Axis**
+
+Output field body1Axis.
+
+### SFVec3f [out] **body2Axis**
+
+Output field body2Axis.
+
+### SFNode [in, out] **body1** NULL <small>[RigidBody]</small>
+
+Input/Output field body1.
+
+### SFNode [in, out] **body2** NULL <small>[RigidBody]</small>
+
+Input/Output field body2.
+
+## Description
+
+### Hints
+
+- Useful in combination with BallJoint.
+- RigidBodyPhysics component, level 2.
+
+## External Links
+
+- [X3D Specification of UniversalJoint](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/rigidBodyPhysics.html#UniversalJoint){:target="_blank"}

package/docs/_posts/components/Scripting/Script.md

@@ -0,0 +1,81 @@
+---
+title: Script
+date: 2022-01-07
+nav: components-Scripting
+categories: [components, Scripting]
+tags: [Script, Scripting]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+Script provides programmed behavior for a scene. Define the script interface with `<field>` elements. Scripting code is embedded in a child CDATA node or (deprecated) in the url field. Optionally supported programming languages: ECMAScript (JavaScript) and (via url to a myNode.class file) Java.
+
+The Script node belongs to the **Scripting** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DScriptNode (X3DURLObject)*
+      + Script
+```
+
+<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.
+
+### MFString [in, out] **url** [ ] <small>[URI]</small>
+
+Points to a script file url. Also (as deprecated alternative to CDATA block) can contain ecmascript: source as a quoted SFString within the url array.
+
+#### Hint
+
+- If Script contains both external url reference and internal CDATA source then external url takes precedence, but will fall back to contained CDATA source if no external script is found.
+
+#### Warnings
+
+- Do not use the ecmascript: protocol prefix within external script files. Replace javascript: or vrmlscript: protocol prefix with ecmascript: for source code embedded within an X3D scene.
+
+#### See Also
+
+- [ECMAScript is the ISO standard version of JavaScript.](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#JavaScript){:target="_blank"}
+- [VrmlScript was a subset of JavaScript originally proposed for use with VRML 97.](https://www.bitmanagement.com/developer/spec/vrmlscript/vrmlscript.html){:target="_blank"}
+- [X3D Scene Authoring Hints, urls](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls){:target="_blank"}
+
+### SFBool [ ] **directOutput** FALSE
+
+Set directOutput true if Script has field reference(s) of type SFNode/MFNode, and also uses direct access to modify attributes of a referenced node in the Scene.
+
+#### Hints
+
+- Set directOutput true if Script dynamically establishes or breaks ROUTEs. DirectOutput is a browser hint to avoid overoptimizing referenced nodes, since the Script may change their attribute values without ROUTEd events. DirectOutput false means Script cannot modify referenced nodes or change ROUTEs.
+
+### SFBool [ ] **mustEvaluate** FALSE
+
+If mustEvaluate false, then browser may delay sending input events to Script until outputs are needed. If mustEvaluate true, then Script must receive input events immediately without browser delays.
+
+#### Hint
+
+- Set mustEvaluate true when sending/receiving values via the network.
+
+## Description
+
+### Hints
+
+- Insert a CDATA node to contain source code embedded within an X3D scene.
+- CDATA blocks can protect literal characters (such as &amp; '<' and '>') in source code from unintended escape-character modifications by XML parsers.
+
+## External Links
+
+- [X3D Specification of Script](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/scripting.html#Script){:target="_blank"}
+- [X3D Scene Authoring Hints, Scripts](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scripts){:target="_blank"}

package/docs/_posts/components/Shaders/ComposedShader.md

@@ -0,0 +1,81 @@
+---
+title: ComposedShader
+date: 2022-01-07
+nav: components-Shaders
+categories: [components, Shaders]
+tags: [ComposedShader, Shaders]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+ComposedShader defines a shader where the individual source files are assembled from contained ShaderPart program sections. All access to shading capabilities is defined through a single interface that applies to all parts.
+
+The ComposedShader node belongs to the **Shaders** component and its default container field is *shaders.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DAppearanceChildNode
+    + X3DShaderNode
+      + ComposedShader (X3DProgrammableShaderObject)*
+```
+
+<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] **activate**
+
+*activate* forces the shader to activate the contained objects.
+
+### SFBool [out] **isSelected**
+
+*isSelected* indicates this shader instance is selected for use by browser
+
+### SFBool [out] **isValid**
+
+*isValid* indicates whether current shader objects can be run as a shader program.
+
+### SFString [ ] **language** "" <small>["Cg"|"GLSL"|"HLSL"|...]</small>
+
+The language field indicates to the X3D player which shading language is used. The language field may be used to optionally determine the language type if no MIME-type information is available.
+
+#### Hint
+
+- Recognized values include "CG" "GLSL" "HLSL" "FX"
+
+#### See Also
+
+- [Relates to Internationalization (i18n)](https://www.w3.org/standards/webdesign/i18n){:target="_blank"}
+
+### MFNode [in, out] **parts** [ ] <small>[ShaderPart]</small>
+
+Input/Output field parts.
+
+## Description
+
+### Hint
+
+- ComposedShader contains field definitions, IS/connect, and `<ShaderPart containerField='parts'/>` nodes.
+
+### Warning
+
+- ComposedShader can contain field declarations, but no CDATA section of plain-text source code. All source programs are contained in child ShaderPart nodes.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Shaders/ComposedShader/ComposedShader.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of ComposedShader](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shaders.html#ComposedShader){:target="_blank"}

package/docs/_posts/components/Shaders/FloatVertexAttribute.md

@@ -0,0 +1,65 @@
+---
+title: FloatVertexAttribute
+date: 2022-01-07
+nav: components-Shaders
+categories: [components, Shaders]
+tags: [FloatVertexAttribute, Shaders]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+FloatVertexAttribute defines a set of per-vertex single-precision floating-point attributes.
+
+The FloatVertexAttribute node belongs to the **Shaders** component and its default container field is *attrib.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DGeometricPropertyNode
+    + X3DVertexAttributeNode
+      + FloatVertexAttribute
+```
+
+## 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.
+
+### SFString [ ] **name** ""
+
+Required name for this particular VertexAttribute instance.
+
+#### Warning
+
+- Name is not specified if this instance is a USE node.
+
+### SFInt32 [ ] **numComponents** 4 <small>[1..4]</small>
+
+*numComponents* pecifies how many consecutive floating-point values should be grouped together per vertex.
+
+#### Hint
+
+- The length of the value field shall be a multiple of numComponents.
+
+### MFFloat [in, out] **value** [ ] <small>(-∞,∞)</small>
+
+*value* specifies an arbitrary collection of floating-point values that will be passed to the shader as per-vertex information.
+
+#### Hint
+
+- The length of the value field shall be a multiple of numComponents.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Shaders/FloatVertexAttribute/FloatVertexAttribute.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of FloatVertexAttribute](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shaders.html#FloatVertexAttribute){:target="_blank"}

package/docs/_posts/components/Shaders/Matrix3VertexAttribute.md

@@ -0,0 +1,53 @@
+---
+title: Matrix3VertexAttribute
+date: 2022-01-07
+nav: components-Shaders
+categories: [components, Shaders]
+tags: [Matrix3VertexAttribute, Shaders]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+Matrix3VertexAttribute defines a set of per-vertex 3x3 matrix attributes.
+
+The Matrix3VertexAttribute node belongs to the **Shaders** component and its default container field is *attrib.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DGeometricPropertyNode
+    + X3DVertexAttributeNode
+      + Matrix3VertexAttribute
+```
+
+## 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.
+
+### SFString [ ] **name** ""
+
+Required name for this particular VertexAttribute instance.
+
+#### Warning
+
+- Name is not specified if this instance is a USE node.
+
+### MFMatrix3f [in, out] **value** [ ] <small>(-∞,∞)</small>
+
+*value* specifies an arbitrary collection of matrix values that will be passed to the shader as per-vertex information.
+
+#### Hint
+
+- The length of the value field shall be a multiple of numComponents.
+
+## External Links
+
+- [X3D Specification of Matrix3VertexAttribute](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shaders.html#Matrix3VertexAttribute){:target="_blank"}

package/docs/_posts/components/Shaders/Matrix4VertexAttribute.md

@@ -0,0 +1,53 @@
+---
+title: Matrix4VertexAttribute
+date: 2022-01-07
+nav: components-Shaders
+categories: [components, Shaders]
+tags: [Matrix4VertexAttribute, Shaders]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+Matrix4VertexAttribute defines a set of per-vertex 4x4 matrix attributes.
+
+The Matrix4VertexAttribute node belongs to the **Shaders** component and its default container field is *attrib.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DGeometricPropertyNode
+    + X3DVertexAttributeNode
+      + Matrix4VertexAttribute
+```
+
+## 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.
+
+### SFString [ ] **name** ""
+
+Required name for this particular VertexAttribute instance.
+
+#### Warning
+
+- Name is not specified if this instance is a USE node.
+
+### MFMatrix4f [in, out] **value** [ ] <small>(-∞,∞)</small>
+
+*value* specifies an arbitrary collection of matrix values that will be passed to the shader as per-vertex information.
+
+#### Hint
+
+- The length of the value field shall be a multiple of numComponents.
+
+## External Links
+
+- [X3D Specification of Matrix4VertexAttribute](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shaders.html#Matrix4VertexAttribute){:target="_blank"}