Package org.web3d.x3d.jsail.Core
Class field
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteStatement
org.web3d.x3d.jsail.Core.field
Functional summary: a field statement defines an interface attribute or node. Each field statement can contain either attribute-value or node content. This concrete class represents an X3D field statement.
field statement tooltip: A field statement defines an interface attribute or node.
field statement tooltip: A field statement defines an interface attribute or node.
- Hint: first add a parent Script node, or ProtoDeclare/ProtoInterface statements, or ExternProtoDeclare statement, before defining a new field.
- Hint: in addition to defining a simple-type value attribute, a field statement can alternatively hold initializing SFNode/MFNode values as contained node(s).
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Initial value is required to be set for validity: SFString field named accessType has default value equal to an empty string.static final String
Tooltip: A field with accessType initializeOnly can be initialized, but cannot send or receive events.static final String
Tooltip: A field with accessType inputOnly cannot be initialized or included in a scene file, but can receive input event values via a ROUTE.static final String
Tooltip: A field with accessType inputOutput can be initialized, and can also send or receive events.static final String
Tooltip: A field with accessType outputOnly cannot be initialized or included in a scene file, but can send output event values via a ROUTE.static final String
SFString field named appinfo has default value equal to an empty string.static final String
String constant COMPONENT defines X3D component for the field element: Corestatic final String
SFString field named documentation has default value equal to an empty string.static final int
Integer constant LEVEL provides default X3D Core component level for this element: 1static final String
String constant NAME provides name of this element: field.static final String
SFString field named name has default value equal to an empty string.static final String
Initial value is required to be set for validity: SFString field named type has default value equal to an empty string.static final String
Tooltip: Multiple Field (list) Boolean.static final String
Tooltip: Multiple Field (list) color value, red-green-blue.static final String
Tooltip: Multiple Field (list) color value, red-green-blue alpha (opacity).static final String
Tooltip: Multiple Field (list) 2-tuple double-precision (64-bit) float vector.static final String
Tooltip: Multiple Field (list) single-precision (32-bit) float vector.static final String
Tooltip: Multiple Field (list) image values.static final String
Tooltip: Multiple Field (list) 32-bit integer.static final String
Tooltip: Multiple Field (list) 3×3 matrices of double-precision floating point numbers.static final String
Tooltip: Multiple Field (list) 3×3 matrices of double-precision floating point numbers.static final String
Tooltip: Multiple Field (list) 4×4 matric3w of double-precision floating point numbers.static final String
Tooltip: Multiple Field (list) 4×4 matrices of single-precision floating point numbers.static final String
Tooltip: Multiple Field (list) nodes.static final String
Tooltip: Multiple Field (list) rotation values using 3-tuple axis, radian angle.static final String
Tooltip: Multiple Field (list) SFString array.static final String
Tooltip: Multiple Field (list) time array in seconds.static final String
Tooltip: Multiple Field (list) 2-tuple double-precision float vectors.static final String
Tooltip: Multiple Field (list) 2-tuple single-precision float vectors.static final String
Tooltip: Multiple Field (list) 3-tuple double-precision float vectors.static final String
Tooltip: Multiple Field (list) 3-tuple single-precision float vectors.static final String
Tooltip: Multiple Field (list) 4-tuple double-precision float vectors.static final String
Tooltip: Multiple Field (list) 4-tuple single-precision float vectors.static final String
Tooltip: Single Field (singleton) Boolean.static final String
Tooltip: Single Field (singleton) color value, red-green-blue.static final String
Tooltip: Single Field (singleton) color value, red-green-blue alpha (opacity).static final String
Tooltip: Single Field (singleton) double-precision (64-bit) float.static final String
Tooltip: Single Field (singleton) single-precision (32-bit) float.static final String
Tooltip: Single Field (singleton) image value.static final String
Tooltip: Single Field (singleton) 32-bit integer.static final String
Tooltip: Single Field (singleton) 3×3 matrix of double-precision floating point numbers.static final String
Tooltip: Single Field (singleton) 3×3 matrix of single-precision floating point numbers.static final String
Tooltip: Single Field (singleton) 4×4 matrix of double-precision floating point numbers.static final String
Tooltip: Single Field (singleton) 4×4 matrix of single-precision floating point numbers.static final String
Tooltip: Single Field (singleton) node.static final String
Tooltip: Single Field (singleton) rotation value using 3-tuple axis, radian angle.static final String
Tooltip: Single Field (singleton) string value.static final String
Tooltip: Single Field (singleton) time value in seconds.static final String
Tooltip: Single Field (singleton) 2-tuple double-precision float vector.static final String
Tooltip: Single Field (singleton) 2-tuple single-precision float vector.static final String
Tooltip: Single Field (singleton) 3-tuple double-precision float vector.static final String
Tooltip: Single Field (singleton) 3-tuple single-precision float vector.static final String
Tooltip: Single Field (singleton) 4-tuple double-precision float vector.static final String
Tooltip: Single Field (singleton) 4-tuple single-precision float vector.static final String
SFString field named value has default value equal to an empty string.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult
-
Constructor Summary
ConstructorDescriptionfield()
Constructor for field to initialize member variables with default values.Utility constructor that assigns name, type, accessType (required)Utility constructor that assigns name, type, accessType (required) and default value (if appropriate) -
Method Summary
Modifier and TypeMethodDescriptionUtility method to add single child element to contained list of existing children nodes (if any).addChildren
(ProtoInstance newValue) Add single ProtoInstance (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).addComments
(String newComment) Add comment as CommentsBlock to children fieldaddComments
(String[] newComments) Add comments as String[] array to children fieldaddComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to children fieldappendValue
(boolean newValue) Append boolean to field for value attribute.appendValue
(double newValue) Append double to field for value attribute.appendValue
(float newValue) Append float to field for value attribute.appendValue
(int newValue) Append integer to field for value attribute.appendValue
(String newValue) Append String to field for value attribute.appendValue
(MFBool newValue) Append MFBool to field for value attribute.appendValue
(MFColor newValue) Append MFColor to field for value attribute.appendValue
(MFColorRGBA newValue) Append MFColorRGBA to field for value attribute.appendValue
(MFDouble newValue) Append MFDouble to field for value attribute.appendValue
(MFFloat newValue) Append MFFloat to field for value attribute.appendValue
(MFImage newValue) Append MFImage to field for value attribute.appendValue
(MFInt32 newValue) Append MFInt32 to field for value attribute.appendValue
(MFMatrix3d newValue) Append MFMatrix3d to field for value attribute.appendValue
(MFMatrix3f newValue) Append MFMatrix3f to field for value attribute.appendValue
(MFMatrix4d newValue) Append MFMatrix4d to field for value attribute.appendValue
(MFMatrix4f newValue) Append MFMatrix4f to field for value attribute.appendValue
(MFRotation newValue) Append MFRotation to field for value attribute.appendValue
(MFString newValue) Append MFString to field for value attribute.appendValue
(MFTime newValue) Append MFTime to field for value attribute.appendValue
(MFVec2d newValue) Append MFVec2d to field for value attribute.appendValue
(MFVec2f newValue) Append MFVec2f to field for value attribute.appendValue
(MFVec3d newValue) Append MFVec3d to field for value attribute.appendValue
(MFVec3f newValue) Append MFVec3f to field for value attribute.appendValue
(MFVec4d newValue) Append MFVec4d to field for value attribute.appendValue
(MFVec4f newValue) Append MFVec4f to field for value attribute.appendValue
(SFBool newValue) Append SFBool to field for value attribute.appendValue
(SFColor newValue) Append SFColor to field for value attribute.appendValue
(SFColorRGBA newValue) Append SFColorRGBA to field for value attribute.appendValue
(SFDouble newValue) Append SFDouble to field for value attribute.appendValue
(SFFloat newValue) Append SFFloat to field for value attribute.appendValue
(SFImage newValue) Append SFImage to field for value attribute.appendValue
(SFInt32 newValue) Append SFInt32 to field for value attribute.appendValue
(SFMatrix3d newValue) Append SFMatrix3d to field for value attribute.appendValue
(SFMatrix3f newValue) Append SFMatrix3f to field for value attribute.appendValue
(SFMatrix4d newValue) Append SFMatrix4d to field for value attribute.appendValue
(SFMatrix4f newValue) Append SFMatrix4f to field for value attribute.appendValue
(SFRotation newValue) Append SFRotation to field for value attribute.appendValue
(SFString newValue) Append SFString to field for value attribute.appendValue
(SFTime newValue) Append SFTime to field for value attribute.appendValue
(SFVec2d newValue) Append SFVec2d to field for value attribute.appendValue
(SFVec2f newValue) Append SFVec2f to field for value attribute.appendValue
(SFVec3d newValue) Append SFVec3d to field for value attribute.appendValue
(SFVec3f newValue) Append SFVec3f to field for value attribute.appendValue
(SFVec4d newValue) Append SFVec4d to field for value attribute.appendValue
(SFVec4f newValue) Append SFVec4f to field for value attribute.Utility method to clear MFNode value of children field.Clear all values in a field declaration.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.Provide String enumeration value (baseType xs:NMTOKEN) ["initializeOnly" | "inputOnly" | "outputOnly" | "inputOutput"] from inputOutput SFString field named accessType.getAccessType
(String fieldName) Indicate accessType corresponding to given fieldName.Provide String value from inputOutput SFString field named appinfo.Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.final String
Defines X3D component for the field element: Corefinal int
Provides default X3D component level for this element: 1Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.Provide String value from inputOutput SFString field named documentation.final String
Provides name of this element: fieldgetFieldType
(String fieldName) Indicate type corresponding to given fieldName.Provide String value from inputOutput SFString field named id.getName()
Provide String value from inputOutput SFString field named name.getType()
Provide String enumeration value (baseType xs:NMTOKEN) ["SFBool" | "MFBool" | "SFColor" | "MFColor" | "SFColorRGBA" | "MFColorRGBA" | "SFDouble" | "MFDouble" | "SFFloat" | "MFFloat" | "SFImage" | "MFImage" | "SFInt32" | "MFInt32" | "SFNode" | "MFNode" | "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.getValue()
Provide String value from inputOutput SFString field named value.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.Get typed value of this field declaration.If type matches, then get typed value of a SFBool field declaration.If type matches, then get typed value of a SFColor field declaration.If type matches, then get typed value of a SFColorRGBA field declaration.If type matches, then get typed value of a SFDouble field declaration.If type matches, then get typed value of a SFFloat field declaration.If type matches, then get typed value of a SFImage field declaration.If type matches, then get typed value of a SFInt32 field declaration.If type matches, then get typed value of a SFMatrix3d field declaration.If type matches, then get typed value of a SFMatrix3f field declaration.If type matches, then get typed value of a SFMatrix4d field declaration.If type matches, then get typed value of a SFMatrix4f field declaration.If type matches, then get typed value of a SFRotation field declaration.If type matches, then get typed value of a SFString field declaration.If type matches, then get typed value of a SFTime field declaration.If type matches, then get typed value of a SFVec2d field declaration.If type matches, then get typed value of a SFVec2f field declaration.If type matches, then get typed value of a SFVec3d field declaration.If type matches, then get typed value of a SFVec3f field declaration.If type matches, then get typed value of a SFVec4d field declaration.If type matches, then get typed value of a SFVec4f field declaration.boolean
Indicate whether an object is available for inputOutput MFNode field children.boolean
Indicate whether a node or statement is found in inputOutput MFNode field children.boolean
hasElementByNameValue
(String nameValue, String elementName) Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
hasNodeByDEF
(String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.final void
Initialize all member variables to default values.setAccessType
(String newValue) Accessor method to assign String enumeration value ("initializeOnly" | "inputOnly" | "outputOnly" | "inputOutput") to inputOutput SFString field named accessType.setAccessType
(SFString newValue) Assign typed object value to SFString accessType field, similar tosetAccessType(String)
.setAppinfo
(String newValue) Accessor method to assign String value to inputOutput SFString field named appinfo.setAppinfo
(SFString newValue) Assign typed object value to SFString appinfo field, similar tosetAppinfo(String)
.setChildren
(ArrayList<X3DNode> newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.void
setChildren
(X3DNode newValue) Set single children node, replacing prior array of existing nodes (if any).final field
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final field
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.setDocumentation
(String newValue) Accessor method to assign String value to inputOutput SFString field named documentation.setDocumentation
(SFString newValue) Assign typed object value to SFString documentation field, similar tosetDocumentation(String)
.final field
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.final field
Accessor method to assign String value to inputOutput SFString field named name.Assign typed object value to SFString name field, similar tosetName(String)
.Accessor method to assign String enumeration value ("SFBool" | "MFBool" | "SFColor" | "MFColor" | "SFColorRGBA" | "MFColorRGBA" | "SFDouble" | "MFDouble" | "SFFloat" | "MFFloat" | "SFImage" | "MFImage" | "SFInt32" | "MFInt32" | "SFNode" | "MFNode" | "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") to inputOutput SFString field named type.Assign typed object value to SFString type field, similar tosetType(String)
.setValue
(boolean newValue) Set typed value of a boolean field declaration.setValue
(boolean[] newValue) Set typed value of a boolean[] field declaration.setValue
(double newValue) Set typed value of a double field declaration.setValue
(double[] newValue) Set typed value of a double[] array field declaration.setValue
(float newValue) Set typed value of a float field declaration.setValue
(float[] newValue) Set typed value of a float[] array field declaration.setValue
(int newValue) Set typed value of a integer field declaration.setValue
(int[] newValue) Set typed value of a integer array field declaration.Accessor method to assign String value to inputOutput SFString field named value.Assign typed object String[] array value to field, similar tosetValue(String)
.Set typed value of a MFBool field declaration.Set typed value of a MFColor field declaration.setValue
(MFColorRGBA newValue) Set typed value of a MFColorRGBA field declaration.Set typed value of a MFDouble field declaration.Set typed value of a MFFloat field declaration.Set typed value of a MFImage field declaration.Set typed value of a MFInt32 field declaration.setValue
(MFMatrix3d newValue) Set typed value of a MFMatrix3d field declaration.setValue
(MFMatrix3f newValue) Set typed value of a MFMatrix3f field declaration.setValue
(MFMatrix4d newValue) Set typed value of a MFMatrix4d field declaration.setValue
(MFMatrix4f newValue) Set typed value of a MFMatrix4f field declaration.setValue
(MFRotation newValue) Set typed value of a MFRotation field declaration.Assign typed object MFString value to field, similar tosetValue(String)
.Set typed value of a MFTime field declaration.Set typed value of a MFVec2d field declaration.Set typed value of a MFVec2f field declaration.Set typed value of a MFVec3d field declaration.Set typed value of a MFVec3f field declaration.Set typed value of a MFVec4d field declaration.Set typed value of a MFVec4f field declaration.Set typed value of a SFBool field declaration.Set typed value of a SFColor field declaration.setValue
(SFColorRGBA newValue) Set typed value of a SFColorRGBA field declaration.Set typed value of a SFDouble field declaration.Set typed value of a SFFloat field declaration.Set typed value of a SFImage field declaration.Set typed value of a SFInt32 field declaration.setValue
(SFMatrix3d newValue) Set typed value of a SFMatrix3d field declaration.setValue
(SFMatrix3f newValue) Set typed value of a SFMatrix3f field declaration.setValue
(SFMatrix4d newValue) Set typed value of a SFMatrix4d field declaration.setValue
(SFMatrix4f newValue) Set typed value of a SFMatrix4f field declaration.setValue
(SFRotation newValue) Set typed value of a SFRotation field declaration.Assign typed object SFString value field, similar tosetValue(String)
.Set typed value of a SFTime field declaration.Set typed value of a SFVec2d field declaration.Set typed value of a SFVec2f field declaration.Set typed value of a SFVec3d field declaration.Set typed value of a SFVec3f field declaration.Set typed value of a SFVec4d field declaration.Set typed value of a SFVec4f field declaration.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, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
ACCESSTYPE_INITIALIZEONLY
Tooltip: A field with accessType initializeOnly can be initialized, but cannot send or receive events. SFString field named accessType with X3DUOM simpleType accessTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "initializeOnly" (Java syntax) or initializeOnly (XML syntax).- See Also:
-
ACCESSTYPE_INPUTONLY
Tooltip: A field with accessType inputOnly cannot be initialized or included in a scene file, but can receive input event values via a ROUTE. SFString field named accessType with X3DUOM simpleType accessTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "inputOnly" (Java syntax) or inputOnly (XML syntax).- See Also:
-
ACCESSTYPE_OUTPUTONLY
Tooltip: A field with accessType outputOnly cannot be initialized or included in a scene file, but can send output event values via a ROUTE. SFString field named accessType with X3DUOM simpleType accessTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "outputOnly" (Java syntax) or outputOnly (XML syntax).- See Also:
-
ACCESSTYPE_INPUTOUTPUT
Tooltip: A field with accessType inputOutput can be initialized, and can also send or receive events. SFString field named accessType with X3DUOM simpleType accessTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "inputOutput" (Java syntax) or inputOutput (XML syntax).- See Also:
-
TYPE_SFBOOL
Tooltip: Single Field (singleton) Boolean. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFBool" (Java syntax) or SFBool (XML syntax).- See Also:
-
TYPE_MFBOOL
Tooltip: Multiple Field (list) Boolean. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFBool" (Java syntax) or MFBool (XML syntax).- See Also:
-
TYPE_SFCOLOR
Tooltip: Single Field (singleton) color value, red-green-blue. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFColor" (Java syntax) or SFColor (XML syntax).- See Also:
-
TYPE_MFCOLOR
Tooltip: Multiple Field (list) color value, red-green-blue. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFColor" (Java syntax) or MFColor (XML syntax).- See Also:
-
TYPE_SFCOLORRGBA
Tooltip: Single Field (singleton) color value, red-green-blue alpha (opacity). SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFColorRGBA" (Java syntax) or SFColorRGBA (XML syntax).- See Also:
-
TYPE_MFCOLORRGBA
Tooltip: Multiple Field (list) color value, red-green-blue alpha (opacity). SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFColorRGBA" (Java syntax) or MFColorRGBA (XML syntax).- See Also:
-
TYPE_SFDOUBLE
Tooltip: Single Field (singleton) double-precision (64-bit) float. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFDouble" (Java syntax) or SFDouble (XML syntax).- See Also:
-
TYPE_MFDOUBLE
Tooltip: Multiple Field (list) 2-tuple double-precision (64-bit) float vector. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFDouble" (Java syntax) or MFDouble (XML syntax).- See Also:
-
TYPE_SFFLOAT
Tooltip: Single Field (singleton) single-precision (32-bit) float. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFFloat" (Java syntax) or SFFloat (XML syntax).- See Also:
-
TYPE_MFFLOAT
Tooltip: Multiple Field (list) single-precision (32-bit) float vector. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFFloat" (Java syntax) or MFFloat (XML syntax).- See Also:
-
TYPE_SFIMAGE
Tooltip: Single Field (singleton) image value. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFImage" (Java syntax) or SFImage (XML syntax).- See Also:
-
TYPE_MFIMAGE
Tooltip: Multiple Field (list) image values. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFImage" (Java syntax) or MFImage (XML syntax).- See Also:
-
TYPE_SFINT32
Tooltip: Single Field (singleton) 32-bit integer. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFInt32" (Java syntax) or SFInt32 (XML syntax).- See Also:
-
TYPE_MFINT32
Tooltip: Multiple Field (list) 32-bit integer. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFInt32" (Java syntax) or MFInt32 (XML syntax).- See Also:
-
TYPE_SFNODE
Tooltip: Single Field (singleton) node. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFNode" (Java syntax) or SFNode (XML syntax).- See Also:
-
TYPE_MFNODE
Tooltip: Multiple Field (list) nodes. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFNode" (Java syntax) or MFNode (XML syntax).- See Also:
-
TYPE_SFROTATION
Tooltip: Single Field (singleton) rotation value using 3-tuple axis, radian angle. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFRotation" (Java syntax) or SFRotation (XML syntax).- See Also:
-
TYPE_MFROTATION
Tooltip: Multiple Field (list) rotation values using 3-tuple axis, radian angle. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFRotation" (Java syntax) or MFRotation (XML syntax).- See Also:
-
TYPE_SFSTRING
Tooltip: Single Field (singleton) string value. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFString" (Java syntax) or SFString (XML syntax).- See Also:
-
TYPE_MFSTRING
Tooltip: Multiple Field (list) SFString array. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFString" (Java syntax) or MFString (XML syntax).- See Also:
-
TYPE_SFTIME
Tooltip: Single Field (singleton) time value in seconds. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFTime" (Java syntax) or SFTime (XML syntax).- See Also:
-
TYPE_MFTIME
Tooltip: Multiple Field (list) time array in seconds. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFTime" (Java syntax) or MFTime (XML syntax).- See Also:
-
TYPE_SFVEC2D
Tooltip: Single Field (singleton) 2-tuple double-precision float vector. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFVec2d" (Java syntax) or SFVec2d (XML syntax).- See Also:
-
TYPE_MFVEC2D
Tooltip: Multiple Field (list) 2-tuple double-precision float vectors. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFVec2d" (Java syntax) or MFVec2d (XML syntax).- See Also:
-
TYPE_SFVEC2F
Tooltip: Single Field (singleton) 2-tuple single-precision float vector. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFVec2f" (Java syntax) or SFVec2f (XML syntax).- See Also:
-
TYPE_MFVEC2F
Tooltip: Multiple Field (list) 2-tuple single-precision float vectors. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFVec2f" (Java syntax) or MFVec2f (XML syntax).- See Also:
-
TYPE_SFVEC3D
Tooltip: Single Field (singleton) 3-tuple double-precision float vector. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFVec3d" (Java syntax) or SFVec3d (XML syntax).- See Also:
-
TYPE_MFVEC3D
Tooltip: Multiple Field (list) 3-tuple double-precision float vectors. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFVec3d" (Java syntax) or MFVec3d (XML syntax).- See Also:
-
TYPE_SFVEC3F
Tooltip: Single Field (singleton) 3-tuple single-precision float vector. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFVec3f" (Java syntax) or SFVec3f (XML syntax).- See Also:
-
TYPE_MFVEC3F
Tooltip: Multiple Field (list) 3-tuple single-precision float vectors. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFVec3f" (Java syntax) or MFVec3f (XML syntax).- See Also:
-
TYPE_SFVEC4D
Tooltip: Single Field (singleton) 4-tuple double-precision float vector. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFVec4d" (Java syntax) or SFVec4d (XML syntax).- See Also:
-
TYPE_MFVEC4D
Tooltip: Multiple Field (list) 4-tuple double-precision float vectors. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFVec4d" (Java syntax) or MFVec4d (XML syntax).- See Also:
-
TYPE_SFVEC4F
Tooltip: Single Field (singleton) 4-tuple single-precision float vector. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFVec4f" (Java syntax) or SFVec4f (XML syntax).- See Also:
-
TYPE_MFVEC4F
Tooltip: Multiple Field (list) 4-tuple single-precision float vectors. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFVec4f" (Java syntax) or MFVec4f (XML syntax).- See Also:
-
TYPE_SFMATRIX3D
Tooltip: Single Field (singleton) 3×3 matrix of double-precision floating point numbers. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFMatrix3d" (Java syntax) or SFMatrix3d (XML syntax).- See Also:
-
TYPE_MFMATRIX3D
Tooltip: Multiple Field (list) 3×3 matrices of double-precision floating point numbers. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFMatrix3d" (Java syntax) or MFMatrix3d (XML syntax).- See Also:
-
TYPE_SFMATRIX3F
Tooltip: Single Field (singleton) 3×3 matrix of single-precision floating point numbers. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFMatrix3f" (Java syntax) or SFMatrix3f (XML syntax).- See Also:
-
TYPE_MFMATRIX3F
Tooltip: Multiple Field (list) 3×3 matrices of double-precision floating point numbers. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFMatrix3f" (Java syntax) or MFMatrix3f (XML syntax).- See Also:
-
TYPE_SFMATRIX4D
Tooltip: Single Field (singleton) 4×4 matrix of double-precision floating point numbers. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFMatrix4d" (Java syntax) or SFMatrix4d (XML syntax).- See Also:
-
TYPE_MFMATRIX4D
Tooltip: Multiple Field (list) 4×4 matric3w of double-precision floating point numbers. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFMatrix4d" (Java syntax) or MFMatrix4d (XML syntax).- See Also:
-
TYPE_SFMATRIX4F
Tooltip: Single Field (singleton) 4×4 matrix of single-precision floating point numbers. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "SFMatrix4f" (Java syntax) or SFMatrix4f (XML syntax).- See Also:
-
TYPE_MFMATRIX4F
Tooltip: Multiple Field (list) 4×4 matrices of single-precision floating point numbers. SFString field named type with X3DUOM simpleType fieldTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MFMatrix4f" (Java syntax) or MFMatrix4f (XML syntax).- See Also:
-
NAME
String constant NAME provides name of this element: field.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the field element: Core- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Core component level for this element: 1- See Also:
-
ACCESSTYPE_DEFAULT_VALUE
Initial value is required to be set for validity: SFString field named accessType has default value equal to an empty string.- See Also:
-
APPINFO_DEFAULT_VALUE
SFString field named appinfo has default value equal to an empty string.- See Also:
-
DOCUMENTATION_DEFAULT_VALUE
SFString field named documentation has default value equal to an empty string.- See Also:
-
NAME_DEFAULT_VALUE
SFString field named name has default value equal to an empty string.- See Also:
-
TYPE_DEFAULT_VALUE
Initial value is required to be set for validity: SFString field named type has default value equal to an empty string.- See Also:
-
VALUE_DEFAULT_VALUE
SFString field named value has default value equal to an empty string.- See Also:
-
-
Constructor Details
-
field
public field()Constructor for field to initialize member variables with default values. -
field
Utility constructor that assigns name, type, accessType (required)- Parameters:
fieldName
- name for this field (required, and locally unique among peer fields)fieldType
- appropriate type value for this field (required)fieldAccessType
- appropriate accessType value for this field (required)
-
field
Utility constructor that assigns name, type, accessType (required) and default value (if appropriate)- Parameters:
fieldName
- name for this field (required, and locally unique among peer fields)fieldType
- appropriate type value for this field (required)fieldAccessType
- appropriate accessType value for this field (required)defaultValue
- string version of default value for this field (if appropriate)
-
-
Method Details
-
getElementName
Provides name of this element: field- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the field 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: 1- 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:
-
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:
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteStatement
-
getAccessType
Provide String enumeration value (baseType xs:NMTOKEN) ["initializeOnly" | "inputOnly" | "outputOnly" | "inputOutput"] from inputOutput SFString field named accessType.
Tooltip: Event-model semantics for field set/get capabilities.- Hint: renamed accessType correspondences for X3D from VRML97 are inputOnly=eventIn, outputOnly=eventOut, initializeOnly=field, inputOutput=exposedField.
- Warning: inputOutput=exposedField not allowed in VRML97 Script nodes, use initializeOnly=field for backwards compatibility.
- Hint: an accessType value is required and must be provided.
- Hint: X3D Architecture 4.4.2.2 Field semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#FieldSemantics
- Hint: X3D XML Encoding 4.3.7 Prototype and field declaration syntax, https://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/concepts.html#PrototypeAndFieldDeclarationSyntax
Available enumeration values for string comparison:INITIALIZEONLY
,INPUTONLY
,OUTPUTONLY
,INPUTOUTPUT
.- Returns:
- value of accessType field
-
setAccessType
Accessor method to assign String enumeration value ("initializeOnly" | "inputOnly" | "outputOnly" | "inputOutput") to inputOutput SFString field named accessType.
Warning: authors can only choose from a strict list of enumeration values (INITIALIZEONLY
,INPUTONLY
,OUTPUTONLY
,INPUTOUTPUT
).
Tooltip: Event-model semantics for field set/get capabilities.- Hint: renamed accessType correspondences for X3D from VRML97 are inputOnly=eventIn, outputOnly=eventOut, initializeOnly=field, inputOutput=exposedField.
- Warning: inputOutput=exposedField not allowed in VRML97 Script nodes, use initializeOnly=field for backwards compatibility.
- Hint: an accessType value is required and must be provided.
- Hint: X3D Architecture 4.4.2.2 Field semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#FieldSemantics
- Hint: X3D XML Encoding 4.3.7 Prototype and field declaration syntax, https://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/concepts.html#PrototypeAndFieldDeclarationSyntax
- Parameters:
newValue
- is new value for the accessType field.- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAccessType
Assign typed object value to SFString accessType field, similar tosetAccessType(String)
.- Parameters:
newValue
- is new value for the accessType field.- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getAppinfo
Provide String value from inputOutput SFString field named appinfo.
Tooltip: Application information to provide simple description usable as a tooltip, similar to XML Schema appinfo tag. *- Returns:
- value of appinfo field
-
setAppinfo
Accessor method to assign String value to inputOutput SFString field named appinfo.
Tooltip: Application information to provide simple description usable as a tooltip, similar to XML Schema appinfo tag. *- Parameters:
newValue
- is new value for the appinfo field.- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAppinfo
Assign typed object value to SFString appinfo field, similar tosetAppinfo(String)
.- Parameters:
newValue
- is new value for the appinfo field.- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getChildren
Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.
Tooltip: [X3DNode] If this field definition has type SFNode or MFNode, then initialization node (or nodes) of any appropriate type may be provided as children of the field definition.- Warning: do not include a value attribute when providing such child node(s).
- Hint: X3D Architecture, Concepts, 4.4.2 Object model, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#Objectmodel
- Hint: X3D Architecture, Concepts, 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#PrototypeSemantics
- Hint: X3D Architecture, Scripting component, 29.4.1 Script https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/scripting.html#Script
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNode.- Returns:
- value of children field
- See Also:
-
setChildren
Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.
Tooltip: [X3DNode] If this field definition has type SFNode or MFNode, then initialization node (or nodes) of any appropriate type may be provided as children of the field definition.- Warning: do not include a value attribute when providing such child node(s).
- Hint: X3D Architecture, Concepts, 4.4.2 Object model, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#Objectmodel
- Hint: X3D Architecture, Concepts, 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#PrototypeSemantics
- Hint: X3D Architecture, Scripting component, 29.4.1 Script https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/scripting.html#Script
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:
field
- 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 ProtoInstance (with appropriate node type and containerField value) to MFNode array for children field.
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.- Parameters:
newValue
- is new value to be appended the parts field.- Returns:
field
- 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:
field
- 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
-
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:
-
addComments
Add comment as CommentsBlock to children field- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
field
- 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:
field
- 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Parameters:
newValue
- is new value for the class field.- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDocumentation
Provide String value from inputOutput SFString field named documentation.
Tooltip: Documentation url for further information, similar to XML Schema documentation tag. *- Returns:
- value of documentation field
-
setDocumentation
Accessor method to assign String value to inputOutput SFString field named documentation.
Tooltip: Documentation url for further information, similar to XML Schema documentation tag. *- Parameters:
newValue
- is new value for the documentation field.- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDocumentation
Assign typed object value to SFString documentation field, similar tosetDocumentation(String)
.- Parameters:
newValue
- is new value for the documentation field.- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Parameters:
newValue
- is new value for the id field.- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getName
Provide String value from inputOutput SFString field named name.
Tooltip: Name of this field declaration.- 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 this field declaration.- 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:
field
- 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Parameters:
newValue
- is new value for the style field.- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getType
Provide String enumeration value (baseType xs:NMTOKEN) ["SFBool" | "MFBool" | "SFColor" | "MFColor" | "SFColorRGBA" | "MFColorRGBA" | "SFDouble" | "MFDouble" | "SFFloat" | "MFFloat" | "SFImage" | "MFImage" | "SFInt32" | "MFInt32" | "SFNode" | "MFNode" | "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.
Tooltip: Base type of this field variable.- Hint: a type value is required and must be provided.
Available enumeration values for string comparison:SFBOOL
,MFBOOL
,SFCOLOR
,MFCOLOR
,SFCOLORRGBA
,MFCOLORRGBA
,SFDOUBLE
,MFDOUBLE
,SFFLOAT
,MFFLOAT
,SFIMAGE
,MFIMAGE
,SFINT32
,MFINT32
,SFNODE
,MFNODE
,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
.- Returns:
- value of type field
-
setType
Accessor method to assign String enumeration value ("SFBool" | "MFBool" | "SFColor" | "MFColor" | "SFColorRGBA" | "MFColorRGBA" | "SFDouble" | "MFDouble" | "SFFloat" | "MFFloat" | "SFImage" | "MFImage" | "SFInt32" | "MFInt32" | "SFNode" | "MFNode" | "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") to inputOutput SFString field named type.
Warning: authors can only choose from a strict list of enumeration values (SFBOOL
,MFBOOL
,SFCOLOR
,MFCOLOR
,SFCOLORRGBA
,MFCOLORRGBA
,SFDOUBLE
,MFDOUBLE
,SFFLOAT
,MFFLOAT
,SFIMAGE
,MFIMAGE
,SFINT32
,MFINT32
,SFNODE
,MFNODE
,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
).
Tooltip: Base type of this field variable.- Hint: a type value is required and must be provided.
- Parameters:
newValue
- is new value for the type field.- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setType
Assign typed object value to SFString type field, similar tosetType(String)
.- Parameters:
newValue
- is new value for the type field.- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getValue
Provide String value from inputOutput SFString field named value.
Tooltip: Provide default initialization value for this field variable (which may be re-initialized later by instantiation value of a named ProtoInstance fieldValue).- Hint: SFNode/MFNode fields are initialized using contained node content, instead of this value attribute.
- Warning: do not include a value attribute when providing child node(s) for type SFNode/MFNode.
- Hint: value is required for Script and ProtoDeclare unless MF-type array initialization is empty list, SFString initialization is empty string, or SFNode is being initialized.
- Hint: SFNode/MFNode fields are initialized by contained node element(s), if any.
- Warning: setting a value is not allowed for ExternProtoDeclare field declarations, since original ProtoDeclare initializations or local ProtoInstance fieldValue initializations take precedence.
- Warning: not allowed for field variables with accessType inputOnly or outputOnly.
- Warning: initialization value is not allowed if this field is part of a Script interface and has a corresponding IS/connect definition.
- Returns:
- value of value field
-
setValue
Accessor method to assign String value to inputOutput SFString field named value.
Tooltip: Provide default initialization value for this field variable (which may be re-initialized later by instantiation value of a named ProtoInstance fieldValue).- Hint: SFNode/MFNode fields are initialized using contained node content, instead of this value attribute.
- Warning: do not include a value attribute when providing child node(s) for type SFNode/MFNode.
- Hint: value is required for Script and ProtoDeclare unless MF-type array initialization is empty list, SFString initialization is empty string, or SFNode is being initialized.
- Hint: SFNode/MFNode fields are initialized by contained node element(s), if any.
- Warning: setting a value is not allowed for ExternProtoDeclare field declarations, since original ProtoDeclare initializations or local ProtoInstance fieldValue initializations take precedence.
- Warning: not allowed for field variables with accessType inputOnly or outputOnly.
- Warning: initialization value is not allowed if this field is part of a Script interface and has a corresponding IS/connect definition.
- Parameters:
newValue
- is new value for the value field.- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFBool to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFBool to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFColor to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFColor to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFColorRGBA to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFColorRGBA to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFDouble to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFDouble to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFFloat to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFFloat to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFImage to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFImage to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFInt32 to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFInt32 to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFMatrix3d to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFMatrix3d to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFMatrix3f to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFMatrix3f to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFMatrix4d to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFMatrix4d to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFMatrix4f to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFMatrix4f to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFRotation to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFRotation to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFString to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFString to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFTime to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFTime to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec2d to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec2d to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec2f to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec2f to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec3d to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec3d to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec3f to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec3f to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec4d to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec4d to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec4f to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec4f to field 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:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append boolean to field 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:
fieldValue
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append integer to field 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:
fieldValue
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append float to field 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:
fieldValue
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append double to field 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:
fieldValue
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append String to field 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:
fieldValue
- 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 field, similar tosetValue(String)
.- Parameters:
newValue
- is new value for the value field.- Returns:
field
- 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 field, similar tosetValue(String)
.- Parameters:
newValue
- is new value for the value field.- Returns:
field
- 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:
field
- 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:
-
toStringX3D
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
-
toStringClassicVRML
Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
-
toStringVRML97
Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
-
hasElementByNameValue
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
-
hasNodeByDEF
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
-
validate
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-
getValueSFBool
If type matches, then get typed value of a SFBool field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFBool field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFBool field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFColor field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFColor field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFColorRGBA field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFColorRGBA field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFDouble field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFDouble field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFFloat field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFFloat field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFImage field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFImage field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFInt32 field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFInt32 field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFMatrix3d field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFMatrix3d field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFMatrix3f field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFMatrix3f field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFMatrix4d field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFMatrix4d field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFMatrix4f field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFMatrix4f field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFRotation field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFRotation field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
getValueMFString
Get typed value of this field declaration.- Returns:
- typed value object, if values are available
-
getValueSFTime
If type matches, then get typed value of a SFTime field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFTime field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFTime field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFVec2d field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFVec2d field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFVec2f field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFVec2f field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFVec3d field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFVec3d field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFVec3f field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFVec3f field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFVec4d field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFVec4d field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object (if values are available), otherwise returns default object
-
setValue
Set typed value of a SFVec4f field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration.- Returns:
- typed value object, if values are available
-
setValue
Set typed value of a MFVec4f field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
clearValues
-
setValue
Set typed value of a boolean field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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[] field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- 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 field declaration. WARNING: must first setType() in ancestor field declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
field
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-