Package org.web3d.x3d.jsail.Core
Class fieldObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteStatement
org.web3d.x3d.jsail.Core.fieldObject
public class fieldObject extends X3DConcreteStatement
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.
X3D statement tooltip: [X3D statement] A field statement defines an interface attribute or node.
X3D statement tooltip: [X3D statement] A field statement defines an interface attribute or node.
- Hint: first add a parent Script node or ProtoDeclare/ProtoInterface statements 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).
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ACCESSTYPE_DEFAULT_VALUE
Initial value is required to be set for validity: SFString field named accessType has default value equal to an empty string.static java.lang.String
ACCESSTYPE_INITIALIZEONLY
Tooltip: A field with accessType initializeOnly can be initialized, but cannot send or receive events.static java.lang.String
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.static java.lang.String
ACCESSTYPE_INPUTOUTPUT
Tooltip: A field with accessType inputOutput can be initialized, and can also send or receive events.static java.lang.String
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.static java.lang.String
APPINFO_DEFAULT_VALUE
SFString field named appinfo has default value equal to an empty string.static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the field element: Corestatic java.lang.String
DOCUMENTATION_DEFAULT_VALUE
SFString field named documentation has default value equal to an empty string.static int
LEVEL
Integer constant LEVEL provides default X3D Core component level for this element: 1static java.lang.String
NAME
String constant NAME provides name of this element: field.static java.lang.String
NAME_DEFAULT_VALUE
SFString field named name has default value equal to an empty string.static java.lang.String
TYPE_DEFAULT_VALUE
Initial value is required to be set for validity: SFString field named type has default value equal to an empty string.static java.lang.String
TYPE_MFBOOL
Tooltip: Multiple Field (list) Boolean.static java.lang.String
TYPE_MFCOLOR
Tooltip: Multiple Field (list) color value, red-green-blue.static java.lang.String
TYPE_MFCOLORRGBA
Tooltip: Multiple Field (list) color value, red-green-blue alpha (opacity).static java.lang.String
TYPE_MFDOUBLE
Tooltip: Multiple Field (list) 2-tuple double-precision (64-bit) float vector.static java.lang.String
TYPE_MFFLOAT
Tooltip: Multiple Field (list) single-precision (32-bit) float vector.static java.lang.String
TYPE_MFIMAGE
Tooltip: Multiple Field (list) image values.static java.lang.String
TYPE_MFINT32
Tooltip: Multiple Field (list) 32-bit integer.static java.lang.String
TYPE_MFMATRIX3D
Tooltip: Multiple Field (list) 3×3 matrices of double-precision floating point numbers.static java.lang.String
TYPE_MFMATRIX3F
Tooltip: Multiple Field (list) 3×3 matrices of double-precision floating point numbers.static java.lang.String
TYPE_MFMATRIX4D
Tooltip: Multiple Field (list) 4×4 matric3w of double-precision floating point numbers.static java.lang.String
TYPE_MFMATRIX4F
Tooltip: Multiple Field (list) 4×4 matrices of single-precision floating point numbers.static java.lang.String
TYPE_MFNODE
Tooltip: Multiple Field (list) nodes.static java.lang.String
TYPE_MFROTATION
Tooltip: Multiple Field (list) rotation values using 3-tuple axis, radian angle.static java.lang.String
TYPE_MFSTRING
Tooltip: Multiple Field (list) SFString array.static java.lang.String
TYPE_MFTIME
Tooltip: Multiple Field (list) time array in seconds.static java.lang.String
TYPE_MFVEC2D
Tooltip: Multiple Field (list) 2-tuple double-precision float vectors.static java.lang.String
TYPE_MFVEC2F
Tooltip: Multiple Field (list) 2-tuple single-precision float vectors.static java.lang.String
TYPE_MFVEC3D
Tooltip: Multiple Field (list) 3-tuple double-precision float vectors.static java.lang.String
TYPE_MFVEC3F
Tooltip: Multiple Field (list) 3-tuple single-precision float vectors.static java.lang.String
TYPE_MFVEC4D
Tooltip: Multiple Field (list) 4-tuple double-precision float vectors.static java.lang.String
TYPE_MFVEC4F
Tooltip: Multiple Field (list) 4-tuple single-precision float vectors.static java.lang.String
TYPE_SFBOOL
Tooltip: Single Field (singleton) Boolean.static java.lang.String
TYPE_SFCOLOR
Tooltip: Single Field (singleton) color value, red-green-blue.static java.lang.String
TYPE_SFCOLORRGBA
Tooltip: Single Field (singleton) color value, red-green-blue alpha (opacity).static java.lang.String
TYPE_SFDOUBLE
Tooltip: Single Field (singleton) double-precision (64-bit) float.static java.lang.String
TYPE_SFFLOAT
Tooltip: Single Field (singleton) single-precision (32-bit) float.static java.lang.String
TYPE_SFIMAGE
Tooltip: Single Field (singleton) image value.static java.lang.String
TYPE_SFINT32
Tooltip: Single Field (singleton) 32-bit integer.static java.lang.String
TYPE_SFMATRIX3D
Tooltip: Single Field (singleton) 3×3 matrix of double-precision floating point numbers.static java.lang.String
TYPE_SFMATRIX3F
Tooltip: Single Field (singleton) 3×3 matrix of single-precision floating point numbers.static java.lang.String
TYPE_SFMATRIX4D
Tooltip: Single Field (singleton) 4×4 matrix of double-precision floating point numbers.static java.lang.String
TYPE_SFMATRIX4F
Tooltip: Single Field (singleton) 4×4 matrix of single-precision floating point numbers.static java.lang.String
TYPE_SFNODE
Tooltip: Single Field (singleton) node.static java.lang.String
TYPE_SFROTATION
Tooltip: Single Field (singleton) rotation value using 3-tuple axis, radian angle.static java.lang.String
TYPE_SFSTRING
Tooltip: Single Field (singleton) string value.static java.lang.String
TYPE_SFTIME
Tooltip: Single Field (singleton) time value in seconds.static java.lang.String
TYPE_SFVEC2D
Tooltip: Single Field (singleton) 2-tuple double-precision float vector.static java.lang.String
TYPE_SFVEC2F
Tooltip: Single Field (singleton) 2-tuple single-precision float vector.static java.lang.String
TYPE_SFVEC3D
Tooltip: Single Field (singleton) 3-tuple double-precision float vector.static java.lang.String
TYPE_SFVEC3F
Tooltip: Single Field (singleton) 3-tuple single-precision float vector.static java.lang.String
TYPE_SFVEC4D
Tooltip: Single Field (singleton) 4-tuple double-precision float vector.static java.lang.String
TYPE_SFVEC4F
Tooltip: Single Field (singleton) 4-tuple single-precision float vector.static java.lang.String
VALUE_DEFAULT_VALUE
SFString field named value has default value equal to an empty string. -
Constructor Summary
Constructors Constructor Description fieldObject()
Constructor for fieldObject to initialize member variables with default values.fieldObject(java.lang.String fieldName, java.lang.String fieldType, java.lang.String fieldAccessType)
Utility constructor that assigns name, type, accessType (required)fieldObject(java.lang.String fieldName, java.lang.String fieldType, java.lang.String fieldAccessType, java.lang.String defaultValue)
Utility constructor that assigns name, type, accessType (required) and default value (if appropriate) -
Method Summary
Modifier and Type Method Description fieldObject
addChild(X3DNode newValue)
Utility method to add single child element to contained list of existing children nodes (if any).fieldObject
addChildren(ProtoInstanceObject newValue)
Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for children field.void
addChildren(X3DNode newValue)
Add single node to existing array of children nodes (if any).void
addChildren(X3DNode[] newValue)
Add array of children nodes to array of existing nodes (if any).fieldObject
addComments(java.lang.String newComment)
Add comment as CommentsBlock to children fieldfieldObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to children fieldfieldObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to children fieldfieldObject
appendValue(boolean newValue)
Append boolean to field for value attribute.fieldObject
appendValue(double newValue)
Append double to field for value attribute.fieldObject
appendValue(float newValue)
Append float to field for value attribute.fieldObject
appendValue(int newValue)
Append integer to field for value attribute.fieldObject
appendValue(java.lang.String newValue)
Append String to field for value attribute.fieldObject
appendValue(MFBoolObject newValue)
Append MFBoolObject to field for value attribute.fieldObject
appendValue(MFColorObject newValue)
Append MFColorObject to field for value attribute.fieldObject
appendValue(MFColorRGBAObject newValue)
Append MFColorRGBAObject to field for value attribute.fieldObject
appendValue(MFDoubleObject newValue)
Append MFDoubleObject to field for value attribute.fieldObject
appendValue(MFFloatObject newValue)
Append MFFloatObject to field for value attribute.fieldObject
appendValue(MFImageObject newValue)
Append MFImageObject to field for value attribute.fieldObject
appendValue(MFInt32Object newValue)
Append MFInt32Object to field for value attribute.fieldObject
appendValue(MFMatrix3dObject newValue)
Append MFMatrix3dObject to field for value attribute.fieldObject
appendValue(MFMatrix3fObject newValue)
Append MFMatrix3fObject to field for value attribute.fieldObject
appendValue(MFMatrix4dObject newValue)
Append MFMatrix4dObject to field for value attribute.fieldObject
appendValue(MFMatrix4fObject newValue)
Append MFMatrix4fObject to field for value attribute.fieldObject
appendValue(MFRotationObject newValue)
Append MFRotationObject to field for value attribute.fieldObject
appendValue(MFStringObject newValue)
Append MFStringObject to field for value attribute.fieldObject
appendValue(MFTimeObject newValue)
Append MFTimeObject to field for value attribute.fieldObject
appendValue(MFVec2dObject newValue)
Append MFVec2dObject to field for value attribute.fieldObject
appendValue(MFVec2fObject newValue)
Append MFVec2fObject to field for value attribute.fieldObject
appendValue(MFVec3dObject newValue)
Append MFVec3dObject to field for value attribute.fieldObject
appendValue(MFVec3fObject newValue)
Append MFVec3fObject to field for value attribute.fieldObject
appendValue(MFVec4dObject newValue)
Append MFVec4dObject to field for value attribute.fieldObject
appendValue(MFVec4fObject newValue)
Append MFVec4fObject to field for value attribute.fieldObject
appendValue(SFBoolObject newValue)
Append SFBoolObject to field for value attribute.fieldObject
appendValue(SFColorObject newValue)
Append SFColorObject to field for value attribute.fieldObject
appendValue(SFColorRGBAObject newValue)
Append SFColorRGBAObject to field for value attribute.fieldObject
appendValue(SFDoubleObject newValue)
Append SFDoubleObject to field for value attribute.fieldObject
appendValue(SFFloatObject newValue)
Append SFFloatObject to field for value attribute.fieldObject
appendValue(SFImageObject newValue)
Append SFImageObject to field for value attribute.fieldObject
appendValue(SFInt32Object newValue)
Append SFInt32Object to field for value attribute.fieldObject
appendValue(SFMatrix3dObject newValue)
Append SFMatrix3dObject to field for value attribute.fieldObject
appendValue(SFMatrix3fObject newValue)
Append SFMatrix3fObject to field for value attribute.fieldObject
appendValue(SFMatrix4dObject newValue)
Append SFMatrix4dObject to field for value attribute.fieldObject
appendValue(SFMatrix4fObject newValue)
Append SFMatrix4fObject to field for value attribute.fieldObject
appendValue(SFRotationObject newValue)
Append SFRotationObject to field for value attribute.fieldObject
appendValue(SFStringObject newValue)
Append SFStringObject to field for value attribute.fieldObject
appendValue(SFTimeObject newValue)
Append SFTimeObject to field for value attribute.fieldObject
appendValue(SFVec2dObject newValue)
Append SFVec2dObject to field for value attribute.fieldObject
appendValue(SFVec2fObject newValue)
Append SFVec2fObject to field for value attribute.fieldObject
appendValue(SFVec3dObject newValue)
Append SFVec3dObject to field for value attribute.fieldObject
appendValue(SFVec3fObject newValue)
Append SFVec3fObject to field for value attribute.fieldObject
appendValue(SFVec4dObject newValue)
Append SFVec4dObject to field for value attribute.fieldObject
appendValue(SFVec4fObject newValue)
Append SFVec4fObject to field for value attribute.fieldObject
clearChildren()
Utility method to clear MFNode value of children field.fieldObject
clearValues()
Clear all values in a field declaration.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteNode
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType()
Provide String enumeration value (baseType xs:NMTOKEN) ["initializeOnly" | "inputOnly" | "outputOnly" | "inputOutput"] from inputOutput SFString field named accessType.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.java.lang.String
getAppinfo()
Provide String value from inputOutput SFString field named appinfo.java.util.ArrayList<X3DNode>
getChildren()
Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.java.lang.String
getComponent()
Defines X3D component for the field element: Coreint
getComponentLevel()
Provides default X3D component level for this element: 1java.lang.String
getDocumentation()
Provide String value from inputOutput SFString field named documentation.java.lang.String
getElementName()
Provides name of this element: fieldjava.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.java.lang.String
getName()
Provide String value from inputOutput SFString field named name.java.lang.String
getType()
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.java.lang.String
getValue()
Provide String value from inputOutput SFString field named value.MFBoolObject
getValueMFBool()
Get typed value of this field declaration.MFColorObject
getValueMFColor()
Get typed value of this field declaration.MFColorRGBAObject
getValueMFColorRGBA()
Get typed value of this field declaration.MFDoubleObject
getValueMFDouble()
Get typed value of this field declaration.MFFloatObject
getValueMFFloat()
Get typed value of this field declaration.MFImageObject
getValueMFImage()
Get typed value of this field declaration.MFInt32Object
getValueMFInt32()
Get typed value of this field declaration.MFMatrix3dObject
getValueMFMatrix3d()
Get typed value of this field declaration.MFMatrix3fObject
getValueMFMatrix3f()
Get typed value of this field declaration.MFMatrix4dObject
getValueMFMatrix4d()
Get typed value of this field declaration.MFMatrix4fObject
getValueMFMatrix4f()
Get typed value of this field declaration.MFRotationObject
getValueMFRotation()
Get typed value of this field declaration.MFStringObject
getValueMFString()
Get typed value of this field declaration.MFTimeObject
getValueMFTime()
Get typed value of this field declaration.MFVec2dObject
getValueMFVec2d()
Get typed value of this field declaration.MFVec2fObject
getValueMFVec2f()
Get typed value of this field declaration.MFVec3dObject
getValueMFVec3d()
Get typed value of this field declaration.MFVec3fObject
getValueMFVec3f()
Get typed value of this field declaration.MFVec4dObject
getValueMFVec4d()
Get typed value of this field declaration.MFVec4fObject
getValueMFVec4f()
Get typed value of this field declaration.SFBoolObject
getValueSFBool()
If type matches, then get typed value of a SFBool field declaration.SFColorObject
getValueSFColor()
If type matches, then get typed value of a SFColor field declaration.SFColorRGBAObject
getValueSFColorRGBA()
If type matches, then get typed value of a SFColorRGBA field declaration.SFDoubleObject
getValueSFDouble()
If type matches, then get typed value of a SFDouble field declaration.SFFloatObject
getValueSFFloat()
If type matches, then get typed value of a SFFloat field declaration.SFImageObject
getValueSFImage()
If type matches, then get typed value of a SFImage field declaration.SFInt32Object
getValueSFInt32()
If type matches, then get typed value of a SFInt32 field declaration.SFMatrix3dObject
getValueSFMatrix3d()
If type matches, then get typed value of a SFMatrix3d field declaration.SFMatrix3fObject
getValueSFMatrix3f()
If type matches, then get typed value of a SFMatrix3f field declaration.SFMatrix4dObject
getValueSFMatrix4d()
If type matches, then get typed value of a SFMatrix4d field declaration.SFMatrix4fObject
getValueSFMatrix4f()
If type matches, then get typed value of a SFMatrix4f field declaration.SFRotationObject
getValueSFRotation()
If type matches, then get typed value of a SFRotation field declaration.SFStringObject
getValueSFString()
If type matches, then get typed value of a SFString field declaration.SFTimeObject
getValueSFTime()
If type matches, then get typed value of a SFTime field declaration.SFVec2dObject
getValueSFVec2d()
If type matches, then get typed value of a SFVec2d field declaration.SFVec2fObject
getValueSFVec2f()
If type matches, then get typed value of a SFVec2f field declaration.SFVec3dObject
getValueSFVec3d()
If type matches, then get typed value of a SFVec3d field declaration.SFVec3fObject
getValueSFVec3f()
If type matches, then get typed value of a SFVec3f field declaration.SFVec4dObject
getValueSFVec4d()
If type matches, then get typed value of a SFVec4d field declaration.SFVec4fObject
getValueSFVec4f()
If type matches, then get typed value of a SFVec4f field declaration.boolean
hasChildren()
Indicate whether an object is available for inputOutput MFNode field children.boolean
hasChildrenElements()
Indicate whether a node or statement is found in inputOutput MFNode field children.boolean
hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
hasNodeByDEF(java.lang.String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.void
initialize()
Initialize all member variables to default values.fieldObject
setAccessType(java.lang.String newValue)
Accessor method to assign String enumeration value ("initializeOnly" | "inputOnly" | "outputOnly" | "inputOutput") to inputOutput SFString field named accessType.fieldObject
setAccessType(SFStringObject newValue)
Assign typed object value to SFString accessType field, similar tosetAccessType(String)
.fieldObject
setAppinfo(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named appinfo.fieldObject
setAppinfo(SFStringObject newValue)
Assign typed object value to SFString appinfo field, similar tosetAppinfo(String)
.fieldObject
setChildren(java.util.ArrayList<X3DNode> newValue)
Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.void
setChildren(X3DNode newValue)
Set single children node, replacing prior array of existing nodes (if any).fieldObject
setDocumentation(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named documentation.fieldObject
setDocumentation(SFStringObject newValue)
Assign typed object value to SFString documentation field, similar tosetDocumentation(String)
.fieldObject
setName(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named name.fieldObject
setName(SFStringObject newValue)
Assign typed object value to SFString name field, similar tosetName(String)
.fieldObject
setType(java.lang.String newValue)
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.fieldObject
setType(SFStringObject newValue)
Assign typed object value to SFString type field, similar tosetType(String)
.fieldObject
setValue(boolean newValue)
Set typed value of a boolean field declaration.fieldObject
setValue(boolean[] newValue)
Set typed value of a boolean[] field declaration.fieldObject
setValue(double newValue)
Set typed value of a double field declaration.fieldObject
setValue(double[] newValue)
Set typed value of a double[] array field declaration.fieldObject
setValue(float newValue)
Set typed value of a float field declaration.fieldObject
setValue(float[] newValue)
Set typed value of a float[] array field declaration.fieldObject
setValue(int newValue)
Set typed value of a integer field declaration.fieldObject
setValue(int[] newValue)
Set typed value of a integer array field declaration.fieldObject
setValue(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named value.fieldObject
setValue(java.lang.String[] newValue)
Assign typed object String[] array value to field, similar tosetValue(String)
.fieldObject
setValue(MFBoolObject newValue)
Set typed value of a MFBool field declaration.fieldObject
setValue(MFColorObject newValue)
Set typed value of a MFColor field declaration.fieldObject
setValue(MFColorRGBAObject newValue)
Set typed value of a MFColorRGBA field declaration.fieldObject
setValue(MFDoubleObject newValue)
Set typed value of a MFDouble field declaration.fieldObject
setValue(MFFloatObject newValue)
Set typed value of a MFFloat field declaration.fieldObject
setValue(MFImageObject newValue)
Set typed value of a MFImage field declaration.fieldObject
setValue(MFInt32Object newValue)
Set typed value of a MFInt32 field declaration.fieldObject
setValue(MFMatrix3dObject newValue)
Set typed value of a MFMatrix3d field declaration.fieldObject
setValue(MFMatrix3fObject newValue)
Set typed value of a MFMatrix3f field declaration.fieldObject
setValue(MFMatrix4dObject newValue)
Set typed value of a MFMatrix4d field declaration.fieldObject
setValue(MFMatrix4fObject newValue)
Set typed value of a MFMatrix4f field declaration.fieldObject
setValue(MFRotationObject newValue)
Set typed value of a MFRotation field declaration.fieldObject
setValue(MFStringObject newValue)
Assign typed object MFString value to field, similar tosetValue(String)
.fieldObject
setValue(MFTimeObject newValue)
Set typed value of a MFTime field declaration.fieldObject
setValue(MFVec2dObject newValue)
Set typed value of a MFVec2d field declaration.fieldObject
setValue(MFVec2fObject newValue)
Set typed value of a MFVec2f field declaration.fieldObject
setValue(MFVec3dObject newValue)
Set typed value of a MFVec3d field declaration.fieldObject
setValue(MFVec3fObject newValue)
Set typed value of a MFVec3f field declaration.fieldObject
setValue(MFVec4dObject newValue)
Set typed value of a MFVec4d field declaration.fieldObject
setValue(MFVec4fObject newValue)
Set typed value of a MFVec4f field declaration.fieldObject
setValue(SFBoolObject newValue)
Set typed value of a SFBool field declaration.fieldObject
setValue(SFColorObject newValue)
Set typed value of a SFColor field declaration.fieldObject
setValue(SFColorRGBAObject newValue)
Set typed value of a SFColorRGBA field declaration.fieldObject
setValue(SFDoubleObject newValue)
Set typed value of a SFDouble field declaration.fieldObject
setValue(SFFloatObject newValue)
Set typed value of a SFFloat field declaration.fieldObject
setValue(SFImageObject newValue)
Set typed value of a SFImage field declaration.fieldObject
setValue(SFInt32Object newValue)
Set typed value of a SFInt32 field declaration.fieldObject
setValue(SFMatrix3dObject newValue)
Set typed value of a SFMatrix3d field declaration.fieldObject
setValue(SFMatrix3fObject newValue)
Set typed value of a SFMatrix3f field declaration.fieldObject
setValue(SFMatrix4dObject newValue)
Set typed value of a SFMatrix4d field declaration.fieldObject
setValue(SFMatrix4fObject newValue)
Set typed value of a SFMatrix4f field declaration.fieldObject
setValue(SFRotationObject newValue)
Set typed value of a SFRotation field declaration.fieldObject
setValue(SFStringObject newValue)
Assign typed object SFString value field, similar tosetValue(String)
.fieldObject
setValue(SFTimeObject newValue)
Set typed value of a SFTime field declaration.fieldObject
setValue(SFVec2dObject newValue)
Set typed value of a SFVec2d field declaration.fieldObject
setValue(SFVec2fObject newValue)
Set typed value of a SFVec2f field declaration.fieldObject
setValue(SFVec3dObject newValue)
Set typed value of a SFVec3d field declaration.fieldObject
setValue(SFVec3fObject newValue)
Set typed value of a SFVec3f field declaration.fieldObject
setValue(SFVec4dObject newValue)
Set typed value of a SFVec4d field declaration.fieldObject
setValue(SFVec4fObject newValue)
Set typed value of a SFVec4f field declaration.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.String
validate()
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
ACCESSTYPE_INITIALIZEONLY
public static final java.lang.String ACCESSTYPE_INITIALIZEONLYTooltip: 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). -
ACCESSTYPE_INPUTONLY
public static final java.lang.String ACCESSTYPE_INPUTONLYTooltip: 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). -
ACCESSTYPE_OUTPUTONLY
public static final java.lang.String ACCESSTYPE_OUTPUTONLYTooltip: 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). -
ACCESSTYPE_INPUTOUTPUT
public static final java.lang.String ACCESSTYPE_INPUTOUTPUTTooltip: 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). -
TYPE_SFBOOL
public static final java.lang.String TYPE_SFBOOLTooltip: 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). -
TYPE_MFBOOL
public static final java.lang.String TYPE_MFBOOLTooltip: 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). -
TYPE_SFCOLOR
public static final java.lang.String TYPE_SFCOLORTooltip: 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). -
TYPE_MFCOLOR
public static final java.lang.String TYPE_MFCOLORTooltip: 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). -
TYPE_SFCOLORRGBA
public static final java.lang.String TYPE_SFCOLORRGBATooltip: 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). -
TYPE_MFCOLORRGBA
public static final java.lang.String TYPE_MFCOLORRGBATooltip: 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). -
TYPE_SFDOUBLE
public static final java.lang.String TYPE_SFDOUBLETooltip: 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). -
TYPE_MFDOUBLE
public static final java.lang.String TYPE_MFDOUBLETooltip: 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). -
TYPE_SFFLOAT
public static final java.lang.String TYPE_SFFLOATTooltip: 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). -
TYPE_MFFLOAT
public static final java.lang.String TYPE_MFFLOATTooltip: 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). -
TYPE_SFIMAGE
public static final java.lang.String TYPE_SFIMAGETooltip: 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). -
TYPE_MFIMAGE
public static final java.lang.String TYPE_MFIMAGETooltip: 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). -
TYPE_SFINT32
public static final java.lang.String TYPE_SFINT32Tooltip: 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). -
TYPE_MFINT32
public static final java.lang.String TYPE_MFINT32Tooltip: 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). -
TYPE_SFNODE
public static final java.lang.String TYPE_SFNODETooltip: 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). -
TYPE_MFNODE
public static final java.lang.String TYPE_MFNODETooltip: 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). -
TYPE_SFROTATION
public static final java.lang.String TYPE_SFROTATIONTooltip: 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). -
TYPE_MFROTATION
public static final java.lang.String TYPE_MFROTATIONTooltip: 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). -
TYPE_SFSTRING
public static final java.lang.String TYPE_SFSTRINGTooltip: 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). -
TYPE_MFSTRING
public static final java.lang.String TYPE_MFSTRINGTooltip: 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). -
TYPE_SFTIME
public static final java.lang.String TYPE_SFTIMETooltip: 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). -
TYPE_MFTIME
public static final java.lang.String TYPE_MFTIMETooltip: 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). -
TYPE_SFVEC2D
public static final java.lang.String TYPE_SFVEC2DTooltip: 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). -
TYPE_MFVEC2D
public static final java.lang.String TYPE_MFVEC2DTooltip: 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). -
TYPE_SFVEC2F
public static final java.lang.String TYPE_SFVEC2FTooltip: 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). -
TYPE_MFVEC2F
public static final java.lang.String TYPE_MFVEC2FTooltip: 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). -
TYPE_SFVEC3D
public static final java.lang.String TYPE_SFVEC3DTooltip: 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). -
TYPE_MFVEC3D
public static final java.lang.String TYPE_MFVEC3DTooltip: 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). -
TYPE_SFVEC3F
public static final java.lang.String TYPE_SFVEC3FTooltip: 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). -
TYPE_MFVEC3F
public static final java.lang.String TYPE_MFVEC3FTooltip: 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). -
TYPE_SFVEC4D
public static final java.lang.String TYPE_SFVEC4DTooltip: 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). -
TYPE_MFVEC4D
public static final java.lang.String TYPE_MFVEC4DTooltip: 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). -
TYPE_SFVEC4F
public static final java.lang.String TYPE_SFVEC4FTooltip: 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). -
TYPE_MFVEC4F
public static final java.lang.String TYPE_MFVEC4FTooltip: 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). -
TYPE_SFMATRIX3D
public static final java.lang.String TYPE_SFMATRIX3DTooltip: 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). -
TYPE_MFMATRIX3D
public static final java.lang.String TYPE_MFMATRIX3DTooltip: 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). -
TYPE_SFMATRIX3F
public static final java.lang.String TYPE_SFMATRIX3FTooltip: 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). -
TYPE_MFMATRIX3F
public static final java.lang.String TYPE_MFMATRIX3FTooltip: 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). -
TYPE_SFMATRIX4D
public static final java.lang.String TYPE_SFMATRIX4DTooltip: 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). -
TYPE_MFMATRIX4D
public static final java.lang.String TYPE_MFMATRIX4DTooltip: 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). -
TYPE_SFMATRIX4F
public static final java.lang.String TYPE_SFMATRIX4FTooltip: 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). -
TYPE_MFMATRIX4F
public static final java.lang.String TYPE_MFMATRIX4FTooltip: 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). -
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: field.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the field element: Core- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Core component level for this element: 1- See Also:
- Constant Field Values
-
ACCESSTYPE_DEFAULT_VALUE
public static final java.lang.String ACCESSTYPE_DEFAULT_VALUEInitial value is required to be set for validity: SFString field named accessType has default value equal to an empty string.- See Also:
- Constant Field Values
-
APPINFO_DEFAULT_VALUE
public static final java.lang.String APPINFO_DEFAULT_VALUESFString field named appinfo has default value equal to an empty string.- See Also:
- Constant Field Values
-
DOCUMENTATION_DEFAULT_VALUE
public static final java.lang.String DOCUMENTATION_DEFAULT_VALUESFString field named documentation has default value equal to an empty string.- See Also:
- Constant Field Values
-
NAME_DEFAULT_VALUE
public static final java.lang.String NAME_DEFAULT_VALUESFString field named name has default value equal to an empty string.- See Also:
- Constant Field Values
-
TYPE_DEFAULT_VALUE
public static final java.lang.String TYPE_DEFAULT_VALUEInitial value is required to be set for validity: SFString field named type has default value equal to an empty string.- See Also:
- Constant Field Values
-
VALUE_DEFAULT_VALUE
public static final java.lang.String VALUE_DEFAULT_VALUESFString field named value has default value equal to an empty string.- See Also:
- Constant Field Values
-
-
Constructor Details
-
fieldObject
public fieldObject()Constructor for fieldObject to initialize member variables with default values. -
fieldObject
public fieldObject(java.lang.String fieldName, java.lang.String fieldType, java.lang.String fieldAccessType)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)
-
fieldObject
public fieldObject(java.lang.String fieldName, java.lang.String fieldType, java.lang.String fieldAccessType, java.lang.String defaultValue)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
public final java.lang.String getElementName()Provides name of this element: field- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String 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
public java.lang.String getFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D statement- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
-
getAccessType
public java.lang.String getAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D statement- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteStatement
-
getAccessType
public java.lang.String 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/documents/specifications/19775-1/V3.3/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/documents/specifications/19775-1/V3.3/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:
fieldObject
- 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getAppinfo
public java.lang.String 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:
fieldObject
- 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getChildren
Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNode.- Returns:
- value of children field
- See Also:
X3DNode
-
setChildren
Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNode.- Parameters:
newValue
- is new value for the children field.- Returns:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addChildren
Add single node to existing array of children nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNode and ProtoInstance.- Parameters:
newValue
- is new value to be appended the children field.
-
addChildren
Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for children field.
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.- Parameters:
newValue
- is new value to be appended the parts field.- Returns:
fieldObject
- 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addChildren
Add array of children nodes to array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNode.- Parameters:
newValue
- is new value array to be appended the children field.
-
setChildren
Set single children node, replacing prior array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DNode.- Parameters:
newValue
- is new node for the children field (restricted to X3DNode)
-
clearChildren
Utility method to clear MFNode value of children field.- Returns:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasChildren
public boolean hasChildren()Indicate whether an object is available for inputOutput MFNode field children.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
getChildren()
-
addComments
Add comment as CommentsBlock to children field- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
fieldObject
- 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:
fieldObject
- 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDocumentation
public java.lang.String 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:
fieldObject
- 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getName
public java.lang.String getName()Provide String value from inputOutput SFString field named name.
Tooltip: Name of 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:
fieldObject
- 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getType
public java.lang.String 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:
fieldObject
- 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getValue
public java.lang.String getValue()Provide String value from inputOutput SFString field named value.
Tooltip: 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.
- 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.
- 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFBoolObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFBoolObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFColorObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFColorObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFColorRGBAObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFColorRGBAObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFDoubleObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFDoubleObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFFloatObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFFloatObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFImageObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFImageObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFInt32Object 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFInt32Object 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFMatrix3dObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFMatrix3dObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFMatrix3fObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFMatrix3fObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFMatrix4dObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFMatrix4dObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFMatrix4fObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFMatrix4fObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFRotationObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFRotationObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFStringObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFStringObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFTimeObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFTimeObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec2dObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec2dObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec2fObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec2fObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec3dObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec3dObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec3fObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec3fObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec4dObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec4dObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append SFVec4fObject 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:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
appendValue
Append MFVec4fObject 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:
fieldObject
- 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:
fieldValueObject
- 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:
fieldValueObject
- 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:
fieldValueObject
- 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:
fieldValueObject
- 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:
fieldValueObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setValue
Assign typed object MFString value to field, similar tosetValue(String)
.- Parameters:
newValue
- is new value for the value field.- Returns:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setValue
Assign typed object String[] array value to field, similar tosetValue(String)
.- Parameters:
newValue
- is new value for the value field.- Returns:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setValue
Assign typed object SFString value field, similar tosetValue(String)
.- Parameters:
newValue
- is new value for the value field.- Returns:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
hasChildrenElements
public boolean hasChildrenElements()Indicate whether a node or statement is found in inputOutput MFNode field children.- Returns:
- whether a node or statement is found; ignores CommentsBlock.
- See Also:
getChildren()
-
toStringX3D
public java.lang.String toStringX3D(int indentLevel)Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
X3DObject.FILE_EXTENSION_X3D
,X3DObject.FILE_EXTENSION_XML
,X3DObject.toStringXML()
,X3DObject.toFileXML(String)
,X3DObject.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
X3DObject.FILE_EXTENSION_CLASSICVRML
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
-
toStringVRML97
public java.lang.String toStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
X3DObject.FILE_EXTENSION_VRML97
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
findElementByNameValue
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasElementByNameValue
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
findElementByNameValue(String, String)
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
findElementByNameValue(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasNodeByDEF
public boolean hasNodeByDEF(java.lang.String DEFvalue)Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
findNodeByDEF(String)
-
validate
public java.lang.String validate()Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-
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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-
clearValues
Clear all values in a field declaration.- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- 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 fieldObject declaration to ensure validity of the proper corresponding X3D type.- Parameters:
newValue
- is new value to assign- Returns:
fieldObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
-