x_ite 8.4.3 → 8.5.3

package/docs/_posts/components/Geometry3D/Cylinder.md

@@ -0,0 +1,98 @@
+---
+title: Cylinder
+date: 2022-01-07
+nav: components-Geometry3D
+categories: [components, Geometry3D]
+tags: [Cylinder, Geometry3D]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+Cylinder is a geometry node.
+
+The Cylinder node belongs to the **Geometry3D** component and its default container field is *geometry.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DGeometryNode
+    + Cylinder
+```
+
+## 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 [ ] **top** TRUE
+
+Whether to draw top (inside faces are never drawn).
+
+#### Warning
+
+- Cannot be changed after initial creation.
+
+### SFBool [ ] **side** TRUE
+
+Whether to draw sides (inside faces are never drawn).
+
+#### Warning
+
+- Cannot be changed after initial creation.
+
+### SFBool [ ] **bottom** TRUE
+
+Whether to draw bottom (inside faces are never drawn).
+
+#### Warning
+
+- Cannot be changed after initial creation.
+
+### SFFloat [ ] **height** 2 <small>(0,∞)</small>
+
+Size in meters.
+
+#### Warning
+
+- Simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for animation use Transform scale instead.
+
+### SFFloat [ ] **radius** 1 <small>(0,∞)</small>
+
+Size in meters.
+
+#### Warning
+
+- Simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for animation use Transform scale instead.
+
+### SFBool [ ] **solid** TRUE
+
+Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).
+
+#### Hint
+
+- If in doubt, use solid='false' for maximum visibility.
+
+#### Warnings
+
+- Default value true can completely hide geometry if viewed from wrong side! Solid false not supported in VRML97.
+
+## Description
+
+### Hint
+
+- Insert a Shape node before adding geometry or Appearance.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Geometry3D/Cylinder/Cylinder.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of Cylinder](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geometry3D.html#Cylinder){:target="_blank"}

package/docs/_posts/components/Geometry3D/ElevationGrid.md

@@ -0,0 +1,162 @@
+---
+title: ElevationGrid
+date: 2022-01-07
+nav: components-Geometry3D
+categories: [components, Geometry3D]
+tags: [ElevationGrid, Geometry3D]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+ElevationGrid is a geometry node defining a rectangular height field, with default values for a 1m by 1m square at height 0. Vertices corresponding to ElevationGrid height values define quadrilaterals, which are placed above or below a flat surface.
+
+The ElevationGrid node belongs to the **Geometry3D** component and its default container field is *geometry.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DGeometryNode
+    + ElevationGrid
+```
+
+## 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.
+
+### MFFloat [in] **set_height** <small>(-∞,∞)</small>
+
+Grid array of height vertices with upward direction along +Y axis, with xDimension rows and zDimension columns.
+
+#### Hint
+
+- Height array values are given in row-major order from left to right along X axis, then back to front along Z axis.
+
+### SFInt32 [ ] **xDimension** <small>[0,∞)</small>
+
+Number of elements in the height array along X direction.
+
+### SFInt32 [ ] **zDimension** <small>[0,∞)</small>
+
+Number of elements in the height array along Z direction.
+
+### SFFloat [ ] **xSpacing** 1 <small>(0,∞)</small>
+
+Meters distance between grid-array vertices along X direction.
+
+#### Hint
+
+- Total horizontal x-axis distance equals (xDimension-1) \* xSpacing.
+
+### SFFloat [ ] **zSpacing** 1 <small>(0,∞)</small>
+
+Meters distance between grid-array vertices along Z direction.
+
+#### Hint
+
+- Total lateral z-axis distance equals (zDimension-1) \* zSpacing.
+
+### SFBool [ ] **solid** TRUE
+
+Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).
+
+#### Hint
+
+- If in doubt, use solid='false' for maximum visibility.
+
+#### Warning
+
+- Default value true can completely hide geometry if viewed from wrong side!
+
+### SFBool [ ] **ccw** TRUE
+
+*ccw* = counterclockwise: ordering of vertex coordinates orientation.
+
+#### Hint
+
+- Ccw false can reverse solid (backface culling) and normal-vector orientation.
+
+### SFFloat [ ] **creaseAngle** 0 <small>[0,∞)</small>
+
+*creaseAngle* defines angle (in radians) for determining whether adjacent polygons are drawn with sharp edges or smooth shading. If angle between normals of two adjacent polygons is less than creaseAngle, smooth shading is rendered across the shared line segment.
+
+#### Hint
+
+- CreaseAngle=0 means render all edges sharply, creaseAngle=3.14159 means render all edges smoothly.
+
+### SFBool [ ] **colorPerVertex** TRUE
+
+Whether Color node color values are applied to each vertex (true) or per quadrilateral (false).
+
+#### See Also
+
+- [X3D Scene Authoring Hints, Color](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color){:target="_blank"}
+
+### SFBool [ ] **normalPerVertex** TRUE
+
+Whether Normal node vector values are applied to each vertex (true) or per quadrilateral (false).
+
+### MFNode [in, out] **attrib** [ ] <small>[X3DVertexAttributeNode]</small>
+
+Multiple contained FloatVertexAttribute nodes that can specify list of per-vertex attribute information for programmable shaders.
+
+#### Hint
+
+- [X3D Architecture 32.2.2.4 Per-vertex attributes](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/shaders.html#Pervertexattributes){:target="_blank"}
+
+### SFNode [in, out] **fogCoord** NULL <small>[FogCoordinate]</small>
+
+Single contained FogCoordinate node that can specify depth parameters for fog in corresponding geometry.
+
+### SFNode [in, out] **color** NULL <small>[X3DColorNode]</small>
+
+Single contained Color or ColorRGBA node that can specify color values applied to corresponding vertices according to colorIndex and colorPerVertex fields.
+
+### SFNode [in, out] **texCoord** NULL <small>[X3DTextureCoordinateNode]</small>
+
+Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate node that can specify coordinates for texture mapping onto corresponding geometry.
+
+### SFNode [in, out] **normal** NULL <small>[X3DNormalNode]</small>
+
+Single contained Normal node that can specify perpendicular vectors for corresponding vertices to support rendering computations, applied according to the normalPerVertex field.
+
+#### Hint
+
+- Useful for special effects. Normal vector computation by 3D graphics hardware is quite fast so adding normals to a scene is typically unnecessary.
+
+### MFFloat [ ] **height** [ ] <small>(-∞,∞)</small>
+
+Grid array of height vertices with upward direction along +Y axis, with xDimension rows and zDimension columns.
+
+#### Hint
+
+- Height array values are given in row-major order from left to right along X axis, then back to front along Z axis.
+
+## Description
+
+### Hints
+
+- The height array defines (xDimension-1)\*(zDimension-1) quadrilaterals.
+- Positive direction for normal of each triangle is on same side of the quadrilateral. Triangles are defined either counterclockwise or clockwise depending on value of ccw field.
+- ElevationGrid can contain Color/ColorRGBA, Normal and TextureCoordinate nodes.
+- Insert a Shape node before adding geometry or Appearance.
+- You can also substitute a type-matched ProtoInstance node for contained content.
+
+### Warning
+
+- Generated quadrilaterals can be nonplanar. Tessellation splits quadrilaterals into triangles along seam starting at initial vertex of the quadrilateral and proceeding to opposite vertex.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Geometry3D/ElevationGrid/ElevationGrid.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of ElevationGrid](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geometry3D.html#ElevationGrid){:target="_blank"}

package/docs/_posts/components/Geometry3D/Extrusion.md

@@ -0,0 +1,170 @@
+---
+title: Extrusion
+date: 2022-01-07
+nav: components-Geometry3D
+categories: [components, Geometry3D]
+tags: [Extrusion, Geometry3D]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+Extrusion is a geometry node stretching a 2D cross section along a 3D-spine path in the local coordinate system. Scaling/rotating cross-sections can produce a variety of shapes.
+
+The Extrusion node belongs to the **Geometry3D** component and its default container field is *geometry.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DGeometryNode
+    + Extrusion
+```
+
+## 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.
+
+### MFVec2f [in] **set_crossSection** <small>(-∞,∞)</small>
+
+An ordered set of 2D points drawing a piecewise-linear curve and forming a planar series of connected vertices. This provides a silhouette of the outer surface.
+
+#### Warning
+
+- Match clockwise/counterclockwise or impossible/inverted geometry can result!
+
+### MFRotation [in] **set_orientation** <small>[-1,1] or (-∞,∞)</small>
+
+Orientation is a list of axis-angle orientation 4-tuples applied at each spine-aligned cross-section plane.
+
+#### Hint
+
+- Number of spine points, scale values and orientation values must be the same.
+
+### MFVec2f [in] **set_scale** <small>(0,∞)</small>
+
+Scale is a list of 2D-scale parameters applied at each spine-aligned cross-section plane.
+
+#### Hint
+
+- Number of spine points, scale values and orientation values must be the same.
+
+#### Warning
+
+- Zero or negative scale values not allowed.
+
+### MFVec3f [in] **set_spine** <small>(-∞,∞)</small>
+
+Spine is a list of 3D points for a piecewise-linear curve forming a series of connected vertices, open or closed. This is the path along which the crossSection is extruded.
+
+#### Hint
+
+- Number of spine points, scale values and orientation values must be the same.
+
+### SFBool [ ] **beginCap** TRUE
+
+Whether beginning cap is drawn (similar to Cylinder top cap).
+
+#### Warning
+
+- Cannot be changed after initial creation.
+
+### SFBool [ ] **endCap** TRUE
+
+Whether end cap is drawn (similar to Cylinder end cap).
+
+#### Warning
+
+- Cannot be changed after initial creation.
+
+### SFBool [ ] **solid** TRUE
+
+Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).
+
+#### Hint
+
+- If in doubt, use solid='false' for maximum visibility.
+
+#### Warning
+
+- Default value true can completely hide geometry if viewed from wrong side!
+
+### SFBool [ ] **ccw** TRUE
+
+*ccw* = counterclockwise: ordering of vertex-coordinates orientation.
+
+#### Hint
+
+- Ccw false can reverse solid (backface culling) and normal-vector orientation.
+
+### SFBool [ ] **convex** TRUE
+
+Whether all polygons in a shape are convex (true), or possibly concave (false). A convex polygon is planar, does not intersect itself, and has all interior angles \< 180 degrees.
+
+#### Warning
+
+- Concave geometry may be invisible default convex=true.
+
+### SFFloat [ ] **creaseAngle** 0 <small>[0,∞)</small>
+
+*creaseAngle* defines angle (in radians) where adjacent polygons are drawn with sharp edges or smooth shading. If angle between normals of two adjacent polygons is less than creaseAngle, smooth shading is rendered across the shared line segment.
+
+#### Hint
+
+- CreaseAngle=0 means render all edges sharply, creaseAngle=3.14159 means render all edges smoothly.
+
+### MFVec2f [ ] **crossSection** [ 1 1, 1 -1, -1 -1, -1 1, 1 1 ] <small>(-∞,∞)</small>
+
+An ordered set of 2D points drawing a piecewise-linear curve and forming a planar series of connected vertices. This provides a silhouette of the outer surface.
+
+#### Warning
+
+- Match clockwise/counterclockwise or impossible/inverted geometry can result!
+
+### MFRotation [ ] **orientation** 0 0 1 0 <small>[-1,1] or (-∞,∞)</small>
+
+*orientation* is a list of axis-angle orientation 4-tuples applied at each spine-aligned cross-section plane.
+
+#### Hint
+
+- Number of spine points, scale values and orientation values must be the same.
+
+### MFVec2f [ ] **scale** 1 1 <small>(0,∞)</small>
+
+*scale* is a list of 2D-scale parameters applied at each spine-aligned cross-section plane.
+
+#### Hint
+
+- Number of spine points, scale values and orientation values must be the same.
+
+#### Warning
+
+- Zero or negative scale values not allowed.
+
+### MFVec3f [ ] **spine** [ 0 0 0, 0 1 0 ] <small>(-∞,∞)</small>
+
+*spine* is a list of 3D points for a piecewise-linear curve forming a series of connected vertices, open or closed. This is the path along which the crossSection is extruded.
+
+#### Hint
+
+- Number of spine points, scale values and orientation values must be the same.
+
+## Description
+
+### Hint
+
+- Insert a Shape node before adding geometry or Appearance.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Geometry3D/Extrusion/Extrusion.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of Extrusion](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geometry3D.html#Extrusion){:target="_blank"}

package/docs/_posts/components/Geometry3D/IndexedFaceSet.md

@@ -0,0 +1,208 @@
+---
+title: IndexedFaceSet
+date: 2022-01-07
+nav: components-Geometry3D
+categories: [components, Geometry3D]
+tags: [IndexedFaceSet, Geometry3D]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+IndexedFaceSet is a geometry node that can contain a Color/ColorRGBA, Coordinate/CoordinateDouble, Normal and TextureCoordinate nodes.
+
+The IndexedFaceSet node belongs to the **Geometry3D** component and its default container field is *geometry.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DGeometryNode
+    + X3DComposedGeometryNode
+      + IndexedFaceSet
+```
+
+## 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.
+
+### MFInt32 [in] **set_colorIndex** <small>[0,∞) or -1</small>
+
+*colorIndex* values define the order in which Color|ColorRGBA values are applied to polygons (or vertices).
+
+#### Hints
+
+- If *colorIndex* array is not provided, then Color|ColorRGBA values are indexed according to the coordIndex field.
+- If colorPerVertex='false' then one index is provided for each polygon defined by the coordIndex array. No sentinel -1 values are included.
+- If colorPerVertex='true' then a matching set of indices is provided, each separated by sentinel -1, that exactly corresponds to individual
+
+### MFInt32 [in] **set_texCoordIndex** <small>[-1,∞)</small>
+
+List of texture-coordinate indices mapping attached texture to corresponding coordinates.
+
+#### Hint
+
+- If *texCoordIndex* array is not provided, then TextureCoordinate values are indexed according to the coordIndex field.
+- Use a tool!
+
+### MFInt32 [in] **set_normalIndex** <small>[0,∞) or -1</small>
+
+*normalIndex* values define the order in which normal vectors are applied to polygons (or vertices).
+
+#### Hints
+
+- If normalPerVertex='false' then one index is provided for each polygon defined by the coordIndex array. No sentinel -1 values are included.
+- If normalPerVertex='true' then a matching set of indices is provided, each separated by sentinel -1, that exactly corresponds to individual values in the coordIndex array polygon definitions.
+- If no child Normal node is provided, the X3D browser shall automatically generate normals, using creaseAngle to determine smoothed shading across shared vertices.
+
+### MFInt32 [in] **set_coordIndex** <small class="small">[0,∞) or -1</small>
+
+**colorIndex** values define the order in which Color|ColorRGBA values are applied to polygons (or vertices).
+
+#### Hints
+
+- If *colorIndex* array is not provided, then Color|ColorRGBA values are indexed according to the coordIndex field.
+- If colorPerVertex='false' then one index is provided for each polygon defined by the coordIndex array. No sentinel -1 values are included.
+- If colorPerVertex='true' then a matching set of indices is provided, each separated by sentinel -1, that exactly corresponds to individual values in the coordIndex array polygon definitions.
+
+### SFBool [ ] **solid** TRUE
+
+Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).
+
+#### Hint
+
+- If in doubt, use solid='false' for maximum visibility.
+
+#### Warning
+
+- Default value true can completely hide geometry if viewed from wrong side!
+
+### SFBool [ ] **ccw** TRUE
+
+*ccw* = counterclockwise: ordering of vertex coordinates orientation.
+
+#### Hint
+
+- Ccw false can reverse solid (backface culling) and normal-vector orientation.
+
+### SFBool [ ] **convex** TRUE
+
+Whether all polygons in a shape are convex (true), or possibly concave (false) A convex polygon is planar, does not intersect itself, and has all interior angles \< 180 degrees. Interchange profile hint: only convex=true IndexedFaceSets are supported.
+
+#### Warning
+
+- Concave geometry may be invisible default convex=true.
+
+### SFFloat [ ] **creaseAngle** 0 <small>[0,∞)</small>
+
+*creaseAngle* defines angle (in radians) for determining whether adjacent polygons are drawn with sharp edges or smooth shading. If angle between normals of two adjacent polygons is less than creaseAngle, smooth shading is rendered across the shared line segment. Interchange profile hint: only 0 and π radians supported.
+
+#### Hint
+
+- CreaseAngle=0 means render all edges sharply, creaseAngle=3.14159 means render all edges smoothly.
+
+### SFBool [ ] **colorPerVertex** TRUE
+
+Whether Color node color values are applied to each vertex (true) or to each polygon face (false).
+
+#### See Also
+
+- [X3D Scene Authoring Hints, Color](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color){:target="_blank"}
+
+### SFBool [ ] **normalPerVertex** TRUE
+
+Whether Normal node vector values are applied to each vertex (true) or to each polygon face (false).
+
+### MFInt32 [ ] **colorIndex** [ ] <small>[0,∞) or -1</small>
+
+*colorIndex* values define the order in which Color|ColorRGBA values are applied to polygons (or vertices).
+
+#### Hints
+
+- If *colorIndex* array is not provided, then Color|ColorRGBA values are indexed according to the coordIndex field.
+- If colorPerVertex='false' then one index is provided for each polygon defined by the coordIndex array. No sentinel -1 values are included.
+- If colorPerVertex='true' then a matching set of indices is provided, each separated by sentinel -1, that exactly corresponds to individual
+
+### MFInt32 [ ] **texCoordIndex** [ ] <small>[-1,∞)</small>
+
+List of texture-coordinate indices mapping attached texture to corresponding coordinates.
+
+#### Hint
+
+- If *texCoordIndex* array is not provided, then TextureCoordinate values are indexed according to the coordIndex field.
+- Use a tool!
+
+### MFInt32 [ ] **normalIndex** [ ] <small>[0,∞) or -1</small>
+
+*normalIndex* values define the order in which normal vectors are applied to polygons (or vertices).
+
+#### Hints
+
+- If normalPerVertex='false' then one index is provided for each polygon defined by the coordIndex array. No sentinel -1 values are included.
+- If normalPerVertex='true' then a matching set of indices is provided, each separated by sentinel -1, that exactly corresponds to individual values in the coordIndex array polygon definitions.
+- If no child Normal node is provided, the X3D browser shall automatically generate normals, using creaseAngle to determine smoothed shading across shared vertices.
+
+#### Warning
+
+- If *normalIndex* array is not provided, then Normal values are indexed according to the coordIndex field.
+
+### MFInt32 [ ] **coordIndex** [ ] <small>[0,∞) or -1</small>
+
+*coordIndex* indices provide the order in which coordinates are applied to construct each polygon face. Order starts at index 0, commas are optional between sets.
+
+#### Hint
+
+- Sentinel value -1 is used to separate indices for each successive polygon.
+
+### MFNode [in, out] **attrib** [ ] <small>[X3DVertexAttributeNode]</small>
+
+Multiple contained FloatVertexAttribute nodes that can specify list of per-vertex attribute information for programmable shaders.
+
+#### Hint
+
+- [X3D Architecture 32.2.2.4 Per-vertex attributes](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/shaders.html#Pervertexattributes){:target="_blank"}
+
+### SFNode [in, out] **fogCoord** NULL <small>[FogCoordinate]</small>
+
+Single contained FogCoordinate node that can specify depth parameters for fog in corresponding geometry.
+
+### SFNode [in, out] **color** NULL <small>[X3DColorNode]</small>
+
+Single contained Color or ColorRGBA node that can specify color values applied to corresponding vertices according to colorIndex and colorPerVertex fields.
+
+### SFNode [in, out] **texCoord** NULL <small>[X3DTextureCoordinateNode]</small>
+
+Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate node that can specify coordinates for texture mapping onto corresponding geometry.
+
+### SFNode [in, out] **normal** NULL <small>[X3DNormalNode]</small>
+
+Single contained Normal node that can specify perpendicular vectors for corresponding vertices to support rendering computations, applied according to the normalPerVertex field.
+
+#### Hint
+
+- Useful for special effects. Normal vector computation by 3D graphics hardware is quite fast so adding normals to a scene is typically unnecessary.
+
+### SFNode [in, out] **coord** NULL <small>[X3DCoordinateNode]</small>
+
+Single contained Coordinate or CoordinateDouble node that can specify a list of vertex values.
+
+## Description
+
+### Hints
+
+- Insert a Shape node before adding geometry or Appearance.
+- You can also substitute a type-matched ProtoInstance node for contained content.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Geometry3D/IndexedFaceSet/IndexedFaceSet.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of IndexedFaceSet](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geometry3D.html#IndexedFaceSet){:target="_blank"}