Package org.web3d.x3d.sai.DIS

Interface DISEntityManager

All Superinterfaces:
X3DChildNode, X3DNode
All Known Implementing Classes:
DISEntityManager
public interface DISEntityManager extends X3DChildNode
DISEntityManager notifies a scene when new DIS ESPDU entities arrive or current entities leave.

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: [X3DChildNode] 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. Hint: DISEntityManager contains DISEntityTypeMapping nodes. Hint: DisEntityManager ESPDU packets use the IEEE Distributed Interactive Simulation (DIS) protocol. Warning: 'children' field originally named 'mapping' in 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> 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 &lt;component name='DIS' level='2'/&gt; *


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
    void
    addChildren(X3DNode[] newValue)
    Add array of children nodes to array of existing nodes (if any).
    String
    getAddress()
    Provide String value from inputOutput SFString field named address.
    int
    getApplicationID()
    Provide int value from inputOutput SFInt32 field named applicationID.
    X3DNode[]
    getChildren()
    Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.
    X3DMetadataObject
    getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    int
    getPort()
    Provide int value from inputOutput SFInt32 field named port.
    int
    getSiteID()
    Provide int value from inputOutput SFInt32 field named siteID.
    DISEntityManager
    setAddress(String newValue)
    Accessor method to assign String value to inputOutput SFString field named address.
    DISEntityManager
    setApplicationID(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named applicationID.
    void
    setChildren(X3DNode newValue)
    Set single children node, replacing prior array of existing nodes (if any).
    DISEntityManager
    setChildren(X3DNode[] newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.
    DISEntityManager
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    DISEntityManager
    setPort(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named port.
    DISEntityManager
    setSiteID(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named siteID.

  • Method Details

    • getAddress

      String getAddress()
      Provide String value from inputOutput SFString field named address.

      Tooltip: Multicast network address, or else 'localhost'. Example: 224.2.181.145. *
      Returns:
      value of address field

    • setAddress

      DISEntityManager setAddress(String newValue)
      Accessor method to assign String value to inputOutput SFString field named address.

      Tooltip: Multicast network address, or else 'localhost'. Example: 224.2.181.145. *
      Parameters:
      newValue - is new value for the address field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getApplicationID

      int getApplicationID()
      Provide int value from inputOutput SFInt32 field named applicationID.

      Tooltip: Each simulation application that can respond to simulation management PDUs needs to have a unique applicationID. *
      Returns:
      value of applicationID field

    • setApplicationID

      DISEntityManager setApplicationID(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named applicationID.

      Tooltip: Each simulation application that can respond to simulation management PDUs needs to have a unique applicationID. *
      Parameters:
      newValue - is new value for the applicationID field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getChildren

      X3DNode[] getChildren()
      Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.

      Tooltip: [DISEntityTypeMapping] 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. <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> *


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to DISEntityTypeMapping.
      Returns:
      value of children field
      See Also:

    • setChildren

      DISEntityManager setChildren(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.

      Tooltip: [DISEntityTypeMapping] 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. <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> *


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to DISEntityTypeMapping.
      Parameters:
      newValue - is new value for the children field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addChildren

      void addChildren(X3DNode[] newValue)
      Add array of children nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to DISEntityTypeMapping.
      Parameters:
      newValue - is new value array to be appended the children field.

    • setChildren

      void setChildren(X3DNode newValue)
      Set single children node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the children field

    • 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 X3DNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      DISEntityManager 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 X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getPort

      int getPort()
      Provide int value from inputOutput SFInt32 field named port.

      Tooltip: Multicast network port, for example: 3000. *
      Returns:
      value of port field

    • setPort

      DISEntityManager setPort(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named port.

      Tooltip: Multicast network port, for example: 3000. *
      Parameters:
      newValue - is new value for the port field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getSiteID

      int getSiteID()
      Provide int value from inputOutput SFInt32 field named siteID.

      Tooltip: Simulation/exercise siteID of the participating LAN or organization. *
      Returns:
      value of siteID field

    • setSiteID

      DISEntityManager setSiteID(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named siteID.

      Tooltip: Simulation/exercise siteID of the participating LAN or organization. *
      Parameters:
      newValue - is new value for the siteID field.
      Returns:
      DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).