x_ite 8.4.3 → 8.5.3

package/docs/_posts/components/Geospatial/GeoPositionInterpolator.md

@@ -0,0 +1,95 @@
+---
+title: GeoPositionInterpolator
+date: 2022-01-07
+nav: components-Geospatial
+categories: [components, Geospatial]
+tags: [GeoPositionInterpolator, Geospatial]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+GeoPositionInterpolator animates objects within a geographic coordinate system. GeoPositionInterpolator can contain a GeoOrigin node.
+
+The GeoPositionInterpolator node belongs to the **Geospatial** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DInterpolatorNode
+      + GeoPositionInterpolator
+```
+
+## 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.
+
+### SFNode [ ] **geoOrigin** NULL <small>[GeoOrigin] (deprecated)</small>
+
+Field geoOrigin.
+
+### MFString [ ] **geoSystem** [ "GD", "WE" ]
+
+Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type.
+
+#### Warning
+
+- Deprecated values are GDC (use GD) and GCC (use GC).
+
+#### See Also
+
+- [See X3D Specification 25.2.2 Spatial reference frames](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geospatial.html#Spatialreferenceframes){:target="_blank"}
+- [See X3D Specification 25.2.4 Specifying geospatial coordinates](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geospatial.html#Specifyinggeospatialcoords){:target="_blank"}
+- [UTM is Universal Transverse Mercator coordinate system](https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system){:target="_blank"}
+
+### SFFloat [in] **set_fraction** <small>(-∞,∞)</small>
+
+*set_fraction* selects input key for corresponding keyValue output.
+
+### MFFloat [in, out] **key** [ ] <small>(-∞,∞)</small>
+
+Definition parameters for linear-interpolation function time intervals, in increasing order and corresponding to keyValues.
+
+#### Warning
+
+- Number of keys must match number of keyValues!
+
+### MFVec3d [in, out] **keyValue** [ ]
+
+Output values for linear interpolation, each corresponding to time-fraction keys.
+
+#### Warning
+
+- Number of keys must match number of keyValues!
+
+### SFVec3d [out] **value_changed**
+
+Linearly interpolated output value determined by current key time and corresponding keyValue pair.
+
+### SFVec3d [out] **geovalue_changed**
+
+Interpolated coordinate in the geographic coordinate system specified by geoSystem
+
+#### Hint
+
+- Include `<component name='Geospatial' level='1'/>`
+
+## Description
+
+### Hints
+
+- Typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction
+- Typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
+- Include `<component name='Geospatial' level='1'/>`
+
+## External Links
+
+- [X3D Specification of GeoPositionInterpolator](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geospatial.html#GeoPositionInterpolator){:target="_blank"}

package/docs/_posts/components/Geospatial/GeoProximitySensor.md

@@ -0,0 +1,109 @@
+---
+title: GeoProximitySensor
+date: 2022-01-07
+nav: components-Geospatial
+categories: [components, Geospatial]
+tags: [GeoProximitySensor, Geospatial]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+GeoProximitySensor generates events when the viewer enters, exits and moves within a region of space (defined by a box).
+
+The GeoProximitySensor node belongs to the **Geospatial** component and its default container field is *children.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DSensorNode
+      + X3DEnvironmentalSensorNode
+        + GeoProximitySensor
+```
+
+## 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.
+
+### SFNode [ ] **geoOrigin** NULL <small>[GeoOrigin] (deprecated)</small>
+
+Field geoOrigin.
+
+### MFString [ ] **geoSystem** [ "GD", "WE" ]
+
+Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type.
+
+#### Warning
+
+- Deprecated values are GDC (use GD) and GCC (use GC).
+
+#### See Also
+
+- [See X3D Specification 25.2.2 Spatial reference frames](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geospatial.html#Spatialreferenceframes){:target="_blank"}
+- [See X3D Specification 25.2.4 Specifying geospatial coordinates](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geospatial.html#Specifyinggeospatialcoords){:target="_blank"}
+- [UTM is Universal Transverse Mercator coordinate system](https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system){:target="_blank"}
+
+### SFBool [in, out] **enabled** TRUE
+
+Enables/disables node operation.
+
+### SFVec3f [in, out] **size** 0 0 0 <small>[0,∞)</small>
+
+*size* of Proximity box.
+
+#### Hint
+
+- Size 0 0 0 is same as enabled false.
+
+### SFVec3f [in, out] **center** 0 0 0 <small>(-∞,∞) (starting with vs. 3.3)</small>
+
+(starting with v3.3) Position offset from origin of local coordinate system.
+
+### SFBool [out] **isActive**
+
+*isActive* true/false events are sent as viewer enters/exits Proximity box. isActive=true when viewer enters Proximity box, isActive=false when viewer exits Proximity box.
+
+### SFTime [out] **enterTime**
+
+Time event generated when user's camera enters the box.
+
+### SFTime [out] **exitTime**
+
+Time event generated when user's camera exits the box.
+
+### SFVec3d [out] **geoCoord_changed**
+
+Output field geoCoord_changed.
+
+### SFVec3f [out] **position_changed**
+
+Sends translation event relative to center.
+
+### SFRotation [out] **orientation_changed**
+
+Sends rotation event relative to center.
+
+### SFVec3f [out] **centerOfRotation_changed**
+
+Sends changed centerOfRotation values, likely caused by user interaction.
+
+## Description
+
+### Hints
+
+- Multiple USEd instances are cumulative, but avoid overlaps.
+- Can first use GeoTransform to relocate/reorient box.
+- Surround entire world to start behaviors once scene is loaded.
+- Include `<component name='Geospatial' level='2'/>`
+
+## External Links
+
+- [X3D Specification of GeoProximitySensor](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geospatial.html#GeoProximitySensor){:target="_blank"}

package/docs/_posts/components/Geospatial/GeoTouchSensor.md

@@ -0,0 +1,108 @@
+---
+title: GeoTouchSensor
+date: 2022-01-07
+nav: components-Geospatial
+categories: [components, Geospatial]
+tags: [GeoTouchSensor, Geospatial]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+GeoTouchSensor returns geographic coordinates for the object being selected. GeoTouchSensor can contain a GeoOrigin node.
+
+The GeoTouchSensor node belongs to the **Geospatial** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DSensorNode
+      + X3DPointingDeviceSensorNode
+        + X3DTouchSensorNode
+          + GeoTouchSensor
+```
+
+## 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.
+
+### SFNode [ ] **geoOrigin** NULL <small>[GeoOrigin] (deprecated)</small>
+
+Field geoOrigin.
+
+### MFString [ ] **geoSystem** [ "GD", "WE" ]
+
+Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type.
+
+#### Warning
+
+- Deprecated values are GDC (use GD) and GCC (use GC).
+
+#### See Also
+
+- [See X3D Specification 25.2.2 Spatial reference frames](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geospatial.html#Spatialreferenceframes){:target="_blank"}
+- [See X3D Specification 25.2.4 Specifying geospatial coordinates](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geospatial.html#Specifyinggeospatialcoords){:target="_blank"}
+- [UTM is Universal Transverse Mercator coordinate system](https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system){:target="_blank"}
+
+### SFString [in, out] **description** ""
+
+Author-provided text tooltip that tells users the expected action of this node.
+
+#### Hints
+
+- Use spaces, make descriptions clear and readable. Many XML tools substitute XML character references automatically if needed (such as &amp;#38; for &amp; ampersand, or &amp;#34; for " quotation mark).
+
+### SFBool [in, out] **enabled** TRUE
+
+Enables/disables node operation.
+
+### SFVec2f [out] **hitTexCoord_changed**
+
+Output event containing texture coordinates of surface at the hitGeoCoordinate.
+
+### SFVec3f [out] **hitNormal_changed**
+
+Output event containing surface normal vector at the hitGeoCoordinate.
+
+### SFVec3f [out] **hitPoint_changed**
+
+Output event containing 3D point on surface of underlying geometry, given in geometry coordinates (not geographic coordinates).
+
+### SFVec3d [out] **hitGeoCoord_changed**
+
+Output event containing 3D point on surface of underlying geometry, given in GeoTouchSensor's local coordinate system.
+
+### SFBool [out] **isOver**
+
+Is pointing device over sensor's geometry?.
+
+### SFBool [out] **isActive**
+
+Select geometry by activating the pointing device (e.g. clicking the mouse) to generate isActive events. Output event isActive=true is sent when geometry is selected (e.g. when primary mouse button is pressed), output event isActive=false is sent when geometry is deselected (e.g. when primary mouse button is released).
+
+### SFTime [out] **touchTime**
+
+Time event generated when touched.
+
+#### Hint
+
+- TouchTime event is generated when following three conditions are all met: (a) pointing device was pointing towards geometry when initially activated (isActive=true), (b) pointing device is currently pointing towards the geometry (isOver=true), and (c) pointing device selection is deactivated/deselected by user (isActive=false event is also generated).
+
+## Description
+
+### Hints
+
+- This sensor detects user interactions affecting peer nodes and their child geometry.
+- Include `<component name='Geospatial' level='1'/>`
+
+## External Links
+
+- [X3D Specification of GeoTouchSensor](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geospatial.html#GeoTouchSensor){:target="_blank"}

package/docs/_posts/components/Geospatial/GeoTransform.md

@@ -0,0 +1,121 @@
+---
+title: GeoTransform
+date: 2022-01-07
+nav: components-Geospatial
+categories: [components, Geospatial]
+tags: [GeoTransform, Geospatial]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+GeoTransform is a Grouping node that can contain most nodes. GeoTransform translates, orients and scales GeoCoordinate geometry within the local world coordinate system. GeoTransform coordinate system X-Z plane is tangent to ellipsoid of local spatial reference frame.
+
+The GeoTransform node belongs to the **Geospatial** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DGroupingNode
+      + GeoTransform
+```
+
+## 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] **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>[-1,1] or (-∞,∞)</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 [in, out] **scale** 1 1 1 <small>(0,∞)</small>
+
+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.
+
+### SFRotation [in, out] **scaleOrientation** 0 0 1 0 <small>[-1,1] or (-∞,∞)</small>
+
+Preliminary rotation of coordinate system before scaling (to allow scaling around arbitrary orientations).
+
+#### Hint
+
+- The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
+
+### SFNode [ ] **geoOrigin** NULL <small>[GeoOrigin] (deprecated)</small>
+
+Field geoOrigin.
+
+### MFString [ ] **geoSystem** [ "GD", "WE" ]
+
+Field geoSystem.
+
+### SFVec3d [in, out] **geoCenter** 0 0 0 <small>(-∞,∞)</small>
+
+Input/Output field geoCenter.
+
+### 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.
+
+### MFNode [in] **addChildren**
+
+Input field addChildren.
+
+### MFNode [in] **removeChildren**
+
+Input field removeChildren.
+
+### MFNode [in, out] **children** [ ] <small>[X3DChildNode]</small>
+
+Grouping nodes contain a list of children nodes.
+
+#### Hint
+
+- 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.
+
+## Description
+
+### Hints
+
+- +Y axis is up.
+- Insert a Shape node before adding geometry or Appearance.
+- Include `<component name='Geospatial' level='2'/>`
+
+### Warning
+
+- Avoid having GeoLocation or GeoTransform as a parent of ancestor node, since multiple geospatial transformations then occur with unpredictable results.
+
+## External Links
+
+- [X3D Specification of GeoTransform](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geospatial.html#GeoTransform){:target="_blank"}

package/docs/_posts/components/Geospatial/GeoViewpoint.md

@@ -0,0 +1,126 @@
+---
+title: GeoViewpoint
+date: 2022-01-07
+nav: components-Geospatial
+categories: [components, Geospatial]
+tags: [GeoViewpoint, Geospatial]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+GeoViewpoint specifies viewpoints using geographic coordinates. GeoViewpoint can contain a GeoOrigin node. Since GeoViewpoint must navigate smoothly inside a curved geographic coordinate system, it includes both Viewpoint and NavigationInfo attributes.
+
+The GeoViewpoint node belongs to the **Geospatial** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DBindableNode
+      + X3DViewpointNode
+        + GeoViewpoint
+```
+
+## 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.
+
+### SFNode [ ] **geoOrigin** NULL <small>[GeoOrigin] (deprecated)</small>
+
+Field geoOrigin.
+
+### MFString [ ] **geoSystem** [ "GD", "WE" ]
+
+Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type.
+
+#### Warning
+
+- Deprecated values are GDC (use GD) and GCC (use GC).
+
+#### See Also
+
+- [See X3D Specification 25.2.2 Spatial reference frames](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geospatial.html#Spatialreferenceframes){:target="_blank"}
+- [See X3D Specification 25.2.4 Specifying geospatial coordinates](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geospatial.html#Specifyinggeospatialcoords){:target="_blank"}
+- [UTM is Universal Transverse Mercator coordinate system](https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system){:target="_blank"}
+
+### SFBool [in] **set_bind**
+
+*set_bind* true makes this node active, set_bind false makes this node inactive.
+
+### SFString [in, out] **description** ""
+
+Author-provided text tooltip that tells users the expected action of this node.
+
+#### Hints
+
+- Use spaces, make descriptions clear and readable. Many XML tools substitute XML character references automatically if needed (such as &amp;#38; for &amp; ampersand, or &amp;#34; for " quotation mark).
+
+### SFVec3d [in, out] **position** 0 0 100000 <small>(-∞,∞)</small>
+
+*position* relative to local georeferenced coordinate system, in proper format
+
+### SFRotation [in, out] **orientation** 0 0 1 0 <small>(-∞,∞) or -1 1</small>
+
+Rotation of Viewpoint, relative to default -Z axis direction in local coordinate system.
+
+#### Hint
+
+- This is orientation \_change\_ from default direction (0 0 -1) +Y axis is the up vector for the local area (the normal to the tangent plane on the ellipsoid), -Z points towards the north pole, and +X is east 1 0 0 -1.570796 always looks down.
+
+### SFVec3d [in, out] **centerOfRotation** 0 0 0 <small>(-∞,∞)</small>
+
+*centerOfRotation* specifies center point about which to rotate user's eyepoint when in EXAMINE or LOOKAT mode.
+
+### SFFloat [in, out] **fieldOfView** π/4 <small>(0,π)</small>
+
+Preferred minimum viewing angle from this viewpoint in radians. Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens.
+
+### SFBool [in, out] **jump** TRUE
+
+Whether to transition instantly by jumping, or else smoothly animate to this Viewpoint.
+
+### SFBool [in, out] **retainUserOffsets** FALSE
+
+Input/Output field retainUserOffsets.
+
+### SFFloat [ ] **speedFactor** 1 <small>[0,∞)</small>
+
+*speedFactor* is a multiplier to modify the original elevation-based speed that is set automatically by the browser.
+
+#### Hint
+
+- SpeedFactor is a relative value and not an absolute speed as defined by NavigationInfo.
+
+### SFBool [out] **isBound**
+
+Event true sent when node becomes active, event false sent when unbound by another node.
+
+### SFTime [out] **bindTime**
+
+Event sent when node becomes active/inactive.
+
+## Description
+
+### Hint
+
+- Include `<component name='Geospatial' level='1'/>`
+
+### Warning
+
+- The navType and headlight fields were removed as part of X3D version 3.3, instead use a NavigationInfo node for those fields.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Geospatial/GeoViewpoint/GeoViewpoint.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of GeoViewpoint](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/geospatial.html#GeoViewpoint){:target="_blank"}

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

@@ -0,0 +1,75 @@
+---
+title: Group
+date: 2022-01-07
+nav: components-Grouping
+categories: [components, Grouping]
+tags: [Group, Grouping]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+Group is a Grouping node that can contain most nodes.
+
+The Group node belongs to the **Grouping** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DGroupingNode
+      + Group
+```
+
+## 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 [ ] **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.
+
+### MFNode [in] **addChildren**
+
+Input field addChildren.
+
+### MFNode [in] **removeChildren**
+
+Input field removeChildren.
+
+### MFNode [in, out] **children** [ ] <small>[X3DChildNode]</small>
+
+Grouping nodes contain a list of children nodes.
+
+#### Hint
+
+- 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.
+
+## Description
+
+### Hint
+
+- Insert a Shape node before adding geometry or Appearance.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Grouping/Group/Group.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of Group](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/grouping.html#Group){:target="_blank"}