Package org.web3d.x3d.jsail.DIS
Class DISEntityTypeMapping
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.DIS.DISEntityTypeMapping
- All Implemented Interfaces:
X3DChildNode
,X3DInfoNode
,X3DNode
,DISEntityTypeMapping
,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.
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
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.
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.
DISEntityTypeMapping 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 parent 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 https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
- Warning: requires X3D profile='Full' or else include <component name='DIS' level='2'/>
- Hint: when parent node is LoadSensor, apply containerField='children' (X3Dv4) or containerField='watchList' (X3Dv3). https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges
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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final double
SFTime field named autoRefresh has default value 0 (Java syntax) or 0 (XML syntax).static final double
SFTime field named autoRefreshTimeLimit has default value 3600 (Java syntax) or 3600 (XML syntax).static final int
SFInt32 field named category has default value 0 (Java syntax) or 0 (XML syntax).static final String
String constant COMPONENT defines X3D component for the DISEntityTypeMapping element: DISstatic final String
containerField describes typical field relationship of a node to its parent.static final int
SFInt32 field named country has default value 0 (Java syntax) or 0 (XML syntax).static final String
SFString field named description has default value equal to an empty string.static final int
SFInt32 field named domain has default value 0 (Java syntax) or 0 (XML syntax).static final int
SFInt32 field named extra has default value 0 (Java syntax) or 0 (XML syntax).static final String
fromField ROUTE name for SFTime field named autoRefresh.static final String
fromField ROUTE name for SFTime field named autoRefreshTimeLimit.static final String
fromField ROUTE name for SFString field named description.static final String
fromField ROUTE name for SFNode field named IS.static final String
fromField ROUTE name for SFBool field named load.static final String
fromField ROUTE name for SFNode field named metadata.static final String
fromField ROUTE name for MFString field named url.static final IS
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static final int
SFInt32 field named kind has default value 0 (Java syntax) or 0 (XML syntax).static final int
Integer constant LEVEL provides default X3D DIS component level for this element: 2static final boolean
SFBool field named load has default value true (Java syntax) or true (XML syntax).static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static final String
String constant NAME provides name of this element: DISEntityTypeMapping.static final int
SFInt32 field named specific has default value 0 (Java syntax) or 0 (XML syntax).static final int
SFInt32 field named subcategory has default value 0 (Java syntax) or 0 (XML syntax).static final String
toField ROUTE name for SFTime field named autoRefresh.static final String
toField ROUTE name for SFTime field named autoRefreshTimeLimit.static final String
toField ROUTE name for SFString field named description.static final String
toField ROUTE name for SFBool field named load.static final String
toField ROUTE name for SFNode field named metadata.static final String
toField ROUTE name for MFString field named url.MFString field named url has default value equal to an empty list.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
ConstructorDescriptionConstructor for DISEntityTypeMapping to initialize member variables with default values.DISEntityTypeMapping
(String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and TypeMethodDescriptionaddComments
(String newComment) Add comment as String to contained commentsList.addComments
(String[] newComments) Add comments as String[] array to contained commentsList.addComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.Add singleton String value to MFString url field.Add singleton SFString value to MFString url field.clearIS()
Utility method to clear SFNode value of IS field.Utility method to clear SFNode value of metadata field.clearUrl()
Utility method to clear MFString value of url field.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.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.findNodeByDEF
(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.getAccessType
(String fieldName) Indicate accessType corresponding to given fieldName.double
Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.double
Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.int
Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named category.final String
Defines X3D component for the DISEntityTypeMapping element: DISfinal int
Provides default X3D component level for this element: 2final String
containerField describes typical field relationship of a node to its parent.int
Provide int value within allowed range of [0,65535] from initializeOnly SFInt32 field named country.Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.getDEF()
Provide String value from inputOutput SFString field named DEF.Provide String value from inputOutput SFString field named description.int
Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named domain.final String
Provides name of this element: DISEntityTypeMappingint
getExtra()
Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named extra.getFieldType
(String fieldName) Indicate type corresponding to given fieldName.Provide String value from inputOutput SFString field named id.getIS()
Provide IS 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.boolean
getLoad()
Provide boolean value from inputOutput SFBool field named load.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.int
Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named specific.int
Provide int value within allowed range of [0,255] from initializeOnly SFInt32 field named subcategory.String[]
getUrl()
Provide array of String results from inputOutput MFString field named url.Utility method to get ArrayList value of MFString url field, similar togetUrl()
.Utility method to get String value of MFString url field, similar togetUrl()
.getUSE()
Provide String value from inputOutput SFString field named USE.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
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 all member variables to default values.setAutoRefresh
(double newValue) Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.setAutoRefresh
(SFTime newValue) Assign typed object value to SFTime autoRefresh field, similar tosetAutoRefresh(double)
.setAutoRefreshTimeLimit
(double newValue) Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.setAutoRefreshTimeLimit
(SFTime newValue) Assign typed object value to SFTime autoRefreshTimeLimit field, similar tosetAutoRefreshTimeLimit(double)
.setCategory
(int newValue) Accessor method to assign int value to initializeOnly SFInt32 field named category.setCategory
(SFInt32 newValue) Assign typed object value to SFInt32 category field, similar tosetCategory(int)
.setCountry
(int newValue) Accessor method to assign int value to initializeOnly SFInt32 field named country.setCountry
(SFInt32 newValue) Assign typed object value to SFInt32 country field, similar tosetCountry(int)
.final DISEntityTypeMapping
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final DISEntityTypeMapping
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.final DISEntityTypeMapping
Accessor method to assign String value to inputOutput SFString field named DEF.Assign typed object value to SFString DEF field, similar tosetDEF(String)
.setDescription
(String newValue) Accessor method to assign String value to inputOutput SFString field named description.setDescription
(SFString newValue) Assign typed object value to SFString description field, similar tosetDescription(String)
.setDomain
(int newValue) Accessor method to assign int value to initializeOnly SFInt32 field named domain.Assign typed object value to SFInt32 domain field, similar tosetDomain(int)
.setExtra
(int newValue) Accessor method to assign int value to initializeOnly SFInt32 field named extra.Assign typed object value to SFInt32 extra field, similar tosetExtra(int)
.final DISEntityTypeMapping
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.setKind
(int newValue) Accessor method to assign int value to initializeOnly SFInt32 field named kind.Assign typed object value to SFInt32 kind field, similar tosetKind(int)
.setLoad
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named load.Assign typed object value to SFBool load field, similar tosetLoad(boolean)
.setMetadata
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setSpecific
(int newValue) Accessor method to assign int value to initializeOnly SFInt32 field named specific.setSpecific
(SFInt32 newValue) Assign typed object value to SFInt32 specific field, similar tosetSpecific(int)
.setSubcategory
(int newValue) Accessor method to assign int value to initializeOnly SFInt32 field named subcategory.setSubcategory
(SFInt32 newValue) Assign typed object value to SFInt32 subcategory field, similar tosetSubcategory(int)
.Assign singleton String value to MFString url field, similar tosetUrl(String[])
.Accessor method to assign String array to inputOutput MFString field named url.Assign ArrayList value of MFString url field, similar tosetUrl(String[])
.Assign typed object value to MFString url field, similar tosetUrl(String[])
.Assign single SFString object value to MFString url field, similar tosetUrl(String[])
.final DISEntityTypeMapping
Accessor method to assign String value to inputOutput SFString field named USE.setUSE
(DISEntityTypeMapping DEFnode) Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.Assign typed object value to SFString USE field, similar tosetUSE(String)
.toStringClassicVRML
(int indentLevel) Recursive method to provide ClassicVRML string serialization.toStringVRML97
(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX3D
(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.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
-
Field Details
-
NAME
String constant NAME provides name of this element: DISEntityTypeMapping.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the DISEntityTypeMapping element: DIS- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D DIS component level for this element: 2- See Also:
-
AUTOREFRESH_DEFAULT_VALUE
public static final double AUTOREFRESH_DEFAULT_VALUESFTime field named autoRefresh has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
-
AUTOREFRESHTIMELIMIT_DEFAULT_VALUE
public static final double AUTOREFRESHTIMELIMIT_DEFAULT_VALUESFTime field named autoRefreshTimeLimit has default value 3600 (Java syntax) or 3600 (XML syntax).- See Also:
-
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:
-
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:
-
DESCRIPTION_DEFAULT_VALUE
SFString field named description has default value equal to an empty string.- See Also:
-
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:
-
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:
-
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:
-
LOAD_DEFAULT_VALUE
public static final boolean LOAD_DEFAULT_VALUESFBool field named load has default value true (Java syntax) or true (XML syntax).- See Also:
-
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:
-
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:
-
URL_DEFAULT_VALUE
-
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", "mapping", "children" }; type X3DUOM containerFieldChoicesDISEntityTypeMapping- See Also:
-
fromField_AUTOREFRESH
fromField ROUTE name for SFTime field named autoRefresh.- See Also:
-
toField_AUTOREFRESH
toField ROUTE name for SFTime field named autoRefresh.- See Also:
-
fromField_AUTOREFRESHTIMELIMIT
fromField ROUTE name for SFTime field named autoRefreshTimeLimit.- See Also:
-
toField_AUTOREFRESHTIMELIMIT
toField ROUTE name for SFTime field named autoRefreshTimeLimit.- See Also:
-
fromField_DESCRIPTION
fromField ROUTE name for SFString field named description.- See Also:
-
toField_DESCRIPTION
toField ROUTE name for SFString field named description.- See Also:
-
fromField_IS
-
fromField_LOAD
fromField ROUTE name for SFBool field named load.- See Also:
-
toField_LOAD
-
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.- See Also:
-
toField_METADATA
toField ROUTE name for SFNode field named metadata.- See Also:
-
fromField_URL
fromField ROUTE name for MFString field named url.- See Also:
-
toField_URL
-
-
Constructor Details
-
DISEntityTypeMapping
public DISEntityTypeMapping()Constructor for DISEntityTypeMapping to initialize member variables with default values. -
DISEntityTypeMapping
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
Provides name of this element: DISEntityTypeMapping- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
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
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:
-
getAccessType
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:
-
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 classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getAutoRefresh
public double getAutoRefresh()Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.
Tooltip: autoRefresh defines interval in seconds before automatic reload of current url asset is performed.- Hint: if preceding file loading fails or load field is false, no refresh is performed.
- Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
- Warning: automatically reloading content has security considerations and needs to be considered carefully.
- Specified by:
getAutoRefresh
in interfaceDISEntityTypeMapping
- Specified by:
getAutoRefresh
in interfaceX3DUrlObject
- Returns:
- value of autoRefresh field
-
setAutoRefresh
Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.
Tooltip: autoRefresh defines interval in seconds before automatic reload of current url asset is performed.- Hint: if preceding file loading fails or load field is false, no refresh is performed.
- Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
- Warning: automatically reloading content has security considerations and needs to be considered carefully.
- Specified by:
setAutoRefresh
in interfaceDISEntityTypeMapping
- Specified by:
setAutoRefresh
in interfaceX3DUrlObject
- Parameters:
newValue
- is new value for the autoRefresh field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAutoRefresh
Assign typed object value to SFTime autoRefresh field, similar tosetAutoRefresh(double)
.- Parameters:
newValue
- is new value for the autoRefresh field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getAutoRefreshTimeLimit
public double getAutoRefreshTimeLimit()Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.
Tooltip: autoRefreshTimeLimit defines maximum duration that automatic refresh activity can occur.- Hint: Automatic refresh is different than query and response timeouts performed by a networking library while sequentially attempting to retrieve addressed content from a url list.
- Warning: automatically reloading content has security considerations and needs to be considered carefully.
- Specified by:
getAutoRefreshTimeLimit
in interfaceDISEntityTypeMapping
- Specified by:
getAutoRefreshTimeLimit
in interfaceX3DUrlObject
- Returns:
- value of autoRefreshTimeLimit field
-
setAutoRefreshTimeLimit
Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.
Tooltip: autoRefreshTimeLimit defines maximum duration that automatic refresh activity can occur.- Hint: Automatic refresh is different than query and response timeouts performed by a networking library while sequentially attempting to retrieve addressed content from a url list.
- Warning: automatically reloading content has security considerations and needs to be considered carefully.
- Specified by:
setAutoRefreshTimeLimit
in interfaceDISEntityTypeMapping
- Specified by:
setAutoRefreshTimeLimit
in interfaceX3DUrlObject
- Parameters:
newValue
- is new value for the autoRefreshTimeLimit field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAutoRefreshTimeLimit
Assign typed object value to SFTime autoRefreshTimeLimit field, similar tosetAutoRefreshTimeLimit(double)
.- Parameters:
newValue
- is new value for the autoRefreshTimeLimit field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDescription
Provide String value from inputOutput SFString field named description.
Tooltip: Author-provided prose that describes intended purpose of the url asset.- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Specified by:
getDescription
in interfaceDISEntityTypeMapping
- Specified by:
getDescription
in interfaceX3DUrlObject
- Returns:
- value of description field
-
setDescription
Accessor method to assign String value to inputOutput SFString field named description.
Tooltip: Author-provided prose that describes intended purpose of the url asset.- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Specified by:
setDescription
in interfaceDISEntityTypeMapping
- Specified by:
setDescription
in interfaceX3DUrlObject
- Parameters:
newValue
- is new value for the description field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDescription
Assign typed object value to SFString description field, similar tosetDescription(String)
.- Parameters:
newValue
- is new value for the description field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDomain
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:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
-
setIS
Accessor method to assign IS 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:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
DISEntityTypeMapping
- 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:
-
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:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getLoad
public boolean getLoad()Provide boolean value from inputOutput SFBool field named load.
Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.- Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
- Hint: use a separate LoadSensor node to detect when loading is complete.
- Specified by:
getLoad
in interfaceDISEntityTypeMapping
- Specified by:
getLoad
in interfaceX3DUrlObject
- Returns:
- value of load field
-
setLoad
Accessor method to assign boolean value to inputOutput SFBool field named load.
Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.- Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
- Hint: use a separate LoadSensor node to detect when loading is complete.
- Specified by:
setLoad
in interfaceDISEntityTypeMapping
- Specified by:
setLoad
in interfaceX3DUrlObject
- Parameters:
newValue
- is new value for the load field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setLoad
Assign typed object value to SFBool load field, similar tosetLoad(boolean)
.- Parameters:
newValue
- is new value for the load field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide org.web3d.x3d.sai.Core.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:
-
setMetadata
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 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:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
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:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- 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.
Tooltip: Integer enumerations value for particular subcategory to which an entity belongs based on the category field. See DIS Enumerations values. *- Specified by:
getSubcategory
in interfaceDISEntityTypeMapping
- Returns:
- value of subcategory field
-
setSubcategory
Accessor method to assign int value to initializeOnly SFInt32 field named subcategory.
Tooltip: Integer enumerations value for particular subcategory to which an entity belongs based on the category field. See DIS Enumerations values. *- Specified by:
setSubcategory
in interfaceDISEntityTypeMapping
- Parameters:
newValue
- is new value for the subcategory field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSubcategory
Assign typed object value to SFInt32 subcategory field, similar tosetSubcategory(int)
.- Parameters:
newValue
- is new value for the subcategory field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUrl
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
-
getUrlString
-
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:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- 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. This method does not initialize withURL_DEFAULT_VALUE.- Returns:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addUrl
Add singleton SFString value to MFString url field.- Parameters:
newValue
- is new value to add to the url field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
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:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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:
-
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:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Specified by:
setHtmlID
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the id field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Specified by:
setCssStyle
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the style field.- Returns:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
DISEntityTypeMapping
- 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:
DISEntityTypeMapping
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
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:
-
toStringClassicVRML
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:
-
toStringVRML97
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:
-
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 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 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:
-
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 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 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:
-
hasElementByNameValue
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:
-
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 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 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:
-
hasNodeByDEF
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:
-
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 classX3DConcreteElement
- Returns:
- validation results (if any)
-