x_ite 8.8.7 → 8.9.0

package/docs/_posts/components/DIS/DISEntityManager.md

@@ -1,6 +1,6 @@
 ---
 title: DISEntityManager
-date: 2022-01-07
+date: 2023-01-07
 nav: components-DIS
 categories: [components, DIS]
 tags: [DISEntityManager, DIS]
@@ -15,7 +15,7 @@ tags: [DISEntityManager, DIS]
 
 DISEntityManager notifies a scene when new DIS ESPDU entities arrive or current entities leave. DISEntityManager may contain any number of DISEntityTypeMapping nodes that provide a best-match X3D model to incoming entity type values. For each new DIS entity, DISEntityManager thus produces a new EspduTransform node that contains a corresponding X3D model.
 
-The DISEntityManager node belongs to the **DIS** component and its default container field is *children.* It is available since X3D version 3.0 or later.
+The DISEntityManager node belongs to the **DIS** component and its default container field is *children.* It is available from X3D version 3.0 or higher.
 
 ## Hierarchy
 
@@ -29,45 +29,70 @@ The DISEntityManager node belongs to the **DIS** component and its default conta
 
 ### 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.
+Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
+
+#### Hint
+
+- [X3D Architecture 7.2.4 Metadata](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata){:target="_blank"}
 
 ### SFString [in, out] **address** "localhost"
 
-Multicast network address, or else "localhost" example: 224.2.181.145.
+Multicast network *address*, or else 'localhost'. Example: 224.2.181.145.
 
 ### SFInt32 [in, out] **applicationID** 1 <small>[0,65535]</small>
 
-Each simulation application that can respond to simulation management PDUs needs to have a unique applicationID.
+Each simulation application that can respond to simulation management PDUs needs to have a unique *applicationID*.
 
 ### MFNode [in, out] **children** [ ] <small>[DISEntityTypeMapping]</small>
 
-Input/Output field children.
+Mapping field provides a mechanism for automatically creating an X3D model when a new entity arrives over the network. If a new entity matches one of the nodes, an instance of the provided URL is created and added as a child to the EspduTransform specified in the addedEntities field.
+
+#### Hint
+
+- Multiple DISEntityTypeMapping nodes can be provided in mapping field, best match takes precedence.
+
+#### Warning
+
+- [Field originally named 'mapping' in X3Dv3.](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges){:target="_blank"}
 
 ### SFInt32 [in, out] **port** 0 <small>[0,65535]</small>
 
-Multicast network port, for example: 62040.
+Multicast network *port*, for example: 3000.
 
 ### SFInt32 [in, out] **siteID** 0 <small>[0,65535]</small>
 
-Simulation/exercise siteID of the participating LAN or organization.
+Simulation/exercise *siteID* of the participating LAN or organization.
 
 ### MFNode [out] **addedEntities**
 
-Output field addedEntities.
+*addedEntities* array contains any new entities added during the last frame.
+
+#### Warning
+
+- It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
 
 ### MFNode [out] **removedEntities**
 
-Output field removedEntities.
+*removedEntities* output array provides EspduTransform references to any entities removed during last frame, either due to a timeout or from an explicit RemoveEntityPDU action.
+
+#### Warning
 
-## Description
+- It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
+
+## Advisories
 
 ### Hints
 
 - DISEntityManager contains DISEntityTypeMapping nodes.
 - DisEntityManager ESPDU packets use the IEEE Distributed Interactive Simulation (DIS) protocol.
-- Include `<component name='DIS' level='2'/>`
+- [Savage Developers Guide on DIS](https://savage.nps.edu/Savage/developers.html#DIS){:target="_blank"}
+- [X3D for Advanced Modeling (X3D4AM) slideset](https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf){:target="_blank"}
 
-## External Links
+### Warnings
 
-- [X3D Specification of DISEntityManager](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/dis.html#DISEntityManager){:target="_blank"}
-- [Savage Developers Guide on DIS](https://savage.nps.edu/Savage/developers.html#DIS){:target="_blank"}
+- ['children' field originally named 'mapping' in X3Dv3.](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges){:target="_blank"}
+- Requires X3D `profile='Full'` or else include `<component name='DIS' level='2'/>`
+
+## See Also
+
+- [X3D Specification of DISEntityManager node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/dis.html#DISEntityManager){:target="_blank"}

package/docs/_posts/components/DIS/DISEntityTypeMapping.md

@@ -1,6 +1,6 @@
 ---
 title: DISEntityTypeMapping
-date: 2022-01-07
+date: 2023-01-07
 nav: components-DIS
 categories: [components, DIS]
 tags: [DISEntityTypeMapping, DIS]
@@ -15,7 +15,7 @@ tags: [DISEntityTypeMapping, DIS]
 
 DISEntityTypeMapping provides a best-match mapping from DIS ESPDU entity type information to a specific X3D model, thus providing a visual and behavioral representation that best matches the entity type. Fields are processed in order: kind, domain, country, category, subcategory, specific, extra.
 
-The DISEntityTypeMapping node belongs to the **DIS** component and its default container field is *mapping.* It is available since X3D version 3.0 or later.
+The DISEntityTypeMapping node belongs to the **DIS** component and its default container field is *mapping.* It is available from X3D version 3.0 or higher.
 
 ## Hierarchy
 
@@ -27,32 +27,36 @@ The DISEntityTypeMapping node belongs to the **DIS** component and its default c
 
 ### 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.
+Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
+
+#### Hint
+
+- [X3D Architecture 7.2.4 Metadata](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata){:target="_blank"}
 
 ### SFBool [in, out] **load** TRUE
 
-*load*=true means load immediately, load=false means defer loading or else unload a previously loaded asset.
+*load*=true means *load* immediately, *load*=false means defer loading or else unload a previously loaded scene.
 
 #### Hints
 
-- Allows author to design when ImageTextureAtlas loading occurs via user interaction, event chains or scripting.
+- Allows author to design when Inline loading occurs via user interaction, event chains or scripting.
 - Use a separate LoadSensor node to detect when loading is complete.
 
 ### MFString [in, out] **url** [ ] <small>[URI]</small>
 
-Name of the X3D model of interest, for example "MyFastBoat.x3d".
+Local and/or online addresses of X3D model of interest, for example: "ExtrusionExampleShip.x3d" "https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShip.x3d"
 
 #### 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.
+- [See](https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShipIndex.html){:target="_blank"}
+- MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
+- Alternative XML encoding for quotation mark " is &amp;quot; (which is an example of a character entity).
+- Can replace embedded blank(s) in *url* queries with %20 for each blank character.
+- [X3D Scene Authoring Hints, urls](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls){:target="_blank"}
 
 #### 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"}
+- 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 *url* addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
 
 ### SFTime [in, out] **autoRefresh** 0 <small>[0,∞)</small>
 
@@ -81,42 +85,47 @@ Name of the X3D model of interest, for example "MyFastBoat.x3d".
 
 ### SFInt32 [ ] **category** 0 <small>[0,255]</small>
 
-Enumerations value for main category that describes the entity, semantics of each code varies according to domain. See DIS Enumerations values.
+Integer enumerations value for main *category* that describes the entity, semantics of each code varies according to domain. See DIS Enumerations values.
 
 ### SFInt32 [ ] **country** 0 <small>[0,0,65535]</small>
 
-Enumerations value for country to which the design of the entity or its design specification is attributed.
+Integer enumerations value for *country* to which the design of the entity or its design specification is attributed.
 
 ### SFInt32 [ ] **domain** 0 <small>[0,255]</small>
 
-Enumerations value for domain in which the entity operates: LAND, AIR, SURFACE, SUBSURFACE, SPACE or OTHER.
+Integer enumerations value for *domain* in which the entity operates: LAND, AIR, SURFACE, SUBSURFACE, SPACE or OTHER.
 
 ### SFInt32 [ ] **extra** 0 <small>[0,255]</small>
 
-Any extra information required to describe a particular entity. The contents of this field shall depend on the type of entity represented.
+Any *extra* information required to describe a particular entity. The contents of this field shall depend on the type of entity represented.
 
 ### SFInt32 [ ] **kind** 0 <small>[0,255]</small>
 
-Enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM, ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER.
+Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM, ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER.
 
 ### SFInt32 [ ] **specific** 0 <small>[0,255]</small>
 
-*specific* information about an entity based on the Subcategory field. See DIS Enumerations values.
+Specific information about an entity based on the subcategory field. See DIS Enumerations values.
 
 ### SFInt32 [ ] **subcategory** 0 <small>[0,255]</small>
 
-Field subcategory.
+Integer enumerations value for particular *subcategory* to which an entity belongs based on the category field. See DIS Enumerations values.
 
-## Description
+## Advisories
 
 ### Hints
 
 - Values set to zero are wildcards, matching any received value.
-- DISEntityTypeMapping is contained by a DISEntityManager node.
+- DISEntityTypeMapping is contained by a parent DISEntityManager node.
 - DisEntityManager ESPDU packets use the IEEE Distributed Interactive Simulation (DIS) protocol.
-- Include `<component name='DIS' level='2'/>`
+- [Savage Developers Guide on DIS](https://savage.nps.edu/Savage/developers.html#DIS){:target="_blank"}
+- [X3D for Advanced Modeling (X3D4AM) slideset](https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf){:target="_blank"}
+- [When parent node is LoadSensor, apply `containerField='children'` (X3Dv4) or `containerField='watchList'` (X3Dv3).](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges){:target="_blank"}
 
-## External Links
+### Warning
 
-- [X3D Specification of DISEntityTypeMapping](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/dis.html#DISEntityTypeMapping){:target="_blank"}
-- [Savage Developers Guide on DIS](https://savage.nps.edu/Savage/developers.html#DIS){:target="_blank"}
+- Requires X3D `profile='Full'` or else include `<component name='DIS' level='2'/>`
+
+## See Also
+
+- [X3D Specification of DISEntityTypeMapping node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/dis.html#DISEntityTypeMapping){:target="_blank"}