DISEntityTypeMapping (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DInfoNode, X3DNode, X3DUrlObject

All Known Implementing Classes:

DISEntityTypeMappingObject
```
public interface DISEntityTypeMapping
extends X3DInfoNode, X3DUrlObject
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DInfoNode,X3DUrlObject] 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.
- Hint: values set to zero are wildcards, matching any received value.
- Hint: DISEntityTypeMapping is contained by a DISEntityManager node.
- Hint: DisEntityManager ESPDU packets use the IEEE Distributed Interactive Simulation (DIS) protocol.
- Hint: Savage Developers Guide on DIS
  https://savage.nps.edu/Savage/developers.html#DIS
- Hint: X3D for Advanced Modeling (X3D4AM) slideset
  http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
- Warning: requires X3D profile='Full' or else include <component name='DIS' level='2'/>
- Hint: apply containerField='watchList' when parent node is LoadSensor.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

SAI Java Specification: TODO, X3D Abstract Specification: DISEntityTypeMapping, X3D Tooltips: DISEntityTypeMapping, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getCategory()` Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named category.
`int`	`getCountry()` Provide int value within allowed range of [0,65535] from initializeOnly SFInt32 field named country.
`int`	`getDomain()` Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named domain.
`int`	`getExtra()` Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named extra.
`int`	`getKind()` Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named kind.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`int`	`getSpecific()` Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named specific.
`int`	`getSubcategory()` Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named subcategory.
`java.lang.String[]`	`getUrl()` Provide array of String results from inputOutput MFString field named url.
`DISEntityTypeMapping`	`setCategory(int newValue)` Assign int value within allowed range of [0,255] to initializeOnly SFInt32 field named category.
`DISEntityTypeMapping`	`setCountry(int newValue)` Assign int value within allowed range of [0,65535] to initializeOnly SFInt32 field named country.
`DISEntityTypeMapping`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`DISEntityTypeMapping`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`DISEntityTypeMapping`	`setDomain(int newValue)` Assign int value within allowed range of [0,255] to initializeOnly SFInt32 field named domain.
`DISEntityTypeMapping`	`setExtra(int newValue)` Assign int value within allowed range of [0,255] to initializeOnly SFInt32 field named extra.
`DISEntityTypeMapping`	`setKind(int newValue)` Assign int value within allowed range of [0,255] to initializeOnly SFInt32 field named kind.
`DISEntityTypeMapping`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`DISEntityTypeMapping`	`setSpecific(int newValue)` Assign int value within allowed range of [0,255] to initializeOnly SFInt32 field named specific.
`DISEntityTypeMapping`	`setSubcategory(int newValue)` Assign int value within allowed range of [0,255] to initializeOnly SFInt32 field named subcategory.
`DISEntityTypeMapping`	`setUrl(java.lang.String[] newValue)` Assign String array to inputOutput MFString field named url.
`DISEntityTypeMapping`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getCategory
```
int getCategory()
```
    Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named category.
    
    Tooltip: Integer enumerations value for main category that describes the entity, semantics of each code varies according to domain. See DIS Enumerations values. *
    
    Returns:
    
    value of category field
  - setCategory
```
DISEntityTypeMapping setCategory(int newValue)
```
    Assign int value within allowed range of [0,255] to initializeOnly SFInt32 field named category.
    
    Tooltip: Integer enumerations value for main category that describes the entity, semantics of each code varies according to domain. See DIS Enumerations values.
    
    Parameters:
    
    newValue - is new value for the category field.
    
    Returns:
    
    DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getCountry
```
int getCountry()
```
    Provide int value within allowed range of [0,65535] from initializeOnly SFInt32 field named country.
    
    Tooltip: Integer enumerations value for country to which the design of the entity or its design specification is attributed. *
    
    Returns:
    
    value of country field
  - setCountry
```
DISEntityTypeMapping setCountry(int newValue)
```
    Assign int value within allowed range of [0,65535] to initializeOnly SFInt32 field named country.
    
    Tooltip: Integer enumerations value for country to which the design of the entity or its design specification is attributed.
    
    Parameters:
    
    newValue - is new value for the country field.
    
    Returns:
    
    DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getDomain
```
int getDomain()
```
    Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named domain.
    
    Tooltip: Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE, SUBSURFACE, SPACE or OTHER. *
    
    Returns:
    
    value of domain field
  - setDomain
```
DISEntityTypeMapping setDomain(int newValue)
```
    Assign int value within allowed range of [0,255] to initializeOnly SFInt32 field named domain.
    
    Tooltip: Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE, SUBSURFACE, SPACE or OTHER.
    
    Parameters:
    
    newValue - is new value for the domain field.
    
    Returns:
    
    DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getExtra
```
int getExtra()
```
    Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named extra.
    
    Tooltip: Any extra information required to describe a particular entity. The contents of this field shall depend on the type of entity represented. *
    
    Returns:
    
    value of extra field
  - setExtra
```
DISEntityTypeMapping setExtra(int newValue)
```
    Assign int value within allowed range of [0,255] to initializeOnly SFInt32 field named extra.
    
    Tooltip: Any extra information required to describe a particular entity. The contents of this field shall depend on the type of entity represented.
    
    Parameters:
    
    newValue - is new value for the extra field.
    
    Returns:
    
    DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getKind
```
int getKind()
```
    Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named kind.
    
    Tooltip: Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM, ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER. *
    
    Returns:
    
    value of kind field
  - setKind
```
DISEntityTypeMapping setKind(int newValue)
```
    Assign int value within allowed range of [0,255] to initializeOnly SFInt32 field named kind.
    
    Tooltip: Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM, ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER.
    
    Parameters:
    
    newValue - is new value for the kind field.
    
    Returns:
    
    DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DInfoNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
DISEntityTypeMapping setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DInfoNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - getSpecific
```
int getSpecific()
```
    Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named specific.
    
    Tooltip: Specific information about an entity based on the Subcategory field. See DIS Enumerations values. *
    
    Returns:
    
    value of specific field
  - setSpecific
```
DISEntityTypeMapping setSpecific(int newValue)
```
    Assign int value within allowed range of [0,255] to initializeOnly SFInt32 field named specific.
    
    Tooltip: Specific information about an entity based on the Subcategory field. See DIS Enumerations values.
    
    Parameters:
    
    newValue - is new value for the specific field.
    
    Returns:
    
    DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getSubcategory
```
int getSubcategory()
```
    Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named subcategory.
    
    Returns:
    
    value of subcategory field
  - setSubcategory
```
DISEntityTypeMapping setSubcategory(int newValue)
```
    Assign int value within allowed range of [0,255] to initializeOnly SFInt32 field named subcategory.
    
    Parameters:
    
    newValue - is new value for the subcategory field.
    
    Returns:
    
    DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getUrl
```
java.lang.String[] getUrl()
```
    Provide array of String results from inputOutput MFString field named url.
    
    Tooltip: Local and/or online addresses of X3D model of interest, for example: "ExtrusionExampleShip.x3d"
    "http://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShip.x3d"
    - Hint: see
      http://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShipIndex.html
    - Hint: MFString arrays can have multiple values, so separate each individual string by quote marks
      "http://www.web3d.org"
      "http://www.web3d.org/about" "etc."
    - Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
    - 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.
    - Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
    - Hint: X3D Scene Authoring Hints, urls
      http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
    Specified by:
    
    getUrl in interface X3DUrlObject
    
    Returns:
    
    value of url field
  - setUrl
```
DISEntityTypeMapping setUrl(java.lang.String[] newValue)
```
    Assign String array to inputOutput MFString field named url.
    
    Tooltip: Local and/or online addresses of X3D model of interest, for example: "ExtrusionExampleShip.x3d" "http://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShip.x3d" Hint: see http://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShipIndex.html Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc." Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity). 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. Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Hint: X3D Scene Authoring Hints, urls http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
    
    Specified by:
    
    setUrl in interface X3DUrlObject
    
    Parameters:
    
    newValue - is new value for the url field.
    
    Returns:
    
    DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
DISEntityTypeMapping setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DInfoNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
DISEntityTypeMapping setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DInfoNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
DISEntityTypeMapping setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DInfoNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface DISEntityTypeMapping

Method Summary

Method Detail

getCategory

setCategory

getCountry

setCountry

getDomain

setDomain

getExtra

setExtra

getKind

setKind

getMetadata

setMetadata

getSpecific

setSpecific

getSubcategory

setSubcategory

getUrl

setUrl

setDEF

setUSE

setCssClass