Package org.web3d.x3d.jsail.Networking
Class IMPORT
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteStatement
org.web3d.x3d.jsail.Networking.IMPORT
- All Implemented Interfaces:
X3DChildNode
,X3DNode
Functional summary: IMPORT provides ROUTE access to a node that has a corresponding EXPORT statement within an Inline scene. These connections allow event values to be exchanged via ROUTE statements between a parent model and a child Inline model. This concrete class represents an X3D IMPORT statement.
X3D statement tooltip: [X3D statement] IMPORT provides ROUTE access to a node that has a corresponding EXPORT statement within an Inline scene. These connections allow event values to be passed via ROUTE statements between a parent model and a child Inline model.
X3D statement tooltip: [X3D statement] IMPORT provides ROUTE access to a node that has a corresponding EXPORT statement within an Inline scene. These connections allow event values to be passed via ROUTE statements between a parent model and a child Inline model.
- Hint: it is good practice to place IMPORT statements next to corresponding Inline scenes for readability.
- Hint: see EXPORT statement for corresponding functionality within the related Inline model.
- Warning: corresponding parent-scene IMPORT and child Inline-scene EXPORT statements are necessary in order to ROUTE values between a parent model and a child Inline model.
- Hint: X3D Architecture 4.4.6 Import/Export semantics https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD3/Part01/concepts.html#ImportExportsemantics
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic String
SFString field named AS has default value equal to an empty string.static String
String constant COMPONENT defines X3D component for the IMPORT element: Networkingstatic String
SFString field named importedDEF has default value equal to an empty string.static String
SFString field named inlineDEF has default value equal to an empty string.static int
Integer constant LEVEL provides default X3D Networking component level for this element: 3static String
String constant NAME provides name of this element: IMPORT.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
validationResult
-
Constructor Summary
ConstructorsConstructorDescriptionIMPORT()
Constructor for IMPORT to initialize 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.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.getAS()
Provide String value from inputOutput SFString field named AS.Defines X3D component for the IMPORT element: Networkingint
Provides default X3D component level for this element: 3Provides name of this element: IMPORTgetFieldType(String fieldName)
Indicate type corresponding to given fieldName.Provide String value from inputOutput SFString field named importedDEF.Provide String value from inputOutput SFString field named inlineDEF.Deprecated.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
hasNodeByDEF(String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.void
Initialize all member variables to default values.Accessor method to assign String value to inputOutput SFString field named AS.Assign typed object value to SFString AS field, similar tosetAS(String)
.setCssClass(String newValue)
Deprecated.Deprecated.setImportedDEF(String newValue)
Accessor method to assign String value to inputOutput SFString field named importedDEF.setImportedDEF(SFString newValue)
Assign typed object value to SFString importedDEF field, similar tosetImportedDEF(String)
.setInlineDEF(String newValue)
Accessor method to assign String value to inputOutput SFString field named inlineDEF.setInlineDEF(SFString newValue)
Assign typed object value to SFString inlineDEF field, similar tosetInlineDEF(String)
.setMetadata(X3DMetadataObject newValue)
Deprecated.Deprecated.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.X3DConcreteStatement
isNode, isStatement
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
String constant NAME provides name of this element: IMPORT.- See Also:
- Constant Field Values
-
COMPONENT
String constant COMPONENT defines X3D component for the IMPORT element: Networking- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Networking component level for this element: 3- See Also:
- Constant Field Values
-
AS_DEFAULT_VALUE
SFString field named AS has default value equal to an empty string.- See Also:
- Constant Field Values
-
IMPORTEDDEF_DEFAULT_VALUE
SFString field named importedDEF has default value equal to an empty string.- See Also:
- Constant Field Values
-
INLINEDEF_DEFAULT_VALUE
SFString field named inlineDEF has default value equal to an empty string.- See Also:
- Constant Field Values
-
-
Constructor Details
-
IMPORT
public IMPORT()Constructor for IMPORT to initialize member variables with default values.
-
-
Method Details
-
getElementName
Provides name of this element: IMPORT- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the IMPORT element: Networking- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 3- 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 statement- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
-
getAccessType
Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D statement- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteStatement
-
getAS
Provide String value from inputOutput SFString field named AS.
Tooltip: map importedDEF name AS a new name in current scene.- Hint: optional, default export is importedDEF node name.
- Returns:
- value of AS field
-
setAS
Accessor method to assign String value to inputOutput SFString field named AS.
Tooltip: map importedDEF name AS a new name in current scene.- Hint: optional, default export is importedDEF node name.
- Parameters:
newValue
- is new value for the AS field.- Returns:
IMPORT
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAS
Assign typed object value to SFString AS field, similar tosetAS(String)
.- Parameters:
newValue
- is new value for the AS field.- Returns:
IMPORT
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getImportedDEF
Provide String value from inputOutput SFString field named importedDEF.
Tooltip: importedDEF is DEF name of the node of interest that is contained in the remote inlineDEF scene.- Hint: required.
- Returns:
- value of importedDEF field
-
setImportedDEF
Accessor method to assign String value to inputOutput SFString field named importedDEF.
Tooltip: importedDEF is DEF name of the node of interest that is contained in the remote inlineDEF scene.- Hint: required.
- Parameters:
newValue
- is new value for the importedDEF field.- Returns:
IMPORT
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setImportedDEF
Assign typed object value to SFString importedDEF field, similar tosetImportedDEF(String)
.- Parameters:
newValue
- is new value for the importedDEF field.- Returns:
IMPORT
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getInlineDEF
Provide String value from inputOutput SFString field named inlineDEF.
Tooltip: inlineDEF is the DEF name of Inline node in the same scene as this IMPORT statement.- Warning: the inlineDEF Inline scene must similarly include a corresponding EXPORT statement.
- Returns:
- value of inlineDEF field
-
setInlineDEF
Accessor method to assign String value to inputOutput SFString field named inlineDEF.
Tooltip: inlineDEF is the DEF name of Inline node in the same scene as this IMPORT statement.- Warning: the inlineDEF Inline scene must similarly include a corresponding EXPORT statement.
- Parameters:
newValue
- is new value for the inlineDEF field.- Returns:
IMPORT
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setInlineDEF
Assign typed object value to SFString inlineDEF field, similar tosetInlineDEF(String)
.- Parameters:
newValue
- is new value for the inlineDEF field.- Returns:
IMPORT
- 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:
IMPORT
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
IMPORT
- 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:
IMPORT
- 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:
X3D.FILE_EXTENSION_X3D
,X3D.FILE_EXTENSION_XML
,X3D.toStringXML()
,X3D.toFileXML(String)
,X3D.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
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:
X3D.FILE_EXTENSION_CLASSICVRML
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
-
toStringVRML97
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:
X3D.FILE_EXTENSION_VRML97
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
-
findElementByNameValue
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:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorScene()
,X3DConcreteElement.findAncestorX3D()
-
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:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorScene()
,X3DConcreteElement.findAncestorX3D()
-
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:
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 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:
findElementByNameValue(String)
,X3DConcreteElement.hasAncestorScene()
,X3DConcreteElement.findAncestorX3D()
-
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:
findNodeByDEF(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)
-
getMetadata
Deprecated.DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- null, this method is deprecated and has no effect
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Deprecated.DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Parameters:
newValue
- ignored- Returns:
- unmodified object, this method is deprecated and has no effect
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setDEF
Deprecated.DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.- Parameters:
newValue
- ignored- Returns:
- unmodified object, this method is deprecated and has no effect
-
setUSE
Deprecated.DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.- Parameters:
newValue
- ignored- Returns:
- unmodified object, this method is deprecated and has no effect
-
setCssClass
Deprecated.DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.- Parameters:
newValue
- ignored- Returns:
- unmodified object, this method is deprecated and has no effect
-