x_ite 8.4.3 → 8.5.3

package/docs/_posts/components/Shaders/PackagedShader.md

@@ -0,0 +1,77 @@
+---
+title: PackagedShader
+date: 2022-01-07
+nav: components-Shaders
+categories: [components, Shaders]
+tags: [PackagedShader, Shaders]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+PackagedShader describes a single file that may contain a number of shaders and combined effects.
+
+The PackagedShader node belongs to the **Shaders** component and its default container field is *shaders.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DAppearanceChildNode
+    + X3DShaderNode
+      + PackagedShader (X3DUrlObject, X3DProgrammableShaderObject)*
+```
+
+<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.
+
+### MFString [in, out] **url** [ ] <small>[URI]</small>
+
+Input/Output field url.
+
+### SFBool [in] **activate**
+
+*activate* forces the shader to activate the contained objects.
+
+### SFBool [out] **isSelected**
+
+*isSelected* indicates this shader instance is selected for use by browser
+
+### SFBool [out] **isValid**
+
+*isValid* indicates whether current shader objects can be run as a shader program.
+
+### SFString [ ] **language** "" <small>["Cg"|"GLSL"|"HLSL"|...]</small>
+
+The language field indicates to the X3D player which shading language is used. The language field may be used to optionally determine the language type if no MIME-type information is available.
+
+#### Hint
+
+- Recognized values include "CG" "GLSL" "HLSL" "FX"
+
+#### See Also
+
+- [Relates to Internationalization (i18n)](https://www.w3.org/standards/webdesign/i18n){:target="_blank"}
+
+## Description
+
+### Hint
+
+- PackagedShader contains IS/connect and field definitions.
+
+### Warning
+
+- PackagedShader can contain field declarations, but no CDATA section of plain-text source code.
+
+## External Links
+
+- [X3D Specification of PackagedShader](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shaders.html#PackagedShader){:target="_blank"}

package/docs/_posts/components/Shaders/ProgramShader.md

@@ -0,0 +1,71 @@
+---
+title: ProgramShader
+date: 2022-01-07
+nav: components-Shaders
+categories: [components, Shaders]
+tags: [ProgramShader, Shaders]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+ProgramShader defines a shader that consists of one or more individually programmable, self-contained pieces. ProgramShader contains IS/connect, programs [ShaderProgram] nodes and field definitions.
+
+The ProgramShader node belongs to the **Shaders** component and its default container field is *shaders.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DAppearanceChildNode
+    + X3DShaderNode
+      + ProgramShader
+```
+
+## 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] **activate**
+
+*activate* forces the shader to activate the contained objects.
+
+### SFBool [out] **isSelected**
+
+*isSelected* indicates this shader instance is selected for use by browser
+
+### SFBool [out] **isValid**
+
+*isValid* indicates whether current shader objects can be run as a shader program.
+
+### SFString [ ] **language** "" <small>["Cg"|"GLSL"|"HLSL"|...]</small>
+
+The language field indicates to the X3D player which shading language is used. The language field may be used to optionally determine the language type if no MIME-type information is available.
+
+#### Hint
+
+- Recognized values include "CG" "GLSL" "HLSL" "FX"
+
+#### See Also
+
+- [Relates to Internationalization (i18n)](https://www.w3.org/standards/webdesign/i18n){:target="_blank"}
+
+### MFNode [in, out] **programs** [ ] <small>[ShaderProgram]</small>
+
+Input/Output field programs.
+
+## Description
+
+### Warning
+
+- ProgramShader contains no field declarations and no plain-text source code.
+
+## External Links
+
+- [X3D Specification of ProgramShader](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shaders.html#ProgramShader){:target="_blank"}

package/docs/_posts/components/Shaders/ShaderPart.md

@@ -0,0 +1,76 @@
+---
+title: ShaderPart
+date: 2022-01-07
+nav: components-Shaders
+categories: [components, Shaders]
+tags: [ShaderPart, Shaders]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+ShaderPart defines the source for a portion of source code used by a ComposedShader node. The source is not required to be a complete shader for all of the vertex/fragment processing.
+
+The ShaderPart node belongs to the **Shaders** component and its default container field is *parts.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + ShaderPart (X3DUrlObject)*
+```
+
+<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.
+
+### SFString [ ] **type** "VERTEX" <small>["VERTEX"|"FRAGMENT"]</small>
+
+*type* indicates whether this ShaderProgram is a vertex or fragment (pixel) shader.
+
+#### Warning
+
+- Do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
+
+### MFString [in, out] **url** [ ] <small>[URI]</small>
+
+Location and filename of shader. Multiple locations are more reliable, and including a Web address lets e-mail attachments work.
+
+#### Hints
+
+- MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc." XML encoding for quotation mark " is &amp;quot; (which is called a character entity). Can replace embedded blank(s) in url queries with %20 for each blank character.
+
+#### Warning
+
+- Strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https and other operating systems are not.
+
+#### See Also
+
+- [X3D Scene Authoring Hints](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls){:target="_blank"}
+
+## Description
+
+### Hints
+
+- ShaderPart can contain a CDATA section of plain-text source code.
+- ShaderPart subprograms are written in the same language, which is specified in the parent ComposedShader node.
+
+### Warning
+
+- ShaderPart contains no field definitions.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Shaders/ShaderPart/ShaderPart.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of ShaderPart](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shaders.html#ShaderPart){:target="_blank"}

package/docs/_posts/components/Shaders/ShaderProgram.md

@@ -0,0 +1,68 @@
+---
+title: ShaderProgram
+date: 2022-01-07
+nav: components-Shaders
+categories: [components, Shaders]
+tags: [ShaderProgram, Shaders]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+ShaderProgram is contained by ProgramShader and provides the source and interface to a self-contained program that occupies one part of the rendering process: either a vertex or fragment shader.
+
+The ShaderProgram node belongs to the **Shaders** component and its default container field is *programs.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + ShaderProgram (X3DUrlObject, X3DProgrammableShaderObject)*
+```
+
+<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.
+
+### SFString [ ] **type** "VERTEX" <small>["VERTEX"|"FRAGMENT"]</small>
+
+*type* indicates whether this ShaderProgram is a vertex or fragment (pixel) shader.
+
+#### Warning
+
+- Do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
+
+### MFString [in, out] **url** [ ] <small>[URI]</small>
+
+Location and filename of shader. Multiple locations are more reliable, and including a Web address lets e-mail attachments work.
+
+#### Hints
+
+- MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc." XML encoding for quotation mark " is &amp;quot; (which is called a character entity). Can replace embedded blank(s) in url queries with %20 for each blank character.
+
+#### Warning
+
+- Strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https and other operating systems are not.
+
+#### See Also
+
+- [X3D Scene Authoring Hints, urls](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls){:target="_blank"}
+
+## Description
+
+### Hints
+
+- ShaderProgram contains IS/connect and field definitions.
+- ShaderProgram can contain a CDATA section of plain-text source code.
+
+## External Links
+
+- [X3D Specification of ShaderProgram](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shaders.html#ShaderProgram){:target="_blank"}

package/docs/_posts/components/Shape/AcousticProperties.md

@@ -0,0 +1,52 @@
+---
+title: AcousticProperties
+date: 2023-01-31
+nav: components-Shape
+categories: [components, Shape]
+tags: [AcousticProperties, Shape]
+---
+<style>
+.post h3 {
+   word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+AcousticProperties ...
+
+The AcousticProperties node belongs to the **Shape** component and its default container field is *AcousticProperties.* It is available since X3D version 4.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+```
+
+## 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.
+
+### SFString [in, out] **description** ""
+
+Author-provided prose that describes intended purpose of the url asset.
+
+#### Hint
+
+- Many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &amp;#38; for & ampersand character, or &amp;#34; for " quotation-mark character).
+
+### SFBool [in, out] **enabled** <small></small>
+
+### SFFloat [in, out] **absorption** 0 <small></small>
+
+### SFFloat [in, out] **refraction** 0 <small></small>
+
+### SFFloat [in, out] **diffuse** 0 <small></small>
+
+### SFFloat [in, out] **specular** 0 <small></small>
+
+## External Links
+
+- [X3D Specification of AcousticProperties](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shape.html#AcousticProperties){:target="_blank"}

package/docs/_posts/components/Shape/Appearance.md

@@ -0,0 +1,123 @@
+---
+title: Appearance
+date: 2022-01-07
+nav: components-Shape
+categories: [components, Shape]
+tags: [Appearance, Shape]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+Appearance specifies the visual properties of geometry by containing the Material, ImageTexture/MovieTexture/PixelTexture, FillProperties, LineProperties, and TextureTransform nodes.
+
+The Appearance node belongs to the **Shape** component and its default container field is *appearance.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DAppearanceNode
+    + Appearance
+```
+
+## 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.
+
+### SFString [in, out] **alphaMode** "AUTO" <small>["AUTO"|"OPAQUE"|"MASK"|"BLEND"]</small>
+
+Provides options for control of alpha transparency handling for textures. AUTO means Material transparency is applied to texture transparency for full backwards compatibility with X3D3, OPAQUE means ignore alpha transparency to render texture as opaque, MASK means alpha-testing of pixels as fully transparent when alpha value is less than alphaCutoff and fully opaque when alpha value is greater than or equal to alphaCutoff, BLEND combines partial transparency of textures and materials.
+
+#### Hint
+
+- [glTF version 2 Alpha Coverage](https://www.khronos.org/registry/glTF/specs/2.0/glTF-2.0.html#alpha-coverage){:target="_blank"}
+
+### SFFloat [in, out] **alphaCutoff** 0.5 <small>[0,1]</small>
+
+Threshold value used for pixel rendering either transparent or opaque, used when alphaMode="MASK".
+
+#### Hint
+
+- [glTF version 2 Alpha Coverage](https://www.khronos.org/registry/glTF/specs/2.0/glTF-2.0.html#alpha-coverage){:target="_blank"}
+
+### SFNode [in, out] **pointProperties** NULL <small>[PointProperties]</small>
+
+Single contained PointProperties node that can specify additional visual attributes applied to corresponding point geometry.
+
+### SFNode [in, out] **lineProperties** NULL <small>[LineProperties]</small>
+
+Single contained LineProperties node that can specify additional visual attributes applied to corresponding line geometry.
+
+### SFNode [in, out] **fillProperties** NULL <small>[FillProperties]</small>
+
+Single contained FillProperties node that can specify additional visual attributes applied to polygonal areas of corresponding geometry, on top of whatever other appearance is already defined.
+
+### SFNode [in, out] **material** NULL <small>[X3DMaterialNode]</small>
+
+Single contained Material node that can specify visual attributes for lighting response (color types, transparency, etc.) applied to corresponding geometry.
+
+#### Warning
+
+- If material is NULL or unspecified, lighting is off (all lights ignored) for this Shape and unlit object color is (1, 1, 1).
+
+### SFNode [in, out] **backMaterial** NULL <small>[X3DOneSidedMaterialNode]</small>
+
+Single contained Material node that can specify visual attributes for lighting response (color types, transparency, etc.) applied to corresponding geometry.
+
+### SFNode [in, out] **texture** NULL <small>[X3DTextureNode]</small>
+
+Single contained texture node (ImageTexture, MovieTexture, PixelTexture, MultiTexture) that maps image(s) to surface geometry.
+
+#### Hints
+
+- If texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured.
+- [X3D Scene Authoring Hints, Images](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images){:target="_blank"}
+- [3D Architecture 18 Texturing component](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/texturing.html){:target="_blank"}
+- [X3D Architecture 33 Texturing3D component](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/texture3D.html){:target="_blank"}
+
+### SFNode [in, out] **textureTransform** NULL <small>[X3DTextureTransformNode]</small>
+
+Single contained TextureTransform node that defines 2D transformation applied to texture coordinates.
+
+#### Hint
+
+- If textureTransform array is empty, then this field has no effect.
+
+### MFNode [in, out] **shaders** [ ] <small>[X3DShaderNode]</small>
+
+Zero or more contained programmable shader nodes (ComposedShader, PackagedShader, ProgramShader) that specify, in order of preference, author-programmed rendering characteristics.
+
+#### Hint
+
+- [X3D Architecture 31 Programmable shaders component](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/shaders.html){:target="_blank"}
+
+### SFNode [in, out] **blendMode** NULL <small>[BlendMode] <span class="yellow">non standard</span></small>
+
+Single contained BlendMode node that defines blend mode properties.
+
+### SFNode [in, out] **acousticProperties** NULL <small>[AcousticProperties]</small>
+
+Single contained acousticProperties node that can specify additional acoustic attributes applied to associated surface geometry.
+
+## Description
+
+### Hints
+
+- Insert a Shape node before adding geometry or Appearance. Interchange profile hint: only Material and ImageTexture children are allowed.
+- DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
+- Advanced uses can contain MultiTexture, MultiTextureTransform/TextureTransformMatrix3D/TextureTransform3D, ComposedShader/PackagedShader/ProgramShader, ComposedTexture3D/ImageTexture3D/PixelTexture3D, or ComposedCubeMapTexture/GeneratedCubeMapTexture/ImageCubeMapTexture.
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Shape/Appearance/Appearance.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of Appearance](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shape.html#Appearance){:target="_blank"}

package/docs/_posts/components/Shape/FillProperties.md

@@ -0,0 +1,67 @@
+---
+title: FillProperties
+date: 2022-01-07
+nav: components-Shape
+categories: [components, Shape]
+tags: [FillProperties, Shape]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+FillProperties indicates whether appearance is filled or hatched for associated geometry nodes inside the same Shape. Hatches are applied on top of the already rendered appearance of the node, and are not affected by lighting.
+
+The FillProperties node belongs to the **Shape** component and its default container field is *fillProperties.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DAppearanceChildNode
+    + FillProperties
+```
+
+## 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] **filled** TRUE
+
+Whether or not associated geometry is filled.
+
+### SFBool [in, out] **hatched** TRUE
+
+Whether or not associated geometry is hatched.
+
+### SFInt32 [in, out] **hatchStyle** 1 <small>[0,∞)</small>
+
+*hatchStyle* selects a hatch pattern from International Register of Graphical Items. 1=Horizontal equally spaced parallel lines. 2=Vertical equally spaced parallel lines. 3=Positive slope equally spaced parallel lines. 4=Negative slope equally spaced parallel lines. 5=Horizontal/vertical crosshatch. 6=Positive slope/negative slope crosshatch. 7=(cast iron or malleable iron and general use for all materials). 8=(steel). 9=(bronze, brass, copper, and compositions). 10=(white metal, zinc, lead, babbit, and alloys). 11=(magnesium, aluminum, and aluminum alloys). 12=(rubber, plastic, and electrical insulation). 13=(cork, felt, fabric, leather, and fibre). 14=(thermal insulation). 15=(titanium and refi-actory material). 16=(marble, slate, porcelain, glass, etc.). 17=(earth). 18=(sand). 19=(repeating dot).
+
+#### Hint
+
+- Detailed descriptions of hatchstyle values are found at the [ISO/IEC International Register of Graphical Items](https://www.iso.org/jtc1/sc24/register){:target="_blank"} (may require login)
+
+### SFColor [in, out] **hatchColor** 1 1 1 <small>[0,1]</small>
+
+Color of the hatch pattern.
+
+## Description
+
+### Hints
+
+- DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
+- Include `<component name='Shape' level='3'/>`
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Shape/FillProperties/FillProperties.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of FillProperties](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shape.html#FillProperties){:target="_blank"}

package/docs/_posts/components/Shape/LineProperties.md

@@ -0,0 +1,63 @@
+---
+title: LineProperties
+date: 2022-01-07
+nav: components-Shape
+categories: [components, Shape]
+tags: [LineProperties, Shape]
+---
+<style>
+.post h3 {
+  word-spacing: 0.2em;
+}
+</style>
+
+## Overview
+
+LineProperties allows fine control over rendering of lines and edges for associated geometry nodes inside the same Shape.
+
+The LineProperties node belongs to the **Shape** component and its default container field is *lineProperties.* It is available since X3D version 3.0 or later.
+
+## Hierarchy
+
+```
++ X3DNode
+  + X3DAppearanceChildNode
+    + LineProperties
+```
+
+## 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] **applied** TRUE
+
+Whether or not LineProperties are applied to associated geometry.
+
+### SFInt32 [in, out] **linetype** 1 <small>[1,∞)</small>
+
+*linetype* selects a line pattern, with solid default if defined value isn't supported. Values with guaranteed support are 1 Solid, 2 Dashed, 3 Dotted, 4 Dashed-dotted, 5 Dash-dot-dot. Optionally supported values are 6 single-headed arrow (arrow tip occurs at last point of each individual list of points), 7 single dot, 8 double-headed arrow, 10 chain line, 11 center line, 12 hidden line, 13 phantom line, 14 break line 1, 15 break line 2, 16 User-specified dash pattern.
+
+#### Hint
+
+- Detailed descriptions of lineType values are found at the [ISO/IEC International Register of Graphical Items](https://www.iso.org/jtc1/sc24/register){:target="_blank"} (may require login)
+
+### SFFloat [in, out] **linewidthScaleFactor** 0 <small>(-∞,∞)</small>
+
+*linewidthScaleFactor* is a scale factor multiplied by browser-dependent nominal linewidth, mapped to nearest available line width. Values zero or less provide minimum available line width.
+
+## Description
+
+### Hints
+
+- DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
+- Include `<component name='Shape' level='2'/>`
+
+## Example
+
+<x3d-canvas src="https://create3000.github.io/media/examples/Shape/LineProperties/LineProperties.x3d"></x3d-canvas>
+
+## External Links
+
+- [X3D Specification of LineProperties](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/shape.html#LineProperties){:target="_blank"}