Package org.web3d.x3d.jsail.DIS
Class DISEntityTypeMappingObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.DIS.DISEntityTypeMappingObject
- All Implemented Interfaces:
X3DChildNode
,X3DInfoNode
,X3DNode
,DISEntityTypeMapping
,X3DUrlObject
public class DISEntityTypeMappingObject extends X3DConcreteNode implements DISEntityTypeMapping
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 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.
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 DISEntityManager node.
- 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 http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
- Warning: requires X3D profile='Full' or else include <component name='DIS' level='2'/>
- Hint: apply containerField='watchList' when parent node is LoadSensor.
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.
-
Field Summary
Fields Modifier and Type Field Description static int
CATEGORY_DEFAULT_VALUE
SFInt32 field named category has default value 0 (Java syntax) or 0 (XML syntax).static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the DISEntityTypeMapping element: DISstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static int
COUNTRY_DEFAULT_VALUE
SFInt32 field named country has default value 0 (Java syntax) or 0 (XML syntax).static int
DOMAIN_DEFAULT_VALUE
SFInt32 field named domain has default value 0 (Java syntax) or 0 (XML syntax).static int
EXTRA_DEFAULT_VALUE
SFInt32 field named extra has default value 0 (Java syntax) or 0 (XML syntax).static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_URL
fromField ROUTE name for MFString field named url.static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static int
KIND_DEFAULT_VALUE
SFInt32 field named kind has default value 0 (Java syntax) or 0 (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D DIS component level for this element: 2static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: DISEntityTypeMapping.static int
SPECIFIC_DEFAULT_VALUE
SFInt32 field named specific has default value 0 (Java syntax) or 0 (XML syntax).static int
SUBCATEGORY_DEFAULT_VALUE
SFInt32 field named subcategory has default value 0 (Java syntax) or 0 (XML syntax).static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_URL
toField ROUTE name for MFString field named url.static java.util.ArrayList<java.lang.String>
URL_DEFAULT_VALUE
MFString field named url has default value equal to an empty list.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description DISEntityTypeMappingObject()
Constructor for DISEntityTypeMappingObject to initialize member variables with default values.DISEntityTypeMappingObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description DISEntityTypeMappingObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.DISEntityTypeMappingObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.DISEntityTypeMappingObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.DISEntityTypeMappingObject
addUrl(java.lang.String newValue)
Add singleton String value to MFString url field.DISEntityTypeMappingObject
addUrl(SFStringObject newValue)
Add singleton SFStringObject value to MFString url field.DISEntityTypeMappingObject
clearIS()
Utility method to clear SFNode value of IS field.DISEntityTypeMappingObject
clearMetadata()
Utility method to clear SFNode value of metadata field.DISEntityTypeMappingObject
clearUrl()
Utility method to clear MFString value of url field.X3DConcreteElement
findElementByNameValue(java.lang.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(java.lang.String nameValue, java.lang.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(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.int
getCategory()
Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named category.java.lang.String
getComponent()
Defines X3D component for the DISEntityTypeMapping element: DISint
getComponentLevel()
Provides default X3D component level for this element: 2java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.int
getCountry()
Provide int value within allowed range of [0,65535] from initializeOnly SFInt32 field named country.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.int
getDomain()
Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named domain.java.lang.String
getElementName()
Provides name of this element: DISEntityTypeMappingint
getExtra()
Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named extra.java.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.ISObject
getIS()
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.int
getKind()
Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named kind.X3DMetadataObject
getMetadata()
Provide 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.java.lang.String[]
getUrl()
Provide array of String results from inputOutput MFString field named url.java.util.ArrayList<java.lang.String>
getUrlList()
Utility method to get ArrayList value of MFString url field, similar togetUrl()
.java.lang.String
getUrlString()
Utility method to get String value of MFString url field, similar togetUrl()
.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.boolean
hasElementByNameValue(java.lang.String nameValue, java.lang.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(java.lang.String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.void
initialize()
Initialize all member variables to default values.DISEntityTypeMappingObject
setCategory(int newValue)
Accessor method to assign int value to initializeOnly SFInt32 field named category.DISEntityTypeMappingObject
setCategory(SFInt32Object newValue)
Assign typed object value to SFInt32 category field, similar tosetCategory(int)
.DISEntityTypeMappingObject
setCountry(int newValue)
Accessor method to assign int value to initializeOnly SFInt32 field named country.DISEntityTypeMappingObject
setCountry(SFInt32Object newValue)
Assign typed object value to SFInt32 country field, similar tosetCountry(int)
.DISEntityTypeMappingObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.DISEntityTypeMappingObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.DISEntityTypeMappingObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.DISEntityTypeMappingObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.DISEntityTypeMappingObject
setDomain(int newValue)
Accessor method to assign int value to initializeOnly SFInt32 field named domain.DISEntityTypeMappingObject
setDomain(SFInt32Object newValue)
Assign typed object value to SFInt32 domain field, similar tosetDomain(int)
.DISEntityTypeMappingObject
setExtra(int newValue)
Accessor method to assign int value to initializeOnly SFInt32 field named extra.DISEntityTypeMappingObject
setExtra(SFInt32Object newValue)
Assign typed object value to SFInt32 extra field, similar tosetExtra(int)
.DISEntityTypeMappingObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.DISEntityTypeMappingObject
setKind(int newValue)
Accessor method to assign int value to initializeOnly SFInt32 field named kind.DISEntityTypeMappingObject
setKind(SFInt32Object newValue)
Assign typed object value to SFInt32 kind field, similar tosetKind(int)
.DISEntityTypeMappingObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.DISEntityTypeMappingObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.DISEntityTypeMappingObject
setSpecific(int newValue)
Accessor method to assign int value to initializeOnly SFInt32 field named specific.DISEntityTypeMappingObject
setSpecific(SFInt32Object newValue)
Assign typed object value to SFInt32 specific field, similar tosetSpecific(int)
.DISEntityTypeMappingObject
setSubcategory(int newValue)
Accessor method to assign int value to initializeOnly SFInt32 field named subcategory.DISEntityTypeMappingObject
setSubcategory(SFInt32Object newValue)
Assign typed object value to SFInt32 subcategory field, similar tosetSubcategory(int)
.DISEntityTypeMappingObject
setUrl(java.lang.String newValue)
Assign singleton String value to MFString url field, similar tosetUrl(String[])
.DISEntityTypeMappingObject
setUrl(java.lang.String[] newValue)
Accessor method to assign String array to inputOutput MFString field named url.DISEntityTypeMappingObject
setUrl(java.util.ArrayList<java.lang.String> newValue)
Assign ArrayList value of MFString url field, similar tosetUrl(String[])
.DISEntityTypeMappingObject
setUrl(MFStringObject newValue)
Assign typed object value to MFString url field, similar tosetUrl(String[])
.DISEntityTypeMappingObject
setUrl(SFStringObject newValue)
Assign single SFString object value to MFString url field, similar tosetUrl(String[])
.DISEntityTypeMappingObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.DISEntityTypeMappingObject
setUSE(DISEntityTypeMappingObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.DISEntityTypeMappingObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.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
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: DISEntityTypeMapping.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the DISEntityTypeMapping element: DIS- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D DIS component level for this element: 2- See Also:
- Constant Field Values
-
CATEGORY_DEFAULT_VALUE
public static final int CATEGORY_DEFAULT_VALUESFInt32 field named category has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
COUNTRY_DEFAULT_VALUE
public static final int COUNTRY_DEFAULT_VALUESFInt32 field named country has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
DOMAIN_DEFAULT_VALUE
public static final int DOMAIN_DEFAULT_VALUESFInt32 field named domain has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
EXTRA_DEFAULT_VALUE
public static final int EXTRA_DEFAULT_VALUESFInt32 field named extra has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
KIND_DEFAULT_VALUE
public static final int KIND_DEFAULT_VALUESFInt32 field named kind has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
SPECIFIC_DEFAULT_VALUE
public static final int SPECIFIC_DEFAULT_VALUESFInt32 field named specific has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
SUBCATEGORY_DEFAULT_VALUE
public static final int SUBCATEGORY_DEFAULT_VALUESFInt32 field named subcategory has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
URL_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.String> URL_DEFAULT_VALUEMFString field named url has default value equal to an empty list. -
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes. -
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_URL
public static final java.lang.String fromField_URLfromField ROUTE name for MFString field named url.- See Also:
- Constant Field Values
-
toField_URL
public static final java.lang.String toField_URLtoField ROUTE name for MFString field named url.- See Also:
- Constant Field Values
-
-
Constructor Details
-
DISEntityTypeMappingObject
public DISEntityTypeMappingObject()Constructor for DISEntityTypeMappingObject to initialize member variables with default values. -
DISEntityTypeMappingObject
public DISEntityTypeMappingObject(java.lang.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 java.lang.String getElementName()Provides name of this element: DISEntityTypeMapping- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the DISEntityTypeMapping element: DIS- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 2- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
public java.lang.String getFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- 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 java.lang.String getAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- 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 java.lang.String getContainerFieldDefault()containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
- X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getCategory
public 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. *- Specified by:
getCategory
in interfaceDISEntityTypeMapping
- Returns:
- value of category field
-
setCategory
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. *- Specified by:
setCategory
in interfaceDISEntityTypeMapping
- Parameters:
newValue
- is new value for the category field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCategory
Assign typed object value to SFInt32 category field, similar tosetCategory(int)
.- Parameters:
newValue
- is new value for the category field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCountry
public 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. *- Specified by:
getCountry
in interfaceDISEntityTypeMapping
- Returns:
- value of country field
-
setCountry
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. *- Specified by:
setCountry
in interfaceDISEntityTypeMapping
- Parameters:
newValue
- is new value for the country field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCountry
Assign typed object value to SFInt32 country field, similar tosetCountry(int)
.- Parameters:
newValue
- is new value for the country field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDomain
public 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. *- Specified by:
getDomain
in interfaceDISEntityTypeMapping
- Returns:
- value of domain field
-
setDomain
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. *- Specified by:
setDomain
in interfaceDISEntityTypeMapping
- Parameters:
newValue
- is new value for the domain field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDomain
Assign typed object value to SFInt32 domain field, similar tosetDomain(int)
.- Parameters:
newValue
- is new value for the domain field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getExtra
public 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. *- Specified by:
getExtra
in interfaceDISEntityTypeMapping
- Returns:
- value of extra field
-
setExtra
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. *- Specified by:
setExtra
in interfaceDISEntityTypeMapping
- Parameters:
newValue
- is new value for the extra field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setExtra
Assign typed object value to SFInt32 extra field, similar tosetExtra(int)
.- Parameters:
newValue
- is new value for the extra field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
DISEntityTypeMappingObject
- 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
Utility method to clear SFNode value of IS field.- Returns:
DISEntityTypeMappingObject
- 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()
-
getKind
public 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. *- Specified by:
getKind
in interfaceDISEntityTypeMapping
- Returns:
- value of kind field
-
setKind
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. *- Specified by:
setKind
in interfaceDISEntityTypeMapping
- Parameters:
newValue
- is new value for the kind field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKind
Assign typed object value to SFInt32 kind field, similar tosetKind(int)
.- Parameters:
newValue
- is new value for the kind field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceDISEntityTypeMapping
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DInfoNode
- Specified by:
getMetadata
in interfaceX3DNode
- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceDISEntityTypeMapping
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DInfoNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
DISEntityTypeMappingObject
- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMetadata(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
-
getSpecific
public 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. *- Specified by:
getSpecific
in interfaceDISEntityTypeMapping
- Returns:
- value of specific field
-
setSpecific
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. *- Specified by:
setSpecific
in interfaceDISEntityTypeMapping
- Parameters:
newValue
- is new value for the specific field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSpecific
Assign typed object value to SFInt32 specific field, similar tosetSpecific(int)
.- Parameters:
newValue
- is new value for the specific field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getSubcategory
public int getSubcategory()Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named subcategory.- Specified by:
getSubcategory
in interfaceDISEntityTypeMapping
- Returns:
- value of subcategory field
-
setSubcategory
Accessor method to assign int value to initializeOnly SFInt32 field named subcategory.- Specified by:
setSubcategory
in interfaceDISEntityTypeMapping
- Parameters:
newValue
- is new value for the subcategory field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSubcategory
Assign typed object value to SFInt32 subcategory field, similar tosetSubcategory(int)
.- Parameters:
newValue
- is new value for the subcategory field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUrl
public 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"- Hint: see https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShipIndex.html
- Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
- Specified by:
getUrl
in interfaceDISEntityTypeMapping
- Specified by:
getUrl
in interfaceX3DUrlObject
- Returns:
- value of url field
-
getUrlList
public java.util.ArrayList<java.lang.String> getUrlList()Utility method to get ArrayList value of MFString url field, similar togetUrl()
.- Returns:
- value of url field
-
getUrlString
public java.lang.String getUrlString()Utility method to get String value of MFString url field, similar togetUrl()
.- Returns:
- value of url field
-
setUrl
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"- Hint: see https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionExampleShipIndex.html
- Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
- Specified by:
setUrl
in interfaceDISEntityTypeMapping
- Specified by:
setUrl
in interfaceX3DUrlObject
- Parameters:
newValue
- is new value for the url field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUrl
Assign typed object value to MFString url field, similar tosetUrl(String[])
.- Parameters:
newValue
- is new value for the url field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUrl
Assign single SFString object value to MFString url field, similar tosetUrl(String[])
.- Parameters:
newValue
- is new value for the url field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUrl
Assign singleton String value to MFString url field, similar tosetUrl(String[])
.- Parameters:
newValue
- is new value for the url field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUrl
Assign ArrayList value of MFString url field, similar tosetUrl(String[])
.- Parameters:
newValue
- is new value for the url field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearUrl
Utility method to clear MFString value of url field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addUrl
Add singleton String value to MFString url field.- Parameters:
newValue
- is new value to add to the url field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
addUrl
Add singleton SFStringObject value to MFString url field.- Parameters:
newValue
- is new value to add to the url field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
getDEF
public java.lang.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 classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.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 classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
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: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
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:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
DISEntityTypeMappingObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
public java.lang.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 classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
X3DObject.FILE_EXTENSION_X3D
,X3DObject.FILE_EXTENSION_XML
,X3DObject.toStringXML()
,X3DObject.toFileXML(String)
,X3DObject.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
X3DObject.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 java.lang.String toStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
X3DObject.FILE_EXTENSION_VRML97
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
-
findElementByNameValue
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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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 classX3DConcreteElement
- 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.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
findElementByNameValue
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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 classX3DConcreteElement
- 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.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasElementByNameValue
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.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
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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 classX3DConcreteElement
- 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.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasNodeByDEF
public boolean hasNodeByDEF(java.lang.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 java.lang.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.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-