All Superinterfaces:: X3DChildNode, X3DInfoNode, X3DNode, X3DUrlObject

All Known Implementing Classes:: DISEntityTypeMapping

public interface DISEntityTypeMapping extends 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.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. 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 parent DISEntityManager node. Hint: DisEntityManager ESPDU packets use the IEEE Distributed Interactive Simulation (DIS) protocol. Hint: Savage Developers Guide on DIS <a href="https://savage.nps.edu/Savage/developers.html#DIS" target="_blank">https://savage.nps.edu/Savage/developers.html#DIS</a> Hint: X3D for Advanced Modeling (X3D4AM) slideset <a href="https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf" target="_blank">https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf</a> Warning: requires X3D profile='Full' or else include <component name='DIS' level='2'/> Hint: when parent node is LoadSensor, apply containerField='children' (X3Dv4) or containerField='watchList' (X3Dv3). <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges</a> *

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

Method Summary

Modifier and Type

Method

Description

double

getAutoRefresh()

Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.

double

getAutoRefreshTimeLimit()

Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.

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.

String

getDescription()

Provide String value from inputOutput SFString field named description.

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.

boolean

getLoad()

Provide boolean value from inputOutput SFBool field named load.

X3DMetadataObject

getMetadata()

Provide org.web3d.x3d.sai.Core.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.

String[]

getUrl()

Provide array of String results from inputOutput MFString field named url.

DISEntityTypeMapping

setAutoRefresh(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.

DISEntityTypeMapping

setAutoRefreshTimeLimit(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.

DISEntityTypeMapping

setCategory(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named category.

DISEntityTypeMapping

setCountry(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named country.

DISEntityTypeMapping

setDescription(String newValue)

Accessor method to assign String value to inputOutput SFString field named description.

DISEntityTypeMapping

setDomain(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named domain.

DISEntityTypeMapping

setExtra(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named extra.

DISEntityTypeMapping

setKind(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named kind.

DISEntityTypeMapping

setLoad(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named load.

DISEntityTypeMapping

setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

DISEntityTypeMapping

setSpecific(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named specific.

DISEntityTypeMapping

setSubcategory(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named subcategory.

DISEntityTypeMapping

setUrl(String[] newValue)

Accessor method to assign String array to inputOutput MFString field named url.

Method Details
- getAutoRefresh
  
  double getAutoRefresh()
  
  Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.
  
  Tooltip: autoRefresh defines interval in seconds before automatic reload of current url asset is performed. Hint: if preceding file loading fails or load field is false, no refresh is performed. Hint: 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. *
  
  Specified by:
  
  getAutoRefresh in interface X3DUrlObject
  
  Returns:
  
  value of autoRefresh field
- setAutoRefresh
  
  DISEntityTypeMapping setAutoRefresh(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.
  
  Tooltip: autoRefresh defines interval in seconds before automatic reload of current url asset is performed. Hint: if preceding file loading fails or load field is false, no refresh is performed. Hint: 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. *
  
  Specified by:
  
  setAutoRefresh in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the autoRefresh field.
  
  Returns:
  
  DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getAutoRefreshTimeLimit
  
  double getAutoRefreshTimeLimit()
  
  Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.
  
  Tooltip: 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. *
  
  Specified by:
  
  getAutoRefreshTimeLimit in interface X3DUrlObject
  
  Returns:
  
  value of autoRefreshTimeLimit field
- setAutoRefreshTimeLimit
  
  DISEntityTypeMapping setAutoRefreshTimeLimit(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.
  
  Tooltip: 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. *
  
  Specified by:
  
  setAutoRefreshTimeLimit in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the autoRefreshTimeLimit field.
  
  Returns:
  
  DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- 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)
  
  Accessor method to assign int value 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)
  
  Accessor method to assign int value 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).
- getDescription
  
  String getDescription()
  
  Provide String value from inputOutput SFString field named description.
  
  Tooltip: 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). *
  
  Specified by:
  
  getDescription in interface X3DUrlObject
  
  Returns:
  
  value of description field
- setDescription
  
  DISEntityTypeMapping setDescription(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named description.
  
  Tooltip: 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). *
  
  Specified by:
  
  setDescription in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the description 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)
  
  Accessor method to assign int value 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)
  
  Accessor method to assign int value 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)
  
  Accessor method to assign int value 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).
- getLoad
  
  boolean getLoad()
  
  Provide boolean value from inputOutput SFBool field named load.
  
  Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene. Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting. Hint: use a separate LoadSensor node to detect when loading is complete. *
  
  Specified by:
  
  getLoad in interface X3DUrlObject
  
  Returns:
  
  value of load field
- setLoad
  
  DISEntityTypeMapping setLoad(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named load.
  
  Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene. Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting. Hint: use a separate LoadSensor node to detect when loading is complete. *
  
  Specified by:
  
  setLoad in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the load 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 org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *
  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)
  
  Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *
  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)
  
  Accessor method to assign int value 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.
  
  Tooltip: Integer enumerations value for particular subcategory to which an entity belongs based on the category field. See DIS Enumerations values. *
  
  Returns:
  
  value of subcategory field
- setSubcategory
  
  DISEntityTypeMapping setSubcategory(int newValue)
  
  Accessor method to assign int value to initializeOnly SFInt32 field named subcategory.
  
  Tooltip: Integer enumerations value for particular subcategory to which an entity belongs based on the category field. See DIS Enumerations values. *
  
  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
  
  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" "<a href="https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShip.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShip.x3d</a>" Hint: see <a href="https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShipIndex.html" target="_blank">https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShipIndex.html</a> Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "<a href="https://www.web3d.org" target="_blank">https://www.web3d.org</a>" "<a href="https://www.web3d.org/about" target="_blank">https://www.web3d.org/about</a>" "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 <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls</a> *
  
  Specified by:
  
  getUrl in interface X3DUrlObject
  
  Returns:
  
  value of url field
- setUrl
  
  DISEntityTypeMapping setUrl(String[] newValue)
  
  Accessor method to assign String array to inputOutput MFString field named url.
  
  Tooltip: Local and/or online addresses of X3D model of interest, for example: "ExtrusionExampleShip.x3d" "<a href="https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShip.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShip.x3d</a>" Hint: see <a href="https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShipIndex.html" target="_blank">https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShipIndex.html</a> Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "<a href="https://www.web3d.org" target="_blank">https://www.web3d.org</a>" "<a href="https://www.web3d.org/about" target="_blank">https://www.web3d.org/about</a>" "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 <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls</a> *
  
  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).

Interface DISEntityTypeMapping

Method Summary

Method Details

getAutoRefresh

setAutoRefresh

getAutoRefreshTimeLimit

setAutoRefreshTimeLimit

getCategory

setCategory

getCountry

setCountry

getDescription

setDescription

getDomain

setDomain

getExtra

setExtra

getKind

setKind

getLoad

setLoad

getMetadata

setMetadata

getSpecific

setSpecific

getSubcategory

setSubcategory

getUrl

setUrl