Package org.web3d.x3d.sai.DIS

Interface DISEntityTypeMapping

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.

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.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification, X3D Abstract Specification: DISEntityTypeMapping, X3D Tooltips: DISEntityTypeMapping, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method 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.
    java.lang.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.
    double getRefresh()
    Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named refresh.
    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)
    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​(java.lang.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 setRefresh​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named refresh.
    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​(java.lang.String[] newValue)
    Accessor method to assign String array to inputOutput MFString field named url.

  • Method Details

    • 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

      java.lang.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​(java.lang.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.
      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.
      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

    • getRefresh

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

      Tooltip: refresh 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:
      getRefresh in interface X3DUrlObject
      Returns:
      value of refresh field

    • setRefresh

      DISEntityTypeMapping setRefresh​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named refresh.

      Tooltip: refresh 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:
      setRefresh in interface X3DUrlObject
      Parameters:
      newValue - is new value for the refresh field.
      Returns:
      DISEntityTypeMapping - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • 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.
      Returns:
      value of subcategory field

    • setSubcategory

      DISEntityTypeMapping setSubcategory​(int newValue)
      Accessor method to assign int value 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" "https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShip.x3d"
      Specified by:
      getUrl in interface X3DUrlObject
      Returns:
      value of url field

    • setUrl

      DISEntityTypeMapping setUrl​(java.lang.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" "https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShip.x3d"
      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).