Class DISEntityManager

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.DIS.DISEntityManager

All Implemented Interfaces:

X3DChildNode, X3DNode, DISEntityManager

public class DISEntityManager
extends X3DConcreteNode
implements DISEntityManager

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. DISEntityManager 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. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges
• 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 org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.

See Also:

• X3D Abstract Specification: DISEntityManager
• X3D Tooltips: DISEntityManager
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDRESS_DEFAULT_VALUE	SFString field named address has default value "localhost" (Java syntax) or localhost (XML syntax).
static final int	APPLICATIONID_DEFAULT_VALUE	SFInt32 field named applicationID has default value 0 (Java syntax) or 0 (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the DISEntityManager element: DIS
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	fromField_ADDEDENTITIES	fromField ROUTE name for MFNode field named addedEntities.
static final String	fromField_ADDRESS	fromField ROUTE name for SFString field named address.
static final String	fromField_APPLICATIONID	fromField ROUTE name for SFInt32 field named applicationID.
static final String	fromField_CHILDREN	fromField ROUTE name for MFNode field named children.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_PORT	fromField ROUTE name for SFInt32 field named port.
static final String	fromField_REMOVEDENTITIES	fromField ROUTE name for MFNode field named removedEntities.
static final String	fromField_SITEID	fromField ROUTE name for SFInt32 field named siteID.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D DIS component level for this element: 2
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: DISEntityManager.
static final int	PORT_DEFAULT_VALUE	SFInt32 field named port has default value 0 (Java syntax) or 0 (XML syntax).
static final int	SITEID_DEFAULT_VALUE	SFInt32 field named siteID has default value 0 (Java syntax) or 0 (XML syntax).
static final String	toField_ADDRESS	toField ROUTE name for SFString field named address.
static final String	toField_APPLICATIONID	toField ROUTE name for SFInt32 field named applicationID.
static final String	toField_CHILDREN	toField ROUTE name for MFNode field named children.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_PORT	toField ROUTE name for SFInt32 field named port.
static final String	toField_SITEID	toField ROUTE name for SFInt32 field named siteID.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
DISEntityManager()	Constructor for DISEntityManager to initialize member variables with default values.
DISEntityManager(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
DISEntityManager	addChild(DISEntityTypeMapping newValue)	Utility method to add single child element to contained list of existing children nodes (if any).
DISEntityManager	addChildren(ProtoInstance newValue)	Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for children field.
void	addChildren(DISEntityTypeMapping newValue)	Add single node to existing array of children nodes (if any).
void	addChildren(X3DNode[] newValue)	Add array of children nodes to array of existing nodes (if any).
DISEntityManager	addComments(String newComment)	Add comment as CommentsBlock to children field
DISEntityManager	addComments(String[] newComments)	Add comments as String[] array to children field
DISEntityManager	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to children field
DISEntityManager	clearChildren()	Utility method to clear MFNode value of children field.
DISEntityManager	clearIS()	Utility method to clear SFNode value of IS field.
DISEntityManager	clearMetadata()	Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(String nameValue)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteElement	findElementByNameValue(String nameValue, String elementName)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
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.DIS.DISEntityTypeMapping results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.
ArrayList<X3DNode>	getChildrenList()	Utility method to get ArrayList value of MFNode children field, similar to getChildren().
final String	getComponent()	Defines X3D component for the DISEntityManager element: DIS
final int	getComponentLevel()	Provides default X3D component level for this element: 2
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
final String	getElementName()	Provides name of this element: DISEntityManager
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
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.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasChildren()	Indicate whether an object is available for inputOutput MFNode field children.
boolean	hasElementByNameValue(String nameValue, String elementName)	Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
final void	initialize()	Initialize all member variables to default values.
DISEntityManager	setAddress(String newValue)	Accessor method to assign String value to inputOutput SFString field named address.
DISEntityManager	setAddress(SFString newValue)	Assign typed object value to SFString address field, similar to setAddress(String).
DISEntityManager	setApplicationID(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named applicationID.
DISEntityManager	setApplicationID(SFInt32 newValue)	Assign typed object value to SFInt32 applicationID field, similar to setApplicationID(int).
DISEntityManager	setChildren(ArrayList<DISEntityTypeMapping> newValue)	Assign ArrayList value of MFNode children field, similar to setChildren(org.web3d.x3d.sai.Core.X3DNode[]).
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.DIS.DISEntityTypeMapping array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.
final DISEntityManager	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
DISEntityManager	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final DISEntityManager	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
DISEntityManager	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final DISEntityManager	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
DISEntityManager	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
final DISEntityManager	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
DISEntityManager	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
DISEntityManager	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
DISEntityManager	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
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	setPort(SFInt32 newValue)	Assign typed object value to SFInt32 port field, similar to setPort(int).
DISEntityManager	setSiteID(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named siteID.
DISEntityManager	setSiteID(SFInt32 newValue)	Assign typed object value to SFInt32 siteID field, similar to setSiteID(int).
final DISEntityManager	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
DISEntityManager	setUSE(DISEntityManager DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
DISEntityManager	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
String	validate()	Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

String constant NAME provides name of this element: DISEntityManager.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the DISEntityManager element: DIS

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D DIS component level for this element: 2

See Also:

• Constant Field Values

ADDRESS_DEFAULT_VALUE

public static final String ADDRESS_DEFAULT_VALUE

SFString field named address has default value "localhost" (Java syntax) or localhost (XML syntax).

See Also:

• Constant Field Values

APPLICATIONID_DEFAULT_VALUE

public static final int APPLICATIONID_DEFAULT_VALUE

SFInt32 field named applicationID has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

PORT_DEFAULT_VALUE

public static final int PORT_DEFAULT_VALUE

SFInt32 field named port has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

SITEID_DEFAULT_VALUE

public static final int SITEID_DEFAULT_VALUE

SFInt32 field named siteID has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children" }; type X3DUOM containerFieldChoicesDISEntityTypeMapping

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_ADDEDENTITIES

public static final String fromField_ADDEDENTITIES

fromField ROUTE name for MFNode field named addedEntities.

See Also:

• Constant Field Values

fromField_ADDRESS

public static final String fromField_ADDRESS

fromField ROUTE name for SFString field named address.

See Also:

• Constant Field Values

toField_ADDRESS

public static final String toField_ADDRESS

toField ROUTE name for SFString field named address.

See Also:

• Constant Field Values

fromField_APPLICATIONID

public static final String fromField_APPLICATIONID

fromField ROUTE name for SFInt32 field named applicationID.

See Also:

• Constant Field Values

toField_APPLICATIONID

public static final String toField_APPLICATIONID

toField ROUTE name for SFInt32 field named applicationID.

See Also:

• Constant Field Values

fromField_CHILDREN

public static final String fromField_CHILDREN

fromField ROUTE name for MFNode field named children.

See Also:

• Constant Field Values

toField_CHILDREN

public static final String toField_CHILDREN

toField ROUTE name for MFNode field named children.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_PORT

public static final String fromField_PORT

fromField ROUTE name for SFInt32 field named port.

See Also:

• Constant Field Values

toField_PORT

public static final String toField_PORT

toField ROUTE name for SFInt32 field named port.

See Also:

• Constant Field Values

fromField_REMOVEDENTITIES

public static final String fromField_REMOVEDENTITIES

fromField ROUTE name for MFNode field named removedEntities.

See Also:

• Constant Field Values

fromField_SITEID

public static final String fromField_SITEID

fromField ROUTE name for SFInt32 field named siteID.

See Also:

• Constant Field Values

toField_SITEID

public static final String toField_SITEID

toField ROUTE name for SFInt32 field named siteID.

See Also:

• Constant Field Values

Constructor Details

DISEntityManager

public DISEntityManager()

Constructor for DISEntityManager to initialize member variables with default values.

DISEntityManager

public DISEntityManager(String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.

Parameters:

DEFlabel - unique DEF name for this X3D node

Method Details

getElementName

public final String getElementName()

Provides name of this element: DISEntityManager

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the DISEntityManager element: DIS

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 2

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public String getFieldType(String fieldName)

Indicate type corresponding to given fieldName.

Specified by:

getFieldType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

getAccessType

public String getAccessType(String fieldName)

Indicate accessType corresponding to given fieldName.

Specified by:

getAccessType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

getContainerFieldDefault

public final String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getAddress

public String getAddress()

Provide String value from inputOutput SFString field named address.

Tooltip: Multicast network address, or else 'localhost'. Example: 224.2.181.145. *

Specified by:

getAddress in interface DISEntityManager

Returns:

value of address field

setAddress

public 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. *

Specified by:

setAddress in interface DISEntityManager

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).

setAddress

public DISEntityManager setAddress(SFString newValue)

Assign typed object value to SFString address field, similar to setAddress(String).

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

public 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. *

Specified by:

getApplicationID in interface DISEntityManager

Returns:

value of applicationID field

setApplicationID

public 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. *

Specified by:

setApplicationID in interface DISEntityManager

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).

setApplicationID

public DISEntityManager setApplicationID(SFInt32 newValue)

Assign typed object value to SFInt32 applicationID field, similar to setApplicationID(int).

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

public X3DNode[] getChildren()

Provide array of org.web3d.x3d.sai.DIS.DISEntityTypeMapping 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. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to DISEntityTypeMapping.

Specified by:

getChildren in interface DISEntityManager

Returns:

value of children field

See Also:

• DISEntityTypeMapping

getChildrenList

public ArrayList<X3DNode> getChildrenList()

Utility method to get ArrayList value of MFNode children field, similar to getChildren().

Returns:

value of children field

setChildren

public DISEntityManager setChildren(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.DIS.DISEntityTypeMapping 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. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to DISEntityTypeMapping.

Specified by:

setChildren in interface DISEntityManager

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).

setChildren

public DISEntityManager setChildren(ArrayList<DISEntityTypeMapping> newValue)

Assign ArrayList value of MFNode children field, similar to setChildren(org.web3d.x3d.sai.Core.X3DNode[]).

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

public void addChildren(DISEntityTypeMapping newValue)

Add single node to existing array of children nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to DISEntityTypeMapping and ProtoInstance.

Parameters:

newValue - is new value to be appended the children field.

addChildren

public DISEntityManager addChildren(ProtoInstance newValue)

Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for children field.

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.

Parameters:

newValue - is new value to be appended the parts field.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addChild

public DISEntityManager addChild(DISEntityTypeMapping newValue)

Utility method to add single child element to contained list of existing children nodes (if any).

Parameters:

newValue - is new node value to be appended the children field.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addChildren

public 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.

Specified by:

addChildren in interface DISEntityManager

Parameters:

newValue - is new value array to be appended the children field.

setChildren

public void setChildren(X3DNode newValue)

Set single children node, replacing prior array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to DISEntityTypeMapping.

Specified by:

setChildren in interface DISEntityManager

Parameters:

newValue - is new node for the children field (restricted to DISEntityTypeMapping)

clearChildren

public DISEntityManager clearChildren()

Utility method to clear MFNode value of children field. This method does not initialize withCHILDREN_DEFAULT_VALUE.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

hasChildren

public boolean hasChildren()

Indicate whether an object is available for inputOutput MFNode field children.

Returns:

whether a properly typed node or ProtoInstance array or CommentsBlock is available.

See Also:

• getChildren()

addComments

public DISEntityManager addComments(String newComment)

Add comment as CommentsBlock to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public DISEntityManager addComments(String[] newComments)

Add comments as String[] array to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public DISEntityManager addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getIS

public IS getIS()

Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.

Specified by:

getIS in class X3DConcreteNode

Returns:

value of IS field

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

setIS

public DISEntityManager setIS(IS newValue)

Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the IS field.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

clearIS

public DISEntityManager clearIS()

Utility method to clear SFNode value of IS field.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

hasIS

public boolean hasIS()

Indicate whether an object is available for inputOutput SFNode field IS.

Returns:

whether a concrete statement or CommentsBlock is available.

See Also:

• getIS()

getMetadata

public X3DMetadataObject getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface DISEntityManager

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

• 
  
  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/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public 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.

Specified by:

setMetadata in interface DISEntityManager

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

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:

• 
  
  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/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public DISEntityManager clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public DISEntityManager setMetadata(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in class X3DConcreteNode

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:

• setMetadata(org.web3d.x3d.sai.Core.X3DMetadataObject)

hasMetadata

public boolean hasMetadata()

Indicate whether an object is available for inputOutput SFNode field metadata.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getMetadata()
• getMetadataProtoInstance()
• X3D Scene Authoring Hints: Metadata Nodes

getPort

public int getPort()

Provide int value from inputOutput SFInt32 field named port.

Tooltip: Multicast network port, for example: 3000. *

Specified by:

getPort in interface DISEntityManager

Returns:

value of port field

setPort

public DISEntityManager setPort(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named port.

Tooltip: Multicast network port, for example: 3000. *

Specified by:

setPort in interface DISEntityManager

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).

setPort

public DISEntityManager setPort(SFInt32 newValue)

Assign typed object value to SFInt32 port field, similar to setPort(int).

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

public int getSiteID()

Provide int value from inputOutput SFInt32 field named siteID.

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

Specified by:

getSiteID in interface DISEntityManager

Returns:

value of siteID field

setSiteID

public 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. *

Specified by:

setSiteID in interface DISEntityManager

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).

setSiteID

public DISEntityManager setSiteID(SFInt32 newValue)

Assign typed object value to SFInt32 siteID field, similar to setSiteID(int).

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).

getDEF

public String getDEF()

Provide String value from 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final DISEntityManager setDEF(String newValue)

Accessor method to 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public DISEntityManager setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUSE

public String getUSE()

Provide String value from 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.

Overrides:

getUSE in class X3DConcreteNode

Returns:

value of USE field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setUSE

public final DISEntityManager setUSE(String newValue)

Accessor method to 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 class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public DISEntityManager setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final DISEntityManager setCssClass(String newValue)

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

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public DISEntityManager setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

Parameters:

newValue - is new value for the class field.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final DISEntityManager setHtmlID(String newValue)

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

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public DISEntityManager setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final DISEntityManager setCssStyle(String newValue)

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

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public DISEntityManager setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public DISEntityManager setUSE(DISEntityManager DEFnode)

Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

Warning: note that 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.

Parameters:

DEFnode - must have a DEF value defined

Returns:

DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

toStringX3D

public String toStringX3D(int indentLevel)

Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

public String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

• X3D.FILE_EXTENSION_CLASSICVRML
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

toStringVRML97

public String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

• X3D.FILE_EXTENSION_VRML97
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Virtual Reality Modeling Language (VRML) 97 specification
• VRML 97 v2.1 Amendment

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found element, null otherwise

See Also:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue,
 String elementName)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

object reference to found element, null otherwise

See Also:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public boolean hasElementByNameValue(String nameValue,
 String elementName)

Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

whether node is found

See Also:

• findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(String DEFvalue)

Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same DEF, this method does not handle that case.

Specified by:

findNodeByDEF in class X3DConcreteElement

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found node, null otherwise

See Also:

• findElementByNameValue(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(String DEFvalue)

Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

whether node is found

See Also:

• findNodeByDEF(String)

validate

public String validate()

Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)