x_ite 8.8.6 → 8.9.0

package/docs/_posts/components/Grouping/Transform.md

@@ -1,6 +1,6 @@
 ---
 title: Transform
-date: 2022-01-07
+date: 2023-01-07
 nav: components-Grouping
 categories: [components, Grouping]
 tags: [Transform, Grouping]
@@ -15,7 +15,7 @@ tags: [Transform, Grouping]
 
 Transform is a Grouping node that can contain most nodes. Transform translates, orients and scales child geometry within the local world coordinate system.
 
-The Transform node belongs to the **Grouping** component and its default container field is *children.* It is available since X3D version 2.0 or later.
+The Transform node belongs to the **Grouping** component and its default container field is *children.* It is available from X3D version 2.0 or higher.
 
 ## Hierarchy
 
@@ -30,7 +30,11 @@ The Transform node belongs to the **Grouping** component and its default contain
 
 ### 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.
+Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
+
+#### Hint
+
+- [X3D Architecture 7.2.4 Metadata](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata){:target="_blank"}
 
 ### SFVec3f [in, out] **translation** 0 0 0 <small>(-∞,∞)</small>
 
@@ -38,7 +42,7 @@ 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.
+- 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>[-1,1] or (-∞,∞)</small>
 
@@ -46,15 +50,15 @@ Orientation (axis, angle in radians) of children relative to local coordinate sy
 
 #### Hint
 
-- The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
+- The order of operation is first apply the center offset, then scaleOrientation and scale, then *rotation*, then restore the center offset, then translation.
 
 ### SFVec3f [in, out] **scale** 1 1 1 <small>(-∞,∞)</small>
 
-Non-uniform x-y-z scale of child coordinate system, adjusted by center and scaleOrientation.
+Non-uniform x-y-z *scale* of child coordinate system, adjusted by center and scaleOrientation.
 
 #### Hint
 
-- The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
+- 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] **scaleOrientation** 0 0 1 0 <small>[-1,1] or (-∞,∞)</small>
 
@@ -62,7 +66,7 @@ Preliminary rotation of coordinate system before scaling (to allow scaling aroun
 
 #### Hint
 
-- The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
+- The order of operation is first apply the center offset, then *scaleOrientation* and scale, then rotation, then restore the center offset, then translation.
 
 ### SFVec3f [in, out] **center** 0 0 0 <small>(-∞,∞)</small>
 
@@ -70,18 +74,18 @@ Translation offset from origin of local coordinate system, applied prior to rota
 
 #### Hint
 
-- The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
+- The order of operation is first apply the *center* offset, then scaleOrientation and scale, then rotation, then restore the *center* offset, then translation.
 
-### SFBool [ ] **visible** TRUE
+### SFBool [in, out] **visible** TRUE
 
 Whether or not renderable content within this node is visually displayed.
 
-#### Hint
+#### Hints
 
-- The visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
-- Content must be visible to be collidable and to be pickable.
+- The *visible* field has no effect on animation behaviors, event passing or other non-visual characteristics.
+- Content must be *visible* to be collidable and to be pickable.
 
-### SFBool [ ] **bboxDisplay** FALSE
+### SFBool [in, out] **bboxDisplay** FALSE
 
 Whether to display bounding box for associated geometry, aligned with world coordinates.
 
@@ -93,31 +97,43 @@ Whether to display bounding box for associated geometry, aligned with world coor
 
 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
+#### Hints
 
 - Can be useful for collision computations or inverse-kinematics (IK) engines.
+- Precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
+- [X3D Architecture, 10.2.2 Bounding boxes](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#BoundingBoxes){:target="_blank"}
+- [X3D Architecture, 10.3.1 X3DBoundedObject](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#X3DBoundedObject){:target="_blank"}
 
 ### SFVec3f [ ] **bboxCenter** 0 0 0 <small>(-∞,∞)</small>
 
-Bounding box center: optional hint for position offset from origin of local coordinate system.
+Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
+
+#### Hints
+
+- Precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
+- [X3D Architecture, 10.2.2 Bounding boxes](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#BoundingBoxes){:target="_blank"}
+- [X3D Architecture, 10.3.1 X3DBoundedObject](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#X3DBoundedObject){:target="_blank"}
 
 ### MFNode [in] **addChildren**
 
-Input field addChildren.
+Input field *addChildren*.
 
 ### MFNode [in] **removeChildren**
 
-Input field removeChildren.
+Input field *removeChildren*.
 
 ### MFNode [in, out] **children** [ ] <small>[X3DChildNode]</small>
 
-Grouping nodes contain a list of children nodes.
+Grouping nodes contain an ordered list of *children* nodes.
 
-#### Hint
+#### Hints
 
-- Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
+- Each grouping node defines a coordinate space for its *children*, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
+- InputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
+- InputOnly MFNode removeChildren field can remove nodes from the *children* list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
+- [X3D Architecture 10.2.1 Grouping and *children* node types](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#GroupingAndChildrenNodes){:target="_blank"}
 
-## Description
+## Advisories
 
 ### Hints
 
@@ -127,17 +143,18 @@ Grouping nodes contain a list of children nodes.
 - Insert a Shape node before adding geometry or Appearance.
 - Translation/rotation/scaling field attributes can be defined in any order in the scene. The applied order of translation/rotation/scaling transformation-matrix operations remains consistent.
 - Authors can modify order of translation/rotation/scaling operations by splitting them into separate nested parent/child Transform nodes.
-
-## Example
-
-<x3d-canvas src="https://create3000.github.io/media/examples/Grouping/Transform/Transform.x3d" update="auto"></x3d-canvas>
+- [X3D Scene Authoring Hints, Coordinate Systems](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#CoordinateSystems){:target="_blank"}
+- [X3D Scene Authoring Hints, Scale Factors and Unit Conversions](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scale){:target="_blank"}
+- Apply `containerField='shape'` if parent node is CADFace.
 
 ### Warning
 
 - Transform contained by CADFace can only hold a single LOD or Shape node.
 
-## External Links
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Grouping/Transform/Transform.x3d" update="auto"></x3d-canvas>
 
-- [X3D Specification of Transform](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/grouping.html#Transform){:target="_blank"}
-- [X3D Scene Authoring Hints, Coordinate Systems](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#CoordinateSystems){:target="_blank"}
-- [X3D Scene Authoring Hints, Scale Factors and Unit Conversions](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scale){:target="_blank"}
+## See Also
+
+- [X3D Specification of Transform node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/grouping.html#Transform){:target="_blank"}

package/docs/_posts/components/HAnim/HAnimDisplacer.md

@@ -1,6 +1,6 @@
 ---
 title: HAnimDisplacer
-date: 2022-01-07
+date: 2023-01-07
 nav: components-HAnim
 categories: [components, HAnim]
 tags: [HAnimDisplacer, HAnim]
@@ -13,9 +13,9 @@ tags: [HAnimDisplacer, HAnim]
 
 ## Overview
 
-HAnimDisplacer nodes alter the shape of coordinate-based geometry within parent HAnimSegment or parent HAnimBody/HAnimHumanoid nodes. Displacer effects are scaled by the corresponding weight field.
+HAnimDisplacer nodes alter the shape of coordinate-based geometry within parent HAnimJoint or HAnimSegment nodes. Displacer effects are scaled by the corresponding weight field.
 
-The HAnimDisplacer node belongs to the **HAnim** component and its default container field is *displacers.* It is available since X3D version 3.0 or later.
+The HAnimDisplacer node belongs to the **HAnim** component and its default container field is *displacers.* It is available from X3D version 3.0 or higher.
 
 ## Hierarchy
 
@@ -29,44 +29,45 @@ The HAnimDisplacer node belongs to the **HAnim** component and its default conta
 
 ### 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 [in, out] **description** ""
-
-Author-provided prose that describes intended purpose of the url asset.
+Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
 
 #### Hint
 
-- Many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &amp;#38; for & ampersand character, or &amp;#34; for " quotation-mark character).
+- [X3D Architecture 7.2.4 Metadata](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata){:target="_blank"}
 
-### MFInt32 [in, out] **coordIndex** [ ] <small>[0,∞) or -1</small>
+### SFString [in, out] **description** ""
 
-Defines index values into the parent HAnimSegment or HAnimBody/HAnimHumanoid coordinate array for the mesh of vertices affected by this HAnimDisplacer. Values start at index 0.
+Author-provided prose that describes intended purpose of this node.
 
-#### Warning
+#### Hint
 
-- -1 sentinel values are not allowed.
+- Many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &amp;#38; for &amp; ampersand character, or &amp;#34; for " quotation-mark character).
 
-### MFVec3f [in, out] **displacements** [ ]
+### SFString [in, out] **name** ""
 
-*displacements* are a set of SFVec3f values added to neutral/resting position of each of the corresponding HAnimSegment vertices (or HAnimJoint/HAnimHumanoid vertices) referenced by coordIndex field.
+Unique *name* attribute must be defined so that HAnimDisplacer node can be identified at run time for animation purposes.
 
-#### Hint
+#### Hints
 
-- Individual displacement values are scaled by the weight factor, if present.
+- HAnimDisplacer names are based on feature point names.
+- Https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/FeaturePoints.html
+- Well-defined names can simplify design and debugging through improved author understanding.
+- [X3D Scene Authoring Hints, Naming Conventions](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions){:target="_blank"}
+- [HAnim2 Names HAnim1 Alias Tables](https://www.web3d.org/x3d/content/examples/HumanoidAnimation/HAnim2NameHAnim1AliasTables.txt){:target="_blank"}
 
-### SFString [in, out] **name** ""
+#### Warnings
 
-Unique name attribute must be defined so that HAnimDisplacer node can be identified at run time for animation purposes.
+- Allowed *name* suffixes include _feature, _action and _config.
+- *name* prefix must match ancestor HAnimHumanoid *name* followed by underscore character, if more than one humanoid appears within a scene file. For example, 'Nancy_' prepended before location *name*.
+- *name* field is not included if this instance is a USE node, in order to avoid potential mismatches.
 
-#### Warning
+### MFInt32 [in, out] **coordIndex** [ ] <small>[0,∞) or -1</small>
 
-- Name is not included if this instance is a USE node. Examples: sellion r_infraorbitale etc. as listed in HAnim Specification.
+Defines index values into the parent HAnimSegment or HAnimBody/HAnimHumanoid coordinate array for the mesh of vertices affected by this HAnimDisplacer. Values start at index 0.
 
-#### See Also
+#### Warning
 
-- [HAnim Feature Points](https://www.web3d.org/x3d/content/examples/Basic/HumanoidAnimation/tables/HAnimSurfaceFeaturePoints19774V1.0.txt){:target="_blank"}
-- [HAnim Specification, Feature points for the human body](https://www.web3d.org/documents/specifications/19774-1/V2.0/HAnim/FeaturePoints.html){:target="_blank"}
+- -1 sentinel values are not allowed.
 
 ### SFFloat [in, out] **weight** 0 <small>(-∞,∞)</small>
 
@@ -74,24 +75,34 @@ The weigh factor has typical range [0,1] and defines the scale factor applied to
 
 #### Hint
 
-- Apply a non-zero weight factor to see the effect of HAnimDisplacer displacements.
+- Apply a non-zero *weight* factor to see the effect of HAnimDisplacer displacements.
 
-## Description
+### MFVec3f [in, out] **displacements** [ ]
 
-### Example
+*displacements* are a set of SFVec3f values added to neutral/resting position of each of the corresponding HAnimSegment vertices (or HAnimJoint/HAnimHumanoid vertices) referenced by coordIndex field.
+
+#### Hints
+
+- Individual displacement values are scaled by the weight factor, if present.
+- Since default pose faces along +Z axis, -x values are right side and +x values are left side within HAnimHumanoid.
 
-- In the case of a face, there might be a separate HAnimDisplacer node for each facial expression.
+## Advisories
 
 ### Hints
 
-- HAnimDisplacer can be used in three different ways: (a) identify vertices corresponding to a particular feature in a parent HAnimSegment node, (b) represent a particular muscular action for a parent HAnimJoint node by displacing corresponding HAnimHumanoid skin vertices in various directions (linearly or radially), or (c) represent a complete configuration of coordinate vertices in a parent HAnimSegment node or parent HAnimJoint/HAnimHumanoid nodes.
-- Name suffixes include \_feature, \_action and \_config.
-- Multiple HAnimDisplacer nodes must appear consecutively inside parent HAnimSegment.
-- Include `<component name='HAnim' level='1'/>`
+- HAnimDisplacer can be used in three different ways: (a) identify vertices corresponding to a particular feature in a parent HAnimSegment node, (b) represent a particular muscular action for a parent HAnimJoint node by displacing corresponding HAnimHumanoid skin vertices in various directions (linearly or radially), or (c) represent a complete configuration of coordinate vertices in parent HAnimSegment or HAnimJoint nodes. Example: in the case of a face, there might be a separate HAnimDisplacer node for each facial expression.
+- Multiple HAnimDisplacer nodes must appear consecutively inside parent HAnimSegment for proper content validation in XML encoding.
+- [HAnim Specification](https://www.web3d.org/documents/specifications/19774/V2.0){:target="_blank"}
+- [HAnim Specification part 1, Displacer](https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/ObjectInterfaces.html#Displacer){:target="_blank"}
+- [X3D for Advanced Modeling (X3D4AM) slideset](https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/HumanoidAnimation.pdf){:target="_blank"}
+
+### Warnings
+
+- Allowed name suffixes include _feature, _action and _config.
+- Index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer nodes for proper skin animation.
+- Requires X3D `profile='Full'` or else include `<component name='HAnim' level='1'/>`
+- For X3D3 HAnim1, spelling of component name is 'H-Anim' (including hyphen)
 
-## External Links
+## See Also
 
-- [X3D Specification of HAnimDisplacer](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/hanim.html#HAnimDisplacer){:target="_blank"}
-- [HAnim Specification](https://www.web3d.org/documents/specifications/19774-1/V2.0/HAnim/HAnimArchitecture.html){:target="_blank"}
-- [HAnim Specification, Displacer](https://www.web3d.org/documents/specifications/19774-1/V2.0/HAnim/ObjectInterfaces.html#Displacer){:target="_blank"}
-- In the case of a face, there might be a separate HAnimDisplacer node for each facial expression.
+- [X3D Specification of HAnimDisplacer node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/hanim.html#HAnimDisplacer){:target="_blank"}