x_ite 8.4.3 → 8.5.3

package/docs/_posts/components/EnvironmentalEffects/FogCoordinate.md

@@ -0,0 +1,40 @@
+---
+title: FogCoordinate
+date: 2022-01-07
+nav: components-EnvironmentalEffects
+categories: [components, EnvironmentalEffects]
+tags: [FogCoordinate, EnvironmentalEffects]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+FogCoordinate defines a set of explicit fog depths on a per-vertex basis, overriding Fog visibilityRange.
+
+The FogCoordinate node belongs to the **EnvironmentalEffects** component and its default container field is *fogCoord.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DGeometricPropertyNode
+    + FogCoordinate
+```
+
+## 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, out] **depth** [ ] <small>[0,1]</small>
+
+*depth* contains a set depth values.
+
+## External Links
+
+- [X3D Specification of FogCoordinate](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/environmentalEffects.html#FogCoordinate){:target="_blank"}

package/docs/_posts/components/EnvironmentalEffects/LocalFog.md

@@ -0,0 +1,84 @@
+---
+title: LocalFog
+date: 2022-01-07
+nav: components-EnvironmentalEffects
+categories: [components, EnvironmentalEffects]
+tags: [LocalFog, EnvironmentalEffects]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+LocalFog simulates atmospheric effects by blending distant objects with fog color. LocalFog effects occur around the local transformation center, rather than bound to the viewer. The nearest LocalFog node within range takes precedence over other LocalFog and Fog nodes.
+
+The LocalFog node belongs to the **EnvironmentalEffects** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + LocalFog (X3DFogObject)*
+```
+
+<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.
+
+### SFString [in, out] **fogType** "LINEAR" <small>["LINEAR"|"EXPONENTIAL"]</small>
+
+Specifies algorithm for rate of increasing Fog, either LINEAR or EXPONENTIAL.
+
+#### Hint
+
+- EXPONENTIAL is more natural but also more computationally expensive.
+
+#### Warning
+
+- Do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
+
+### SFColor [in, out] **color** 1 1 1 <small>[0,1]</small>
+
+Fog color.
+
+#### Hint
+
+- Match Background color to make objects fade away.
+
+#### See Also
+
+- [X3D Scene Authoring Hints, Color](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color){:target="_blank"}
+
+### SFFloat [in, out] **visibilityRange** 0 <small>[0,-∞)</small>
+
+Distance in meters where objects are totally obscured by the fog, using local coordinate system.
+
+#### Hint
+
+- VisibilityRange 0 disables Fog.
+
+## Description
+
+### Warning
+
+- LocalFog is not a bindable node.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/EnvironmentalEffects/LocalFog/LocalFog.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of LocalFog](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/environmentalEffects.html#LocalFog){:target="_blank"}

package/docs/_posts/components/EnvironmentalEffects/TextureBackground.md

@@ -0,0 +1,142 @@
+---
+title: TextureBackground
+date: 2022-01-07
+nav: components-EnvironmentalEffects
+categories: [components, EnvironmentalEffects]
+tags: [TextureBackground, EnvironmentalEffects]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+TextureBackground simulates ground and sky, using vertical arrays of wraparound color values, TextureBackground can also provide backdrop texture images on all six sides.
+
+The TextureBackground node belongs to the **EnvironmentalEffects** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DBindableNode
+      + X3DBackgroundNode
+        + TextureBackground
+```
+
+## 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] **set_bind**
+
+Input event set_bind=true makes this node active, input event set_bind=false makes this node inactive. Thus setting set_bind true/false will pop/push (enable/disable) this node.
+
+### MFFloat [in, out] **skyAngle** [ ] <small>[0,π]</small>
+
+The angle array values increase from 0.0 zenith (straight up) to π/2=1.570796 (horizon) to π=3.14159 (nadir).
+
+#### Warnings
+
+- You must have one more skyColor value than skyAngle values. Colors at skyAngle=0 are ignored. Interchange profile hint: this field may be ignored, applying the default value regardless.
+
+### MFColor [in, out] **skyColor** 0 0 0 <small>[0,1]</small>
+
+Color of the sky at various angles on the sky sphere. First value is color of sky at 0.0 radians representing the zenith (straight up).
+
+#### Hint
+
+- Setting the same color at two consecutive angles produces a solid color band.
+
+#### Warning
+
+- You must have one more skyColor value than skyAngle values. Interchange profile hint: only one color might be rendered, others can be ignored.
+
+#### See Also
+
+- [X3D Scene Authoring Hints, Color](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color){:target="_blank"}
+
+### MFFloat [in, out] **groundAngle** [ ] <small>[0,π/2]</small>
+
+The angle array values increase from 0.0 nadir (straight down) to π/2=1.570796 (horizon).
+
+#### Warnings
+
+- You must have one more groundColor value than groundAngle values. Colors at groundAngle=0 are ignored. Interchange profile hint: this field may be ignored, applying the default value regardless.
+
+### MFColor [in, out] **groundColor** [ ] <small>[0,1]</small>
+
+Color of the ground at the various angles on the ground partial sphere. First value is color of ground at 0.0 radians representing the nadir (straight down).
+
+#### Hint
+
+- Setting the same color at two consecutive angles produces a solid color band.
+
+#### Warning
+
+- You must have one more groundColor value than groundAngle values. Interchange profile hint: this field may be ignored, applying the default value regardless.
+
+#### See Also
+
+- [X3D Scene Authoring Hints, Color](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color){:target="_blank"}
+
+### SFFloat [in, out] **transparency** 0 <small>[0,1]</small>
+
+*transparency* applied to texture images, enabling an X3D scene to overlay an HTML page or desktop.
+
+### 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.
+
+### SFNode [in, out] **frontTexture** NULL <small>[X3DTexture2DNode,MultiTexture]</small>
+
+Input/Output field frontTexture.
+
+### SFNode [in, out] **backTexture** NULL <small>[X3DTexture2DNode,MultiTexture]</small>
+
+Input/Output field backTexture.
+
+### SFNode [in, out] **leftTexture** NULL <small>[X3DTexture2DNode,MultiTexture]</small>
+
+Input/Output field leftTexture.
+
+### SFNode [in, out] **rightTexture** NULL <small>[X3DTexture2DNode,MultiTexture]</small>
+
+Input/Output field rightTexture.
+
+### SFNode [in, out] **topTexture** NULL <small>[X3DTexture2DNode,MultiTexture]</small>
+
+Input/Output field topTexture.
+
+### SFNode [in, out] **bottomTexture** NULL <small>[X3DTexture2DNode,MultiTexture]</small>
+
+Input/Output field bottomTexture.
+
+## Description
+
+### Hints
+
+- NavigationInfo, Background, TextureBackground, Fog, OrthoViewpoint and Viewpoint are bindable nodes, meaning that no more than one of each node type can be active at a given time.
+- Authors can have LoadSensor nodes receive notification when background texture node(s) are loaded.
+
+### Warnings
+
+- Results are undefined if a bindable node (Viewpoint, OrthoViewpoint, NavigationInfo, Fog, Background, TextureBackground) is a contained child of LOD or Switch.
+- Child ImageTexture nodes must have unique containerField values for backTexture, bottomTexture, frontTexture, leftTexture, rightTexture, or topTexture.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/EnvironmentalEffects/TextureBackground/TextureBackground.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of TextureBackground](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/environmentalEffects.html#TextureBackground){:target="_blank"}

package/docs/_posts/components/EnvironmentalSensor/ProximitySensor.md

@@ -0,0 +1,90 @@
+---
+title: ProximitySensor
+date: 2022-01-07
+nav: components-EnvironmentalSensor
+categories: [components, EnvironmentalSensor]
+tags: [ProximitySensor, EnvironmentalSensor]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+ProximitySensor generates events when the viewer enters, exits and moves within a region of space (defined by a box).
+
+The ProximitySensor node belongs to the **EnvironmentalSensor** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DSensorNode
+      + X3DEnvironmentalSensorNode
+        + ProximitySensor
+```
+
+## 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] **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>(-∞,∞)</small>
+
+Position offset from origin of local coordinate system.
+
+### 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.
+
+### 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.
+
+### 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 Transform to relocate/reorient box.
+- Surround entire world to start behaviors once scene is loaded.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/EnvironmentalSensor/ProximitySensor/ProximitySensor.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of ProximitySensor](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/environmentalSensor.html#ProximitySensor){:target="_blank"}

package/docs/_posts/components/EnvironmentalSensor/TransformSensor.md

@@ -0,0 +1,91 @@
+---
+title: TransformSensor
+date: 2022-01-07
+nav: components-EnvironmentalSensor
+categories: [components, EnvironmentalSensor]
+tags: [TransformSensor, EnvironmentalSensor]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+TransformSensor generates output events when its targetObject enters, exits, and moves within a region in space (defined by a box).
+
+The TransformSensor node belongs to the **EnvironmentalSensor** component and its default container field is *children.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DSensorNode
+      + X3DEnvironmentalSensorNode
+        + TransformSensor
+```
+
+## 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] **size** 0 0 0 <small>[0,∞)</small>
+
+*size* of intersection box, measured from center in meters.
+
+### SFVec3f [in, out] **center** 0 0 0 <small>(-∞,∞)</small>
+
+Translation offset from origin of local coordinate system.
+
+### SFTime [out] **enterTime**
+
+Time event generated when targetObject enters the box region for sensor.
+
+### SFTime [out] **exitTime**
+
+Time event generated when targetObject exits the box region for sensor.
+
+### SFBool [out] **isActive**
+
+*isActive* true/false events are sent when triggering the sensor. isActive=true when targetObject enters the box region, isActive=false when targetObject exits the box region.
+
+### SFVec3f [out] **position_changed**
+
+Sends translation event relative to center whenever the target object is contained within the box region and results change.
+
+### SFRotation [out] **orientation_changed**
+
+Sends rotation event relative to center whenever the target object is contained within the box region and results change.
+
+### SFNode [in, out] **targetObject** NULL <small>[X3DGroupingNode|X3DShapeNode]</small>
+
+*targetObject* is the movable geometry represented by any valid X3DGroupingNode or X3DShapeNode which may enter or exit the box.
+
+## Description
+
+### Hints
+
+- Each TransformSensor node behaves independently of all other TransformSensor nodes, so that every enabled TransformSensor node affected by targetObject motion sends output events.
+- Multiply instanced (DEF/USE) TransformSensor nodes in different locations use the union of all boxes to check for enter and exit, detecting enter and exit for all instances of the box, and sending enter/exit events appropriately. For non-overlapping bounding boxes, position_changed and orientation_changed events are calculated relative to the coordinate system associated with the bounding box in which the proximity was detected.
+
+### Warnings
+
+- Results are undefined if boxes overlap for multiply instanced TransformSensor nodes.
+- A TransformSensor node with a zero-volume box (i.e. any size dimension equal to 0.0) cannot generate events, equivalent to enabled=false.
+- Unlike TouchSensor nodes, there is no notion of a TransformSensor node lower in the scene graph grabbing events.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/EnvironmentalSensor/TransformSensor/TransformSensor.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of TransformSensor](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/environmentalSensor.html#TransformSensor){:target="_blank"}

package/docs/_posts/components/EnvironmentalSensor/VisibilitySensor.md

@@ -0,0 +1,73 @@
+---
+title: VisibilitySensor
+date: 2022-01-07
+nav: components-EnvironmentalSensor
+categories: [components, EnvironmentalSensor]
+tags: [VisibilitySensor, EnvironmentalSensor]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+VisibilitySensor detects when user can see a specific object or region as they navigate the world. The region sensed for visibility to the user is bounded by a rectangular box.
+
+The VisibilitySensor node belongs to the **EnvironmentalSensor** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DSensorNode
+      + X3DEnvironmentalSensorNode
+        + VisibilitySensor
+```
+
+## 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] **size** 0 0 0 <small>[0,∞)</small>
+
+*size* of visibility box, measured from center in meters.
+
+### SFVec3f [in, out] **center** 0 0 0 <small>(-∞,∞)</small>
+
+Translation offset from origin of local coordinate system.
+
+### SFTime [out] **enterTime**
+
+Time event generated when user's camera enters visibility region for sensor.
+
+### SFTime [out] **exitTime**
+
+Time event generated when user's camera exits visibility region for sensor.
+
+### SFBool [out] **isActive**
+
+*isActive* true/false events are sent when triggering the sensor. isActive=true when entering visibility region, isActive=false when exiting visibility region.
+
+## Description
+
+### Hints
+
+- Often used to attract user attention or improve performance.
+- This sensor detects user interactions affecting peer nodes and their child geometry.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/EnvironmentalSensor/VisibilitySensor/VisibilitySensor.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of VisibilitySensor](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/environmentalSensor.html#VisibilitySensor){:target="_blank"}

package/docs/_posts/components/EventUtilities/BooleanFilter.md

@@ -0,0 +1,62 @@
+---
+title: BooleanFilter
+date: 2022-01-07
+nav: components-EventUtilities
+categories: [components, EventUtilities]
+tags: [BooleanFilter, EventUtilities]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+BooleanFilter selectively passes true, false or negated events.
+
+The BooleanFilter node belongs to the **EventUtilities** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + BooleanFilter
+```
+
+## 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] **set_boolean**
+
+*set_boolean* is the input value to be filtered.
+
+### SFBool [out] **inputFalse**
+
+*inputFalse* only passes a false value, which occurs when set_boolean is false.
+
+#### Hint
+
+- InputFalse can only provide a value of false.
+
+### SFBool [out] **inputTrue**
+
+*inputTrue* only passes a true value, which occurs when set_boolean input is true.
+
+#### Hint
+
+- InputTrue can only provide a value of true.
+
+### SFBool [out] **inputNegate**
+
+*inputNegate* provides an opposite value by negating set_boolean input.
+
+## External Links
+
+- [X3D Specification of BooleanFilter](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/eventUtilities.html#BooleanFilter){:target="_blank"}
+- [Example scenes and authoring assets at](https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting){:target="_blank"}
+- [X3D Event-Utility Nodes, Field Event Diagrams](https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting/X3dEventUtilityNodeEventDiagrams.pdf){:target="_blank"}

package/docs/_posts/components/EventUtilities/BooleanSequencer.md

@@ -0,0 +1,86 @@
+---
+title: BooleanSequencer
+date: 2022-01-07
+nav: components-EventUtilities
+categories: [components, EventUtilities]
+tags: [BooleanSequencer, EventUtilities]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+BooleanSequencer generates periodic discrete Boolean values that can be ROUTEd to other Boolean attributes.
+
+The BooleanSequencer node belongs to the **EventUtilities** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DSequencerNode
+      + BooleanSequencer
+```
+
+## 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.
+
+### SFFloat [in] **set_fraction**
+
+*set_fraction* selects input key for corresponding keyValue output.
+
+### SFBool [in] **previous**
+
+Send previous output value in keyValue array, and reset internal fraction field to match corresponding value in key array.
+
+#### Hint
+
+- "wrap around" boundary of keyValue array, i.e. continue from first to last if necessary.
+
+### SFBool [in] **next**
+
+Send next output value in keyValue array, and reset internal fraction field to match corresponding value in key array.
+
+#### Hint
+
+- "wrap around" boundary of keyValue array, i.e. continue from last to first if necessary.
+
+### 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!
+
+### MFBool [in, out] **keyValue** [ ] <small>[]</small>
+
+Output values for linear interpolation, each corresponding to time-fraction keys.
+
+#### Warning
+
+- Number of keys must match number of keyValues!
+
+### SFBool [out] **value_changed**
+
+Single intermittent output value determined by current key time and corresponding keyValue pair.
+
+## 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.
+
+## External Links
+
+- [X3D Specification of BooleanSequencer](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/eventUtilities.html#BooleanSequencer){:target="_blank"}
+- [Example scenes and authoring assets at](https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting){:target="_blank"}
+- [X3D Event-Utility Nodes, Field Event Diagrams](https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting/X3dEventUtilityNodeEventDiagrams.pdf){:target="_blank"}