DISEntityTypeMapping
Overview
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 requires at least support level 2, its default container field is children. It is available from X3D version 3.0 or higher.
Hierarchy
1
+ DISEntityTypeMapping
Fields
| Type | Access Type | Name | Default Value |
|---|---|---|---|
| SFNode | [in, out] | metadata | NULL |
| SFString | [in, out] | description | ”” |
| SFBool | [in, out] | load | TRUE |
| MFString | [in, out] | url | [ ] |
| SFTime | [in, out] | autoRefresh | 0 |
| SFTime | [in, out] | autoRefreshTimeLimit | 3600 |
| SFInt32 | [ ] | category | 0 |
| SFInt32 | [ ] | country | 0 |
| SFInt32 | [ ] | domain | 0 |
| SFInt32 | [ ] | extra | 0 |
| SFInt32 | [ ] | kind | 0 |
| SFInt32 | [ ] | specific | 0 |
| SFInt32 | [ ] | subcategory | 0 |
SFNode [in, out] metadata NULL [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint
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 & for & ampersand character, or " for “ quotation-mark character).
SFBool [in, out] load TRUE
load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.
Hints
- 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 [ ] [URI]
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
- See
- 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 " (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
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 url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
SFTime [in, out] autoRefresh 0 [0,∞)
autoRefresh defines interval in seconds before automatic reload of current url asset is performed.
Hints
- If preceding file loading fails or load field is false, no refresh is performed.
- Repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
Warning
- Automatically reloading content has security considerations and needs to be considered carefully.
SFTime [in, out] autoRefreshTimeLimit 3600 [0,∞)
autoRefreshTimeLimit defines maximum duration that automatic refresh activity can occur.
Hint
- Automatic refresh is different than query and response timeouts performed by a networking library while sequentially attempting to retrieve addressed content from a url list.
Warning
- Automatically reloading content has security considerations and needs to be considered carefully.
SFInt32 [ ] category 0 [0,255]
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 [0,0,65535]
Integer enumerations value for country to which the design of the entity or its design specification is attributed.
SFInt32 [ ] domain 0 [0,255]
Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE, SUBSURFACE, SPACE or OTHER.
SFInt32 [ ] extra 0 [0,255]
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 [0,255]
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 [0,255]
Specific information about an entity based on the subcategory field. See DIS Enumerations values.
SFInt32 [ ] subcategory 0 [0,255]
Integer enumerations value for particular subcategory to which an entity belongs based on the category field. See DIS Enumerations values.
Advice
Hints
- Values set to zero are wildcards, matching any received value.
- DISEntityTypeMapping is contained by a parent DISEntityManager node.
- DisEntityManager ESPDU packets use the IEEE Distributed Interactive Simulation (DIS) protocol.
- Savage Developers Guide on DIS
- X3D for Advanced Modeling (X3D4AM) slideset
- When parent node is LoadSensor, apply
containerField='children'(X3Dv4) orcontainerField='watchList'(X3Dv3).
Warning
- Requires X3D
profile='Full'or else include<component name='DIS' level='2'/>