Package org.web3d.x3d.jsail.Core
Class fieldValueObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteStatement
org.web3d.x3d.jsail.Core.fieldValueObject
public class fieldValueObject extends X3DConcreteStatement
Functional summary: a fieldValue statement re-initializes the default value of a field in a ProtoInstance. Each fieldValue statement can contain either attribute-value or node content. This concrete class represents an X3D fieldValue statement.
X3D statement tooltip: [X3D statement] A fieldValue statement re-initializes the default value of a field in a parent ProtoInstance. Note that a field statement with a matching name must be already defined by the corresponding ProtoDeclare or ExternProtoDeclare statement.
X3D statement tooltip: [X3D statement] A fieldValue statement re-initializes the default value of a field in a parent ProtoInstance. Note that a field statement with a matching name must be already defined by the corresponding ProtoDeclare or ExternProtoDeclare statement.
- Hint: first add a parent ProtoInstance node before defining a new fieldValue.
- Warning: fieldValue content type must match the content type defined in the corresponding ProtoDeclare or ExternProtoDeclare field statement.
- Hint: in addition to defining a simple-type value attribute, a fieldValue statement can alternatively hold initializing SFNode/MFNode values as contained node(s).
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the fieldValue element: Corestatic int
LEVEL
Integer constant LEVEL provides default X3D Core component level for this element: 2static java.lang.String
NAME
String constant NAME provides name of this element: fieldValue.static java.lang.String
NAME_DEFAULT_VALUE
SFString field named name has default value equal to an empty string.static java.lang.String
VALUE_DEFAULT_VALUE
SFString field named value has default value equal to an empty string. -
Constructor Summary
Constructors Constructor Description fieldValueObject()
Constructor for fieldValueObject to initialize member variables with default values.fieldValueObject(java.lang.String fieldValueName)
Utility constructor that also assigns fieldValueNamefieldValueObject(java.lang.String fieldValueName, java.lang.String defaultValue)
Utility constructor that also assigns fieldValueName, defaultValue -
Method Summary
Modifier and Type Method Description fieldValueObject
addChild(X3DNode newValue)
Utility method to add single child element to contained list of existing children nodes (if any).fieldValueObject
addChildren(ProtoInstanceObject newValue)
Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for children field.void
addChildren(X3DNode newValue)
Add single node to existing array of children nodes (if any).void
addChildren(X3DNode[] newValue)
Add array of children nodes to array of existing nodes (if any).fieldValueObject
addComments(java.lang.String newComment)
Add comment as CommentsBlock to children fieldfieldValueObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to children fieldfieldValueObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to children fieldfieldValueObject
appendValue(boolean newValue)
Append boolean to fieldValue for value attribute.fieldValueObject
appendValue(double newValue)
Append double to fieldValue for value attribute.fieldValueObject
appendValue(float newValue)
Append float to fieldValue for value attribute.fieldValueObject
appendValue(int newValue)
Append integer to fieldValue for value attribute.fieldValueObject
appendValue(java.lang.String newValue)
Append String to fieldValue for value attribute.fieldValueObject
appendValue(MFBoolObject newValue)
Append MFBoolObject to fieldValue for value attribute.fieldValueObject
appendValue(MFColorObject newValue)
Append MFColorObject to fieldValue for value attribute.fieldValueObject
appendValue(MFColorRGBAObject newValue)
Append MFColorRGBAObject to fieldValue for value attribute.fieldValueObject
appendValue(MFDoubleObject newValue)
Append MFDoubleObject to fieldValue for value attribute.fieldValueObject
appendValue(MFFloatObject newValue)
Append MFFloatObject to fieldValue for value attribute.fieldValueObject
appendValue(MFImageObject newValue)
Append MFImageObject to fieldValue for value attribute.fieldValueObject
appendValue(MFInt32Object newValue)
Append MFInt32Object to fieldValue for value attribute.fieldValueObject
appendValue(MFMatrix3dObject newValue)
Append MFMatrix3dObject to fieldValue for value attribute.fieldValueObject
appendValue(MFMatrix3fObject newValue)
Append MFMatrix3fObject to fieldValue for value attribute.fieldValueObject
appendValue(MFMatrix4dObject newValue)
Append MFMatrix4dObject to fieldValue for value attribute.fieldValueObject
appendValue(MFMatrix4fObject newValue)
Append MFMatrix4fObject to fieldValue for value attribute.fieldValueObject
appendValue(MFRotationObject newValue)
Append MFRotationObject to fieldValue for value attribute.fieldValueObject
appendValue(MFStringObject newValue)
Append MFStringObject to fieldValue for value attribute.fieldValueObject
appendValue(MFTimeObject newValue)
Append MFTimeObject to fieldValue for value attribute.fieldValueObject
appendValue(MFVec2dObject newValue)
Append MFVec2dObject to fieldValue for value attribute.fieldValueObject
appendValue(MFVec2fObject newValue)
Append MFVec2fObject to fieldValue for value attribute.fieldValueObject
appendValue(MFVec3dObject newValue)
Append MFVec3dObject to fieldValue for value attribute.fieldValueObject
appendValue(MFVec3fObject newValue)
Append MFVec3fObject to fieldValue for value attribute.fieldValueObject
appendValue(MFVec4dObject newValue)
Append MFVec4dObject to fieldValue for value attribute.fieldValueObject
appendValue(MFVec4fObject newValue)
Append MFVec4fObject to fieldValue for value attribute.fieldValueObject
appendValue(SFBoolObject newValue)
Append SFBoolObject to fieldValue for value attribute.fieldValueObject
appendValue(SFColorObject newValue)
Append SFColorObject to fieldValue for value attribute.fieldValueObject
appendValue(SFColorRGBAObject newValue)
Append SFColorRGBAObject to fieldValue for value attribute.fieldValueObject
appendValue(SFDoubleObject newValue)
Append SFDoubleObject to fieldValue for value attribute.fieldValueObject
appendValue(SFFloatObject newValue)
Append SFFloatObject to fieldValue for value attribute.fieldValueObject
appendValue(SFImageObject newValue)
Append SFImageObject to fieldValue for value attribute.fieldValueObject
appendValue(SFInt32Object newValue)
Append SFInt32Object to fieldValue for value attribute.fieldValueObject
appendValue(SFMatrix3dObject newValue)
Append SFMatrix3dObject to fieldValue for value attribute.fieldValueObject
appendValue(SFMatrix3fObject newValue)
Append SFMatrix3fObject to fieldValue for value attribute.fieldValueObject
appendValue(SFMatrix4dObject newValue)
Append SFMatrix4dObject to fieldValue for value attribute.fieldValueObject
appendValue(SFMatrix4fObject newValue)
Append SFMatrix4fObject to fieldValue for value attribute.fieldValueObject
appendValue(SFRotationObject newValue)
Append SFRotationObject to fieldValue for value attribute.fieldValueObject
appendValue(SFStringObject newValue)
Append SFStringObject to fieldValue for value attribute.fieldValueObject
appendValue(SFTimeObject newValue)
Append SFTimeObject to fieldValue for value attribute.fieldValueObject
appendValue(SFVec2dObject newValue)
Append SFVec2dObject to fieldValue for value attribute.fieldValueObject
appendValue(SFVec2fObject newValue)
Append SFVec2fObject to fieldValue for value attribute.fieldValueObject
appendValue(SFVec3dObject newValue)
Append SFVec3dObject to fieldValue for value attribute.fieldValueObject
appendValue(SFVec3fObject newValue)
Append SFVec3fObject to fieldValue for value attribute.fieldValueObject
appendValue(SFVec4dObject newValue)
Append SFVec4dObject to fieldValue for value attribute.fieldValueObject
appendValue(SFVec4fObject newValue)
Append SFVec4fObject to fieldValue for value attribute.fieldValueObject
clearChildren()
Utility method to clear MFNode value of children field.fieldValueObject
clearValues()
Clear all values in a fieldValue declaration.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.java.util.ArrayList<X3DNode>
getChildren()
Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.java.lang.String
getComponent()
Defines X3D component for the fieldValue element: Coreint
getComponentLevel()
Provides default X3D component level for this element: 2java.lang.String
getElementName()
Provides name of this element: fieldValuejava.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.java.lang.String
getName()
Provide String value from inputOutput SFString field named name.java.lang.String
getType()
Discover base type of this fieldValue declaration from corresponding ProtoDeclare/ExternProtoDeclare field declaration.java.lang.String
getValue()
Provide String value from inputOutput SFString field named value.MFBoolObject
getValueMFBool()
Get typed value of this fieldValue declaration.MFColorObject
getValueMFColor()
Get typed value of this fieldValue declaration.MFColorRGBAObject
getValueMFColorRGBA()
Get typed value of this fieldValue declaration.MFDoubleObject
getValueMFDouble()
Get typed value of this fieldValue declaration.MFFloatObject
getValueMFFloat()
Get typed value of this fieldValue declaration.MFImageObject
getValueMFImage()
Get typed value of this fieldValue declaration.MFInt32Object
getValueMFInt32()
Get typed value of this fieldValue declaration.MFMatrix3dObject
getValueMFMatrix3d()
Get typed value of this fieldValue declaration.MFMatrix3fObject
getValueMFMatrix3f()
Get typed value of this fieldValue declaration.MFMatrix4dObject
getValueMFMatrix4d()
Get typed value of this fieldValue declaration.MFMatrix4fObject
getValueMFMatrix4f()
Get typed value of this fieldValue declaration.MFRotationObject
getValueMFRotation()
Get typed value of this fieldValue declaration.MFStringObject
getValueMFString()
Get typed value of this fieldValue declaration.MFTimeObject
getValueMFTime()
Get typed value of this fieldValue declaration.MFVec2dObject
getValueMFVec2d()
Get typed value of this fieldValue declaration.MFVec2fObject
getValueMFVec2f()
Get typed value of this fieldValue declaration.MFVec3dObject
getValueMFVec3d()
Get typed value of this fieldValue declaration.MFVec3fObject
getValueMFVec3f()
Get typed value of this fieldValue declaration.MFVec4dObject
getValueMFVec4d()
Get typed value of this fieldValue declaration.MFVec4fObject
getValueMFVec4f()
Get typed value of this fieldValue declaration.SFBoolObject
getValueSFBool()
If type matches, then get typed value of a SFBool fieldValue declaration.SFColorObject
getValueSFColor()
If type matches, then get typed value of a SFColor fieldValue declaration.SFColorRGBAObject
getValueSFColorRGBA()
If type matches, then get typed value of a SFColorRGBA fieldValue declaration.SFDoubleObject
getValueSFDouble()
If type matches, then get typed value of a SFDouble fieldValue declaration.SFFloatObject
getValueSFFloat()
If type matches, then get typed value of a SFFloat fieldValue declaration.SFImageObject
getValueSFImage()
If type matches, then get typed value of a SFImage fieldValue declaration.SFInt32Object
getValueSFInt32()
If type matches, then get typed value of a SFInt32 fieldValue declaration.SFMatrix3dObject
getValueSFMatrix3d()
If type matches, then get typed value of a SFMatrix3d fieldValue declaration.SFMatrix3fObject
getValueSFMatrix3f()
If type matches, then get typed value of a SFMatrix3f fieldValue declaration.SFMatrix4dObject
getValueSFMatrix4d()
If type matches, then get typed value of a SFMatrix4d fieldValue declaration.SFMatrix4fObject
getValueSFMatrix4f()
If type matches, then get typed value of a SFMatrix4f fieldValue declaration.SFRotationObject
getValueSFRotation()
If type matches, then get typed value of a SFRotation fieldValue declaration.SFStringObject
getValueSFString()
If type matches, then get typed value of a SFString fieldValue declaration.SFTimeObject
getValueSFTime()
If type matches, then get typed value of a SFTime fieldValue declaration.SFVec2dObject
getValueSFVec2d()
If type matches, then get typed value of a SFVec2d fieldValue declaration.SFVec2fObject
getValueSFVec2f()
If type matches, then get typed value of a SFVec2f fieldValue declaration.SFVec3dObject
getValueSFVec3d()
If type matches, then get typed value of a SFVec3d fieldValue declaration.SFVec3fObject
getValueSFVec3f()
If type matches, then get typed value of a SFVec3f fieldValue declaration.SFVec4dObject
getValueSFVec4d()
If type matches, then get typed value of a SFVec4d fieldValue declaration.SFVec4fObject
getValueSFVec4f()
If type matches, then get typed value of a SFVec4f fieldValue declaration.boolean
hasChildren()
Indicate whether an object is available for inputOutput MFNode field children.boolean
hasChildrenElements()
Indicate whether a node or statement is found in inputOutput MFNode field children.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
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.fieldValueObject
setChildren(java.util.ArrayList<X3DNode> newValue)
Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.void
setChildren(X3DNode newValue)
Set single children node, replacing prior array of existing nodes (if any).fieldValueObject
setName(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named name.fieldValueObject
setName(SFStringObject newValue)
Assign typed object value to SFString name field, similar tosetName(String)
.fieldValueObject
setValue(boolean newValue)
Set typed value of a boolean fieldValue declaration.fieldValueObject
setValue(boolean[] newValue)
Set typed value of a boolean[] fieldValue declaration.fieldValueObject
setValue(double newValue)
Set typed value of a double fieldValue declaration.fieldValueObject
setValue(double[] newValue)
Set typed value of a double[] array fieldValue declaration.fieldValueObject
setValue(float newValue)
Set typed value of a float fieldValue declaration.fieldValueObject
setValue(float[] newValue)
Set typed value of a float[] array fieldValue declaration.fieldValueObject
setValue(int newValue)
Set typed value of a integer fieldValue declaration.fieldValueObject
setValue(int[] newValue)
Set typed value of a integer array fieldValue declaration.fieldValueObject
setValue(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named value.fieldValueObject
setValue(java.lang.String[] newValue)
Assign typed object String[] array value to fieldValue, similar tosetValue(String)
.fieldValueObject
setValue(MFBoolObject newValue)
Set typed value of a MFBool fieldValue declaration.fieldValueObject
setValue(MFColorObject newValue)
Set typed value of a MFColor fieldValue declaration.fieldValueObject
setValue(MFColorRGBAObject newValue)
Set typed value of a MFColorRGBA fieldValue declaration.fieldValueObject
setValue(MFDoubleObject newValue)
Set typed value of a MFDouble fieldValue declaration.fieldValueObject
setValue(MFFloatObject newValue)
Set typed value of a MFFloat fieldValue declaration.fieldValueObject
setValue(MFImageObject newValue)
Set typed value of a MFImage fieldValue declaration.fieldValueObject
setValue(MFInt32Object newValue)
Set typed value of a MFInt32 fieldValue declaration.fieldValueObject
setValue(MFMatrix3dObject newValue)
Set typed value of a MFMatrix3d fieldValue declaration.fieldValueObject
setValue(MFMatrix3fObject newValue)
Set typed value of a MFMatrix3f fieldValue declaration.fieldValueObject
setValue(MFMatrix4dObject newValue)
Set typed value of a MFMatrix4d fieldValue declaration.fieldValueObject
setValue(MFMatrix4fObject newValue)
Set typed value of a MFMatrix4f fieldValue declaration.fieldValueObject
setValue(MFRotationObject newValue)
Set typed value of a MFRotation fieldValue declaration.fieldValueObject
setValue(MFStringObject newValue)
Assign typed object MFString value to fieldValue, similar tosetValue(String)
.fieldValueObject
setValue(MFTimeObject newValue)
Set typed value of a MFTime fieldValue declaration.fieldValueObject
setValue(MFVec2dObject newValue)
Set typed value of a MFVec2d fieldValue declaration.fieldValueObject
setValue(MFVec2fObject newValue)
Set typed value of a MFVec2f fieldValue declaration.fieldValueObject
setValue(MFVec3dObject newValue)
Set typed value of a MFVec3d fieldValue declaration.fieldValueObject
setValue(MFVec3fObject newValue)
Set typed value of a MFVec3f fieldValue declaration.fieldValueObject
setValue(MFVec4dObject newValue)
Set typed value of a MFVec4d fieldValue declaration.fieldValueObject
setValue(MFVec4fObject newValue)
Set typed value of a MFVec4f fieldValue declaration.fieldValueObject
setValue(SFBoolObject newValue)
Set typed value of a SFBool fieldValue declaration.fieldValueObject
setValue(SFColorObject newValue)
Set typed value of a SFColor fieldValue declaration.fieldValueObject
setValue(SFColorRGBAObject newValue)
Set typed value of a SFColorRGBA fieldValue declaration.fieldValueObject
setValue(SFDoubleObject newValue)
Set typed value of a SFDouble fieldValue declaration.fieldValueObject
setValue(SFFloatObject newValue)
Set typed value of a SFFloat fieldValue declaration.fieldValueObject
setValue(SFImageObject newValue)
Set typed value of a SFImage fieldValue declaration.fieldValueObject
setValue(SFInt32Object newValue)
Set typed value of a SFInt32 fieldValue declaration.fieldValueObject
setValue(SFMatrix3dObject newValue)
Set typed value of a SFMatrix3d fieldValue declaration.fieldValueObject
setValue(SFMatrix3fObject newValue)
Set typed value of a SFMatrix3f fieldValue declaration.fieldValueObject
setValue(SFMatrix4dObject newValue)
Set typed value of a SFMatrix4d fieldValue declaration.fieldValueObject
setValue(SFMatrix4fObject newValue)
Set typed value of a SFMatrix4f fieldValue declaration.fieldValueObject
setValue(SFRotationObject newValue)
Set typed value of a SFRotation fieldValue declaration.fieldValueObject
setValue(SFStringObject newValue)
Assign typed object SFString value field, similar tosetValue(String)
.fieldValueObject
setValue(SFTimeObject newValue)
Set typed value of a SFTime fieldValue declaration.fieldValueObject
setValue(SFVec2dObject newValue)
Set typed value of a SFVec2d fieldValue declaration.fieldValueObject
setValue(SFVec2fObject newValue)
Set typed value of a SFVec2f fieldValue declaration.fieldValueObject
setValue(SFVec3dObject newValue)
Set typed value of a SFVec3d fieldValue declaration.fieldValueObject
setValue(SFVec3fObject newValue)
Set typed value of a SFVec3f fieldValue declaration.fieldValueObject
setValue(SFVec4dObject newValue)
Set typed value of a SFVec4d fieldValue declaration.fieldValueObject
setValue(SFVec4fObject newValue)
Set typed value of a SFVec4f fieldValue declaration.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.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: fieldValue.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the fieldValue element: Core- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Core component level for this element: 2- See Also:
- Constant Field Values
-
NAME_DEFAULT_VALUE
public static final java.lang.String NAME_DEFAULT_VALUESFString field named name has default value equal to an empty string.- See Also:
- Constant Field Values
-
VALUE_DEFAULT_VALUE
public static final java.lang.String VALUE_DEFAULT_VALUESFString field named value has default value equal to an empty string.- See Also:
- Constant Field Values
-
-
Constructor Details
-
fieldValueObject
public fieldValueObject()Constructor for fieldValueObject to initialize member variables with default values. -
fieldValueObject
public fieldValueObject(java.lang.String fieldValueName)Utility constructor that also assigns fieldValueName- Parameters:
fieldValueName
- unique DEF name for this X3D node
-
fieldValueObject
public fieldValueObject(java.lang.String fieldValueName, java.lang.String defaultValue)Utility constructor that also assigns fieldValueName, defaultValue- Parameters:
fieldValueName
- unique name for this fielddefaultValue
- string version of defaultValue for this field
-
-
Method Details
-
getElementName
public final java.lang.String getElementName()Provides name of this element: fieldValue- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the fieldValue element: Core- 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 statement- 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 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
-
getChildren
Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNode.- Returns:
- value of children field
- See Also:
X3DNode
-
setChildren
Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNode.- Parameters:
newValue
- is new value for the children field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addChildren
Add single node to existing array of children nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNode and ProtoInstance.- Parameters:
newValue
- is new value to be appended the children field.
-
addChildren
Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for children field.
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.- Parameters:
newValue
- is new value to be appended the parts field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addChild
Utility method to add single child element to contained list of existing children nodes (if any).- Parameters:
newValue
- is new node value to be appended the children field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addChildren
Add array of children nodes to array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNode.- Parameters:
newValue
- is new value array to be appended the children field.
-
setChildren
Set single children node, replacing prior array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DNode.- Parameters:
newValue
- is new node for the children field (restricted to X3DNode)
-
clearChildren
Utility method to clear MFNode value of children field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasChildren
public boolean hasChildren()Indicate whether an object is available for inputOutput MFNode field children.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
getChildren()
-
addComments
Add comment as CommentsBlock to children field- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to children field- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to children field- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getName
public java.lang.String getName()Provide String value from inputOutput SFString field named name.
Tooltip: Name of the ProtoInstance field being re-initialized (corresponding to field name already defined in ProtoDeclare or ExternProtoDeclare).- 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
- Returns:
- value of name field
-
setName
Accessor method to assign String value to inputOutput SFString field named name.
Tooltip: Name of the ProtoInstance field being re-initialized (corresponding to field name already defined in ProtoDeclare or ExternProtoDeclare).- 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
@see X3D Scene Authoring Hints: Naming Conventions- Parameters:
newValue
- is new value for the name field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setName
Assign typed object value to SFString name field, similar tosetName(String)
.- Parameters:
newValue
- is new value for the name field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getValue
public java.lang.String getValue()Provide String value from inputOutput SFString field named value.
Tooltip: Initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Hint: initialize SFNode/MFNode field value using contained content element(s), instead of a simple attribute value.
- Returns:
- value of value field
-
setValue
Accessor method to assign String value to inputOutput SFString field named value.
Tooltip: Initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Hint: initialize SFNode/MFNode field value using contained content element(s), instead of a simple attribute value.
- Parameters:
newValue
- is new value for the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFBoolObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFBoolObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFColorObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFColorObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFColorRGBAObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFColorRGBAObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFDoubleObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFDoubleObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFFloatObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFFloatObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFImageObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFImageObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFInt32Object to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFInt32Object to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFMatrix3dObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFMatrix3dObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFMatrix3fObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFMatrix3fObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFMatrix4dObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFMatrix4dObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFMatrix4fObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFMatrix4fObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFRotationObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFRotationObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFStringObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFStringObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFTimeObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFTimeObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec2dObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec2dObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec2fObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec2fObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec3dObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec3dObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec3fObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec3fObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec4dObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec4dObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec4fObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec4fObject to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append boolean to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append integer to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append float to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append double to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append String to fieldValue for value attribute.
Tooltip: fieldValue contains initial value for this field, which overrides default initialization value defined in original ProtoDeclare field.- Parameters:
newValue
- is new value to append to the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setValue
Assign typed object MFString value to fieldValue, similar tosetValue(String)
.- Parameters:
newValue
- is new value for the value field.- Returns:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setValue
Assign typed object String[] array value to fieldValue, similar tosetValue(String)
.- Parameters:
newValue
- is new value for the value field.- Returns:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setValue
Assign typed object SFString value field, similar tosetValue(String)
.- Parameters:
newValue
- is new value for the value field.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
hasChildrenElements
public boolean hasChildrenElements()Indicate whether a node or statement is found in inputOutput MFNode field children.- Returns:
- whether a node or statement is found; ignores CommentsBlock.
- See Also:
getChildren()
-
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)
-
getType
public java.lang.String getType()Discover base type of this fieldValue declaration from corresponding ProtoDeclare/ExternProtoDeclare field declaration. Note that returned value might be empty string if never set in original field object. If found, provides String value ["SFBool" | "MFBool" | "SFColor" | "MFColor" | "SFColorRGBA" | "MFColorRGBA" | "SFDouble" | "MFDouble" | "SFFloat" | "MFFloat" | "SFImage" | "MFImage" | "SFInt32" | "SFNode" | "MFNode" | "MFInt32" | "SFRotation" | "MFRotation" | "SFString" | "MFString" | "SFTime" | "MFTime" | "SFVec2d" | "MFVec2d" | "SFVec2f" | "MFVec2f" | "SFVec3d" | "MFVec3d" | "SFVec3f" | "MFVec3f" | "SFVec4d" | "MFVec4d" | "SFVec4f" | "MFVec4f" | "SFMatrix3d" | "MFMatrix3d" | "SFMatrix3f" | "MFMatrix3f" | "SFMatrix4d" | "MFMatrix4d" | "SFMatrix4f" | "MFMatrix4f"] from inputOutput SFString field named type.- Returns:
- type value from corresponding field declaration, otherwise "fieldValueTypeNotFound"
- See Also:
fieldObject
-
getValueSFBool
If type matches, then get typed value of a SFBool fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFBool fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFBool
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFBool fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFColor
If type matches, then get typed value of a SFColor fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFColor fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFColor
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFColor fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFColorRGBA
If type matches, then get typed value of a SFColorRGBA fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFColorRGBA fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFColorRGBA
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFColorRGBA fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFDouble
If type matches, then get typed value of a SFDouble fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFDouble fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFDouble
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFDouble fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFFloat
If type matches, then get typed value of a SFFloat fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFFloat fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFFloat
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFFloat fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFImage
If type matches, then get typed value of a SFImage fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFImage fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFImage
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFImage fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFInt32
If type matches, then get typed value of a SFInt32 fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFInt32 fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFInt32
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFInt32 fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFMatrix3d
If type matches, then get typed value of a SFMatrix3d fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFMatrix3d fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFMatrix3d
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFMatrix3d fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFMatrix3f
If type matches, then get typed value of a SFMatrix3f fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFMatrix3f fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFMatrix3f
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFMatrix3f fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFMatrix4d
If type matches, then get typed value of a SFMatrix4d fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFMatrix4d fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFMatrix4d
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFMatrix4d fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFMatrix4f
If type matches, then get typed value of a SFMatrix4f fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFMatrix4f fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFMatrix4f
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFMatrix4f fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFRotation
If type matches, then get typed value of a SFRotation fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFRotation fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFRotation
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFRotation fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFString
If type matches, then get typed value of a SFString fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
getValueMFString
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
getValueSFTime
If type matches, then get typed value of a SFTime fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFTime fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFTime
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFTime fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFVec2d
If type matches, then get typed value of a SFVec2d fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFVec2d fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFVec2d
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFVec2d fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFVec2f
If type matches, then get typed value of a SFVec2f fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFVec2f fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFVec2f
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFVec2f fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFVec3d
If type matches, then get typed value of a SFVec3d fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFVec3d fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFVec3d
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFVec3d fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFVec3f
If type matches, then get typed value of a SFVec3f fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFVec3f fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFVec3f
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFVec3f fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFVec4d
If type matches, then get typed value of a SFVec4d fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFVec4d fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFVec4d
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFVec4d fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueSFVec4f
If type matches, then get typed value of a SFVec4f fieldValue declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFVec4f fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
getValueMFVec4f
Get typed value of this fieldValue declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFVec4f fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
clearValues
Clear all values in a fieldValue declaration.- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
setValue
Set typed value of a boolean fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
setValue
Set typed value of a boolean[] fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
setValue
Set typed value of a integer fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
setValue
Set typed value of a integer array fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
setValue
Set typed value of a float fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
setValue
Set typed value of a float[] array fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
setValue
Set typed value of a double fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
setValue
Set typed value of a double[] array fieldValue declaration. WARNING: must first setType() in ancestor fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-