x_ite 8.4.3 → 8.5.3

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

@@ -0,0 +1,78 @@
+---
+title: BallJoint
+date: 2022-01-07
+nav: components-RigidBodyPhysics
+categories: [components, RigidBodyPhysics]
+tags: [BallJoint, RigidBodyPhysics]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+BallJoint represents an unconstrained joint between two bodies that pivot about a common anchor point. Contains two RigidBody nodes (containerField values body1, body2).
+
+The BallJoint 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
+    + BallJoint
+```
+
+## 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 [out] **body1AnchorPoint**
+
+*body1AnchorPoint* describes anchorPoint position relative to local coordinate reference frame.
+
+#### Hint
+
+- Can detect separation if body1AnchorPoint!=body2AnchorPoint.
+
+### SFVec3f [out] **body2AnchorPoint**
+
+*body2AnchorPoint* describes anchorPoint position relative to local coordinate reference frame.
+
+#### Hint
+
+- Can detect separation if body1AnchorPoint!=body2AnchorPoint.
+
+### 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/BallJoint/BallJoint.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of BallJoint](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/rigidBodyPhysics.html#BallJoint){:target="_blank"}

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

@@ -0,0 +1,75 @@
+---
+title: CollidableOffset
+date: 2022-01-07
+nav: components-RigidBodyPhysics
+categories: [components, RigidBodyPhysics]
+tags: [CollidableOffset, RigidBodyPhysics]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+CollidableOffset repositions geometry relative to center of owning body. Contains a single CollidableShape or CollidableOffset node (containerField='collidable').
+
+The CollidableOffset node belongs to the **RigidBodyPhysics** component and its default container field is *children.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DNBodyCollidableNode (X3DBoundedObject)*
+      + CollidableOffset
+```
+
+<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.
+
+### SFVec3f [in, out] **translation** 0 0 0 <small>(-∞,∞)</small>
+
+Position (x, y, z in meters) of children relative to local coordinate system.
+
+#### Hint
+
+- The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
+
+### SFRotation [in, out] **rotation** 0 0 1 0 <small>[0,1]</small>
+
+Orientation (axis, angle in radians) of children relative to local coordinate system.
+
+#### Hint
+
+- The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
+
+### 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 <small>(-∞,∞)</small>
+
+Bounding box center: optional hint for position offset from origin of local coordinate system.
+
+### SFNode [ ] **collidable** NULL <small>[X3DNBodyCollidableNode]</small>
+
+Field collidable.
+
+## External Links
+
+- [X3D Specification of CollidableOffset](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/rigidBodyPhysics.html#CollidableOffset){:target="_blank"}

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

@@ -0,0 +1,83 @@
+---
+title: CollidableShape
+date: 2022-01-07
+nav: components-RigidBodyPhysics
+categories: [components, RigidBodyPhysics]
+tags: [CollidableShape, RigidBodyPhysics]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+CollidableShape connects the collision detection system, the rigid body model, and the renderable scene graph. Contains a single Shape node (containerField='shape') for animating collidable geometry.
+
+The CollidableShape node belongs to the **RigidBodyPhysics** component and its default container field is *children.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DNBodyCollidableNode
+      + CollidableShape
+```
+
+## 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] **translation** 0 0 0 <small>(-∞,∞)</small>
+
+Position (x, y, z in meters) of children relative to local coordinate system.
+
+#### Hint
+
+- The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
+
+### SFRotation [in, out] **rotation** 0 0 1 0 <small>[0,1]</small>
+
+Orientation (axis, angle in radians) of children relative to local coordinate system.
+
+#### Hint
+
+- The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
+
+### 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 <small>(-∞,∞)</small>
+
+Bounding box center: optional hint for position offset from origin of local coordinate system.
+
+### SFNode [ ] **shape** NULL <small>[Shape]</small>
+
+Field shape.
+
+## Description
+
+### Warning
+
+- Avoid changing Shape geometry at run time to prevent performance problems.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/RigidBodyPhysics/CollidableShape/CollidableShape.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of CollidableShape](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/rigidBodyPhysics.html#CollidableShape){:target="_blank"}

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

@@ -0,0 +1,90 @@
+---
+title: CollisionCollection
+date: 2022-01-07
+nav: components-RigidBodyPhysics
+categories: [components, RigidBodyPhysics]
+tags: [CollisionCollection, RigidBodyPhysics]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+CollisionCollection holds a collection of objects that can be managed as a single entity for resolution of inter-object collisions.
+
+The CollisionCollection node belongs to the **RigidBodyPhysics** component and its default container field is *collider.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + CollisionCollection
+```
+
+## Fields
+
+### SFNode [in, out] **metadata** NULL
+
+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.
+
+### MFString [in, out] **appliedParameters** "BOUNCE"
+
+Default global parameters for collision outputs of rigid body physics system. Contact node can override parent CollisionCollection node. Selectable values for array: "BOUNCE" "USER_FRICTION" "FRICTION_COEFFICIENT-2" "ERROR_REDUCTION" "CONSTANT_FORCE" "SPEED-1" "SPEED-2" "SLIP-1" "SLIP-2".
+
+#### Hint
+
+- BOUNCE: bounce value is used; USER_FRICTION: apply user-supplied value; FRICTION_COEFFICIENT-2: apply frictionCoefficients values; ERROR_REDUCTION: apply softnessErrorCorrection value; CONSTANT_FORCE: apply softnessConstantForceMix value; SPEED-1: apply first component of surfaceSpeed array; SPEED-2: apply second component of surfaceSpeed array; SLIP-1: apply first component of slipFactors array; SLIP-2: apply second component of slipFactors array.
+
+### SFFloat [in, out] **bounce** 0 <small>[0,1]</small>
+
+*bounce* indicates bounciness (0 = no bounce at all, 1 = maximum bounce).
+
+### SFFloat [in, out] **minBounceSpeed** 0.1
+
+*minBounceSpeed* m/s needed to bounce.
+
+### SFVec2f [in, out] **frictionCoefficients** 0 0
+
+*frictionCoefficients* used for computing surface drag.
+
+### SFVec2f [in, out] **surfaceSpeed** 0 0
+
+*surfaceSpeed* defines speed vectors for computing surface drag, if contact surfaces move independently of bodies.
+
+### SFVec2f [in, out] **slipFactors** 0 0
+
+*slipFactors* used for computing surface drag.
+
+### SFFloat [in, out] **softnessConstantForceMix** 0.0001
+
+*softnessConstantForceMix* value applies a constant force value to make colliding surfaces appear to be somewhat soft.
+
+### SFFloat [in, out] **softnessErrorCorrection** 0.8
+
+*softnessErrorCorrection* indicates fraction of collision error fixed in a set of evaluations (0 = no error correction, 1 = all errors corrected in single step).
+
+### MFNode [in, out] **collidables** [ ] <small>[X3DNBodyCollisionSpaceNode,X3DNBodyCollidableNode]</small>
+
+Input/Output field collidables.
+
+## Description
+
+### Hint
+
+- Contains an array of CollisionSpace, CollidableShape or CollidableOffset nodes (containerField='collidables').
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/RigidBodyPhysics/CollisionCollection/CollisionCollection.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of CollisionCollection](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/rigidBodyPhysics.html#CollisionCollection){:target="_blank"}

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

@@ -0,0 +1,65 @@
+---
+title: CollisionSensor
+date: 2022-01-07
+nav: components-RigidBodyPhysics
+categories: [components, RigidBodyPhysics]
+tags: [CollisionSensor, RigidBodyPhysics]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+CollisionSensor generates collision-detection events.
+
+The CollisionSensor node belongs to the **RigidBodyPhysics** component and its default container field is *children.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DSensorNode
+      + CollisionSensor
+```
+
+## 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.
+
+### SFBool [out] **isActive**
+
+*isActive* true/false events are sent when sensing starts/stops.
+
+### MFNode [out] **intersections** <small>[X3DNBodyCollidableNode]</small>
+
+Output field intersections.
+
+### MFNode [out] **contacts**
+
+Output field contacts.
+
+### SFNode [in, out] **collider** NULL <small>[CollisionCollection]</small>
+
+Input/Output field collider.
+
+## Description
+
+### Hints
+
+- Contains CollisionCollection node (containerField='collider').
+- CollisionSensor also has output events: CollidableOffset and CollidableShape nodes (containerField='intersections'), Contact nodes (containerField='contacts').
+
+## External Links
+
+- [X3D Specification of CollisionSensor](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/rigidBodyPhysics.html#CollisionSensor){: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"}

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

@@ -0,0 +1,70 @@
+---
+title: CollisionSpace
+date: 2022-01-07
+nav: components-RigidBodyPhysics
+categories: [components, RigidBodyPhysics]
+tags: [CollisionSpace, RigidBodyPhysics]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+CollisionSpace holds collection of objects considered together for resolution of inter-object collisions. Contains multiple CollidableShape, CollidableOffset, or CollisionSpace nodes (containerField='collidables').
+
+The CollisionSpace node belongs to the **RigidBodyPhysics** component and its default container field is *children.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DNBodyCollisionSpaceNode (X3DBoundedObject)*
+    + CollisionSpace
+```
+
+<small>\* Derived from multiple interfaces.</small>
+
+## Fields
+
+### SFNode [in, out] **metadata** NULL
+
+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.
+
+### SFBool [in, out] **useGeometry** FALSE
+
+*useGeometry* indicates whether collision-detection code checks down to level of geometry, or only make approximations using geometry bounds.
+
+#### Hint
+
+- Testing against object bounds is usually sufficient.
+
+#### Warning
+
+- Using geometry is more accurate but slower.
+
+### SFVec3f [ ] **bboxSize** -1 -1 -1
+
+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.
+
+### MFNode [in, out] **collidables** [ ] <small>[X3DNBodyCollisionSpaceNode,X3DNBodyCollidableNode]</small>
+
+Input/Output field collidables.
+
+## External Links
+
+- [X3D Specification of CollisionSpace](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/rigidBodyPhysics.html#CollisionSpace){:target="_blank"}

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

@@ -0,0 +1,117 @@
+---
+title: Contact
+date: 2022-01-07
+nav: components-RigidBodyPhysics
+categories: [components, RigidBodyPhysics]
+tags: [Contact, RigidBodyPhysics]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+Contact nodes are produced as output events when two collidable objects or spaces make contact.
+
+The Contact node belongs to the **RigidBodyPhysics** component and its default container field is *children.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + Contact
+```
+
+## 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 <small>(-∞,∞)</small>
+
+*position* (x, y, z in meters) of exact location of collision.
+
+### SFVec3f [in, out] **contactNormal** 0 1 0 <small>(-∞,∞)</small>
+
+*contactNormal* is unit vector describing normal between two colliding bodies.
+
+### SFFloat [in, out] **depth** 0 <small>(-∞,∞)</small>
+
+*depth* indicates how deep the current intersection is along normal vector.
+
+### MFString [in, out] **appliedParameters** "BOUNCE"
+
+Default global parameters for collision outputs of rigid body physics system. Contact node can override parent CollisionCollection node. Selectable values for array: "BOUNCE" "USER_FRICTION" "FRICTION_COEFFICIENT-2" "ERROR_REDUCTION" "CONSTANT_FORCE" "SPEED-1" "SPEED-2" "SLIP-1" "SLIP-2".
+
+#### Hint
+
+- BOUNCE: bounce value is used; USER_FRICTION: apply user-supplied value; FRICTION_COEFFICIENT-2: apply frictionCoefficients values; ERROR_REDUCTION: apply softnessErrorCorrection value; CONSTANT_FORCE: apply softnessConstantForceMix value; SPEED-1: apply first component of surfaceSpeed array; SPEED-2: apply second component of surfaceSpeed array; SLIP-1: apply first component of slipFactors array; SLIP-2: apply second component of slipFactors array.
+
+### SFFloat [in, out] **bounce** 0 <small>[0,1]</small>
+
+*bounce* indicates bounciness (0 = no bounce at all, 1 = maximum bounce).
+
+### SFFloat [in, out] **minBounceSpeed**
+
+*minBounceSpeed* m/s needed to bounce.
+
+### SFVec3f [in, out] **frictionDirection** 0 1 0 <small>(-∞,∞)</small>
+
+*frictionDirection* controls friction vector.
+
+#### Hint
+
+- Value of (0 0 0) indicates no friction.
+
+### SFVec2f [in, out] **frictionCoefficients** 0 0 <small>[0,∞)</small>
+
+*frictionCoefficients* used for computing surface drag.
+
+### SFVec2f [in, out] **surfaceSpeed** 0 0 <small>(-∞,∞)</small>
+
+*surfaceSpeed* defines speed vectors for computing surface drag, if contact surfaces move independently of bodies.
+
+### SFVec2f [in, out] **slipCoefficients** 0 0 <small>(-∞,∞)</small>
+
+*slipCoefficients* used for computing surface drag.
+
+### SFFloat [in, out] **softnessConstantForceMix** 0.0001 <small>[0,1]</small>
+
+*softnessConstantForceMix* value applies a constant force value to make colliding surfaces appear to be somewhat soft.
+
+### SFFloat [in, out] **softnessErrorCorrection** 0.8 <small>[0,1]</small>
+
+*softnessErrorCorrection* indicates fraction of collision error fixed in a set of evaluations (0 = no error correction, 1 = all errors corrected in single step).
+
+### SFNode [in, out] **geometry1** NULL <small>[X3DNBodyCollidableNode]</small>
+
+Input/Output field geometry1.
+
+### SFNode [in, out] **geometry2** NULL <small>[X3DNBodyCollidableNode]</small>
+
+Input/Output field geometry2.
+
+### 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
+
+- Each Contact node contains two RigidBody (containerField='body1,body2') and two CollidableShape or CollidableOffset nodes (containerField='geometry1,geometry2').
+
+### Warning
+
+- Contact nodes are transient and can only occur at run time, not in saved X3D files.
+
+## External Links
+
+- [X3D Specification of Contact](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/rigidBodyPhysics.html#Contact){:target="_blank"}