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.

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.
Hint: Savage Developers Guide on DIS https://savage.nps.edu/Savage/developers.html#DIS
Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
Warning: requires X3D profile='Full' or else include <component name='DIS' level='2'/>

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: DISEntityManager, X3D Tooltips: DISEntityManager, X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method	Description
`void`	`addMapping(X3DNode[] newValue)`	Add array of child mapping nodes to array of existing nodes (if any).
`java.lang.String`	`getAddress()`	Provide String value from inputOutput SFString field named address.
`int`	`getApplicationID()`	Provide int value from inputOutput SFInt32 field named applicationID.
`X3DNode[]`	`getMapping()`	Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field mapping.
`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(java.lang.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`	`setMapping(X3DNode newValue)`	Set single child mapping node, replacing prior array of existing nodes (if any).
`DISEntityManager`	`setMapping(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 mapping.
`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
  
  java.lang.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(java.lang.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).
- getMapping
  
  X3DNode[] getMapping()
  Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field mapping.
  
  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: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to DISEntityTypeMapping.
  Returns:
  
  value of mapping field
  
  See Also:
  
  DISEntityTypeMapping
- setMapping
  
  DISEntityManager setMapping(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 mapping.
  
  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.
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to DISEntityTypeMapping.
  Parameters:
  
  newValue - is new value for the mapping field.
  
  Returns:
  
  DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- addMapping
  
  void addMapping(X3DNode[] newValue)
  
  Add array of child mapping 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 mapping field.
- setMapping
  
  void setMapping(X3DNode newValue)
  
  Set single child mapping node, replacing prior array of existing nodes (if any).
  
  Parameters:
  
  newValue - is new node for the mapping 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 https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
  Specified by:
  
  getMetadata in interface X3DChildNode
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Returns:
  
  value of metadata field
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- 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 https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
  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:
  
  X3D Scene Authoring Hints: Metadata Nodes
- 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).

Interface DISEntityManager

Method Summary

Method Details