x_ite 8.4.3 → 8.5.3

package/docs/_posts/components/KeyDeviceSensor/KeySensor.md

@@ -0,0 +1,78 @@
+---
+title: KeySensor
+date: 2022-01-07
+nav: components-KeyDeviceSensor
+categories: [components, KeyDeviceSensor]
+tags: [KeySensor, KeyDeviceSensor]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+KeySensor generates events as the user presses keys on the keyboard. Supports notion of "keyboard focus".
+
+The KeySensor node belongs to the **KeyDeviceSensor** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DSensorNode
+      + X3DKeyDeviceSensorNode
+        + KeySensor
+```
+
+## 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] **controlKey**
+
+*controlKey* generates true event when pressed, false event when released.
+
+### SFBool [out] **shiftKey**
+
+*shiftKey* generates true event when pressed, false event when released.
+
+### SFBool [out] **altKey**
+
+*altKey* generates true event when pressed, false event when released.
+
+### SFInt32 [out] **actionKeyPress**
+
+Action key press gives following values: F1..F12 = 1...12 HOME=13 END=14 PGUP=15 PGDN=16 UP=17 DOWN=18 LEFT=19 RIGHT=20.
+
+### SFInt32 [out] **actionKeyRelease**
+
+Action key release gives following values: F1..F12 = 1...12 HOME=13 END=14 PGUP=15 PGDN=16 UP=17 DOWN=18 LEFT=19 RIGHT=20.
+
+### SFString [out] **keyPress**
+
+Events generated when user presses character-producing keys on keyboard produces integer UTF-8 character values.
+
+### SFString [out] **keyRelease**
+
+Events generated when user releases character-producing keys on keyboard produces integer UTF-8 character values.
+
+### SFBool [out] **isActive**
+
+When a key is pressed, the KeySensor sends an isActive event with value true. Once the key is released, the KeySensor sends an isActive event with value false.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/KeyDeviceSensor/KeySensor/KeySensor.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of KeySensor](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/keyboard.html#KeySensor){:target="_blank"}

package/docs/_posts/components/KeyDeviceSensor/StringSensor.md

@@ -0,0 +1,70 @@
+---
+title: StringSensor
+date: 2022-01-07
+nav: components-KeyDeviceSensor
+categories: [components, KeyDeviceSensor]
+tags: [StringSensor, KeyDeviceSensor]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+StringSensor generates events as the user presses keys on the keyboard.
+
+The StringSensor node belongs to the **KeyDeviceSensor** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DSensorNode
+      + X3DKeyDeviceSensorNode
+        + StringSensor
+```
+
+## 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 [in, out] **deletionAllowed** TRUE
+
+If deletionAllowed is true, then previously entered character in enteredText can be removed. If deletionAllowed is false, then characters may only be added to the string.
+
+#### Hint
+
+- Deletion key is typically defined by local system.
+
+### SFString [out] **enteredText**
+
+Events generated as character-producing keys are pressed on keyboard.
+
+### SFString [out] **finalText**
+
+Events generated when sequence of keystrokes matches keys in terminationText string when this condition occurs, enteredText is moved to finalText and enteredText is set to empty string.
+
+#### Hint
+
+- Termination key is typically defined by local system.
+
+### SFBool [out] **isActive**
+
+When the user begins typing, the StringSensor sends an isActive event with value true. When the string is terminated, the StringSensor sends an isActive event with value false.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/KeyDeviceSensor/StringSensor/StringSensor.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of StringSensor](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/keyboard.html#StringSensor){:target="_blank"}

package/docs/_posts/components/Layering/Layer.md

@@ -0,0 +1,67 @@
+---
+title: Layer
+date: 2022-01-07
+nav: components-Layering
+categories: [components, Layering]
+tags: [Layer, Layering]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+Layer contains a list of children nodes that define the contents of the layer.
+
+The Layer node belongs to the **Layering** component and its default container field is *layers.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DLayerNode
+    + Layer
+```
+
+## 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] **isPickable** TRUE
+
+*isPickable* determines whether pick traversal is performed for this layer.
+
+### SFNode [in, out] **viewport** NULL <small>[X3DViewportNode]</small>
+
+The viewport field is a single Viewport node that constrains layer output to a sub-region of the render surface.
+
+### MFNode [in] **addChildren**
+
+Input field addChildren.
+
+### MFNode [in] **removeChildren**
+
+Input field removeChildren.
+
+### MFNode [in, out] **children** [ ] <small>[X3DChildNode]</small>
+
+Nodes making up this layer.
+
+#### Hint
+
+- No transformations are possible above each Layerset/Layer combination in the scene graph hierarchy.
+
+## Description
+
+### Hints
+
+- No transformations are possible above each Layerset/Layer combination in the scene graph hierarchy.
+- Each Layer node contains its own binding stacks and thus has its own viewpoints and navigation.
+
+## External Links
+
+- [X3D Specification of Layer](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/layering.html#Layer){:target="_blank"}

package/docs/_posts/components/Layering/LayerSet.md

@@ -0,0 +1,78 @@
+---
+title: LayerSet
+date: 2022-01-07
+nav: components-Layering
+categories: [components, Layering]
+tags: [LayerSet, Layering]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+LayerSet defines a list of layers and a rendering order. The rendering order is specified by the order field.
+
+The LayerSet node belongs to the **Layering** component and its default container field is *children.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + LayerSet
+```
+
+## 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.
+
+### SFInt32 [in, out] **activeLayer** <small>(0,∞)</small>
+
+*activeLayer* field specifies the layer in which navigation takes place.
+
+#### Hint
+
+- Nodes that are not part of a layer are considered to be in layer 0.
+
+### MFInt32 [in, out] **order** <small>(0,∞)</small>
+
+The order list defines the order in which layers are rendered. Each value corresponds to the ordinals of the layers.
+
+#### Hint
+
+- The order list may contain repetitions of ordinal values, in which case the layer is rendered again.
+
+#### Warnings
+
+- If order contains number values that are not ordinals assigned to layers, such numbers are ignored. Layers that are not included in the order list are not rendered.
+
+### MFNode [in, out] **layers** [ ] <small>[X3DLayerNode]</small>
+
+The layers list defines a list of Layer nodes that contain the constituent parts of the scene. Each layer is assigned an ordinal number depending on its position in this contained list of nodes.
+
+#### Hints
+
+- Ordinal values start with the numeral 1 representing the first item in the list. Nodes that are not part of a layer are considered to be in layer 0.
+
+## Description
+
+### Hint
+
+- The layer first specified in the order field is the first layer rendered and appears below any other layers. The layer last specified in the order field is the last layer rendered and correspondingly appears on top of all other layers.
+
+### Warning
+
+- Only one LayerSet node is allowed in a scene, and it shall be a root node at the top of the scene graph.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Layering/LayerSet/LayerSet.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of LayerSet](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/layering.html#LayerSet){:target="_blank"}
+- [X3D Abstract Specification 35.2.1 Overview of layering](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/layering.html#OverviewOfLayering){:target="_blank"}

package/docs/_posts/components/Layering/Viewport.md

@@ -0,0 +1,80 @@
+---
+title: Viewport
+date: 2022-01-07
+nav: components-Layering
+categories: [components, Layering]
+tags: [Viewport, Layering]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+Viewport is a Grouping node that can contain most nodes. Viewport specifies a set of rectangular clip boundaries against which the children nodes are clipped as they are rendered.
+
+The Viewport node belongs to the **Layering** component and its default container field is *viewport.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DGroupingNode
+      + X3DViewportNode
+        + Viewport (X3DBoundedObject)*
+```
+
+<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.
+
+### MFFloat [in, out] **clipBoundary** [ 0, 1, 0, 1 ] <small>[0,1]</small>
+
+*clipBoundary* is specified in fractions of the normal render surface in the sequence left/right/bottom/top. When children are rendered, the output will only appear in the specified subset of the render surface.
+
+#### Hint
+
+- Default value 0 1 0 1 indicates 0-1 left-to-right and 0-1 bottom-to-top, meaning full view.
+
+### 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.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Layering/Viewport/Viewport.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of Viewport](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/layering.html#Viewport){:target="_blank"}

package/docs/_posts/components/Layout/Layout.md

@@ -0,0 +1,107 @@
+---
+title: Layout
+date: 2022-01-07
+nav: components-Layout
+categories: [components, Layout]
+tags: [Layout, Layout]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+Layout node is used as layout field of LayoutLayer and LayoutGroup nodes. Layout provides all parameters required to define the size, location and scale of a 2D rectangular region.
+
+The Layout node belongs to the **Layout** component and its default container field is *layout.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DLayoutNode
+      + Layout
+```
+
+## 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.
+
+### MFString [in, out] **align** [ "CENTER", "CENTER" ] <small>["LEFT"|"CENTER"|"RIGHT"]</small>
+
+The align field values align the sized rectangle to an edge or center of the parent rectangle. Two quoted string values are provided. The first value is for horizontal direction (LEFT \| CENTER \| RIGHT) and the second value is for vertical direction (BOTTOM \| CENTER \| TOP). Examples: "CENTER" "CENTER" (default value), "LEFT" "TOP" or "RIGHT" "BOTTOM".
+
+#### Hint
+
+- MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
+
+#### Warnings
+
+- Two values (or possibly one value) only. If the align field has only one value, that value shall be "CENTER" and apply both horizontally and vertically.
+
+### MFString [in, out] **offsetUnits** [ "WORLD", "WORLD" ] <small>["WORLD"|"FRACTION"|"PIXEL"]</small>
+
+The offsetUnits field values are used to interprete the offset values. Two quoted string values are provided. The first value is for horizontal offset, and the second value is for vertical offset. Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL".
+
+#### Hints
+
+- If the value of the offsetUnits field is FRACTION, the size of the corresponding dimension is interpreted as a fraction of the corresponding parent’s dimension. MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
+
+#### Warning
+
+- If only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
+
+### MFFloat [in, out] **offset** [ 0, 0 ] <small>(-∞,∞)</small>
+
+The values of the offset field are used to translate the location of this rectangle after the initial alignment. The offsetUnits field specifies how to interpret the offset field.
+
+#### Warning
+
+- If only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
+
+### MFString [in, out] **sizeUnits** [ "WORLD", "WORLD" ] <small>["WORLD"|"FRACTION"|"PIXEL"]</small>
+
+The sizeUnits field values are used to interprete the offset values. Two quoted string values are provided. The first value is for horizontal size, and the second value is for vertical size. Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL".
+
+#### Hints
+
+- If the value of the sizeUnits field is FRACTION, the size of the corresponding dimension is interpreted as a fraction of the corresponding parent’s dimension. MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
+
+#### Warning
+
+- If only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
+
+### MFFloat [in, out] **size** [ 1, 1 ] <small>(0,∞)</small>
+
+The two values in the size field define the width and height of the layout rectangle. The sizeUnits field specifies how to interpret the size values.
+
+#### Warning
+
+- If only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
+
+### MFString [in, out] **scaleMode** [ "NONE", "NONE" ] <small>["NONE"|"FRACTION"|"STRETCH"|"PIXEL"]</small>
+
+The scaleMode field specifies how the scale of the parent is modified. Two quoted string values are provided. The first value is for horizontal scale and the second value is for vertical scale. Examples: "NONE" "NONE" (default value), "FRACTION" "FRACTION", "STRETCH" "STRETCH" or "PIXEL" "PIXEL".
+
+#### Hints
+
+- A scaleMode field value of NONE specifies that the corresponding scale value is not modified. Instead, the scale is inherited from its parent. Since a LayoutLayer node does not have a parent, the value of NONE reverts to FRACTION. A scaleMode value of FRACTION specifies a scale in the corresponding direction so that one unit is equal to the dimension (width or height) of this rectangle. A scaleMode value of STRETCH specifies a scale in the corresponding direction such that the resulting scale in the horizontal direction is equal to the scale in the vertical direction, thus producing a uniform scale. A value of PIXEL specifies a scale in the corresponding direction such that one unit is equal to one pixel. MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
+
+#### Warning
+
+- If only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
+
+## Description
+
+### Hint
+
+- The align, offset, and offsetUnits fields are used to determine the location of the layout region.
+
+## External Links
+
+- [X3D Specification of Layout](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/layout.html#Layout){:target="_blank"}

package/docs/_posts/components/Layout/LayoutGroup.md

@@ -0,0 +1,85 @@
+---
+title: LayoutGroup
+date: 2022-01-07
+nav: components-Layout
+categories: [components, Layout]
+tags: [LayoutGroup, Layout]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+LayoutGroup is a Grouping node that can contain most nodes, whose children are related by a common layout within a parent layout. The layout field contains an X3DLayoutNode node that provides the information required to locate and size the layout region of the LayoutGroup node relative to its parent’s layout region. LayoutGroup content is clipped by the specified viewport node.
+
+The LayoutGroup node belongs to the **Layout** component and its default container field is *children.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DChildNode
+    + X3DGroupingNode
+      + LayoutGroup
+```
+
+## 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 [in, out] **layout** NULL <small>[X3DLayoutNode]</small>
+
+The layout field contains an X3DLayoutNode node that provides the information required to locate and size the layout region of the LayoutGroup node relative to its parent’s layout region, and also to scale the contents of the LayoutGroup.
+
+### SFNode [in, out] **viewport** NULL <small>[X3DViewportNode]</small>
+
+The content of the LayoutGroup is clipped by the specified viewport.
+
+### SFVec3f [ ] **bboxSize** -1 -1 -1 <small>(-∞,∞)</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
+
+- The origin of the node is always in the center of its layout region. Thus, children (with the exception of LayoutGroup) are specified in a coordinate system whose origin is located at the center of the rectangle and can be transformed from that location.
+- Insert a Shape node before adding geometry or Appearance.
+- LayoutGroup does not directly have any pixel-dependent concepts. However, it can contain a Layout node that does have pixel-specific options.
+
+### Warning
+
+- A LayoutGroup can only be a child of a LayoutLayer node or another LayoutGroup node.
+
+## External Links
+
+- [X3D Specification of LayoutGroup](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/layout.html#LayoutGroup){:target="_blank"}

package/docs/_posts/components/Layout/LayoutLayer.md

@@ -0,0 +1,74 @@
+---
+title: LayoutLayer
+date: 2022-01-07
+nav: components-Layout
+categories: [components, Layout]
+tags: [LayoutLayer, Layout]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+LayoutLayer is a Grouping node that can contain most nodes. LayoutLayer content is clipped by the specified viewport node.
+
+The LayoutLayer node belongs to the **Layout** component and its default container field is *layers.* It is available since X3D version 3.2 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DLayerNode
+    + LayoutLayer
+```
+
+## 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] **isPickable** TRUE
+
+*isPickable* determines whether pick traversal is performed for this layer.
+
+### SFNode [in, out] **layout** NULL <small>[X3DLayoutNode]</small>
+
+The layout field contains an X3DLayoutNode node that provides the information required to locate and size the layout region of the LayoutGroup node relative to its parent’s layout region, and also to scale the contents of the LayoutGroup.
+
+### SFNode [in, out] **viewport** NULL <small>[X3DViewportNode]</small>
+
+The content of the LayoutGroup is clipped by the specified viewport.
+
+### 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.
+
+### Warning
+
+- Better functional description needed in X3D specification.
+
+## External Links
+
+- [X3D Specification of LayoutLayer](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/layout.html#LayoutLayer){:target="_blank"}