public class Arc2DObject extends X3DConcreteNode implements Arc2D
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
COMPONENT
String constant COMPONENT defines X3D component for the Arc2D element: Geometry2D
|
static java.lang.String |
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.
|
static float |
ENDANGLE_DEFAULT_VALUE
SFFloat field named endAngle has default value 1.570796f (Java syntax) or 1.570796 (XML syntax).
|
static java.lang.String |
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.
|
static int |
LEVEL
Integer constant LEVEL provides default X3D Geometry2D component level for this element: 2
|
static java.lang.String |
NAME
String constant NAME provides name of this element: Arc2D.
|
static float |
RADIUS_DEFAULT_VALUE
SFFloat field named radius has default value 1f (Java syntax) or 1 (XML syntax).
|
static float |
STARTANGLE_DEFAULT_VALUE
SFFloat field named startAngle has default value 0f (Java syntax) or 0 (XML syntax).
|
static java.lang.String |
toField_METADATA
toField ROUTE name for SFNode field named metadata.
|
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUEvalidationResult| Constructor and Description |
|---|
Arc2DObject()
Constructor for Arc2DObject to initialize member variables with default values.
|
Arc2DObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values.
|
| Modifier and Type | Method and Description |
|---|---|
Arc2DObject |
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.
|
Arc2DObject |
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.
|
Arc2DObject |
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.
|
Arc2DObject |
clearMetadata()
Utility method to clear SFNode value of metadata field.
|
X3DConcreteElement |
findElementByNameValue(java.lang.String nameValue)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
|
X3DConcreteElement |
findElementByNameValue(java.lang.String nameValue,
java.lang.String elementName)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
|
X3DConcreteNode |
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
|
java.lang.String |
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.
|
java.lang.String |
getComponent()
Defines X3D component for the Arc2D element: Geometry2D
|
int |
getComponentLevel()
Provides default X3D component level for this element: 2
|
java.lang.String |
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.
|
java.lang.String |
getElementName()
Provides name of this element: Arc2D
|
float |
getEndAngle()
Provide float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) from initializeOnly SFFloat field named endAngle.
|
java.lang.String |
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.
|
ISObject |
getIS()
Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
|
X3DMetadataObject |
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
|
float |
getRadius()
Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named radius.
|
float |
getStartAngle()
Provide float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) from initializeOnly SFFloat field named startAngle.
|
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 |
hasMetadata()
Indicate whether an object is available for inputOutput SFNode field metadata.
|
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.
|
Arc2DObject |
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar to
setCssClass(String). |
Arc2DObject |
setCssClass(java.lang.String newValue)
Assign String value to inputOutput SFString field named class.
|
Arc2DObject |
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar to
setDEF(String). |
Arc2DObject |
setDEF(java.lang.String newValue)
Assign String value to inputOutput SFString field named DEF.
|
Arc2DObject |
setEndAngle(float newValue)
Assign float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) to initializeOnly SFFloat field named endAngle.
|
Arc2DObject |
setEndAngle(SFFloatObject newValue)
Assign typed object value to SFFloat endAngle field, similar to
setEndAngle(float). |
Arc2DObject |
setIS(ISObject newValue)
Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
|
Arc2DObject |
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
|
Arc2DObject |
setMetadata(X3DMetadataObject newValue)
Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
|
Arc2DObject |
setRadius(float newValue)
Assign float value within allowed range of (0,infinity) to initializeOnly SFFloat field named radius.
|
Arc2DObject |
setRadius(SFFloatObject newValue)
Assign typed object value to SFFloat radius field, similar to
setRadius(float). |
Arc2DObject |
setStartAngle(float newValue)
Assign float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) to initializeOnly SFFloat field named startAngle.
|
Arc2DObject |
setStartAngle(SFFloatObject newValue)
Assign typed object value to SFFloat startAngle field, similar to
setStartAngle(float). |
Arc2DObject |
setUSE(Arc2DObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar to
setUSE(String). |
Arc2DObject |
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar to
setUSE(String). |
Arc2DObject |
setUSE(java.lang.String newValue)
Assign String value to inputOutput SFString field named USE.
|
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.
|
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverrideclearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3Dpublic static final java.lang.String NAME
public static final java.lang.String COMPONENT
public static final int LEVEL
public static final float ENDANGLE_DEFAULT_VALUE
public static final float RADIUS_DEFAULT_VALUE
public static final float STARTANGLE_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUE
public static final java.lang.String fromField_METADATA
public static final java.lang.String toField_METADATA
public Arc2DObject()
public Arc2DObject(java.lang.String DEFlabel)
DEFlabel - unique DEF name for this X3D nodepublic final java.lang.String getElementName()
getElementName in class X3DConcreteElementpublic final java.lang.String getComponent()
getComponent in class X3DConcreteElementpublic final int getComponentLevel()
getComponentLevel in class X3DConcreteElementpublic java.lang.String getFieldType(java.lang.String fieldName)
getFieldType in class X3DConcreteElementfieldName - name of field in this X3D nodeConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPEpublic java.lang.String getAccessType(java.lang.String fieldName)
getAccessType in class X3DConcreteElementfieldName - name of field in this X3D nodeConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPEpublic final java.lang.String getContainerFieldDefault()
getContainerFieldDefault in class X3DConcreteNodepublic final void initialize()
initialize in class X3DConcreteNodepublic float getEndAngle()
getEndAngle in interface Arc2Dpublic Arc2DObject setEndAngle(float newValue)
setEndAngle in interface Arc2DnewValue - is new value for the endAngle field.Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public Arc2DObject setEndAngle(SFFloatObject newValue)
setEndAngle(float).newValue - is new value for the endAngle field.Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public X3DMetadataObject getMetadata()
getMetadata in interface X3DNodegetMetadata in interface Arc2DgetMetadata in interface X3DGeometryNodegetMetadataProtoInstance(),
X3D Scene Authoring Hints: Metadata Nodespublic Arc2DObject setMetadata(X3DMetadataObject newValue)
setMetadata in interface X3DNodesetMetadata in interface Arc2DsetMetadata in interface X3DGeometryNodesetMetadata in class X3DConcreteNodenewValue - is new value for the metadata field.Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).setMetadata(ProtoInstanceObject),
X3D Scene Authoring Hints: Metadata Nodespublic Arc2DObject clearMetadata()
Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public Arc2DObject setMetadata(ProtoInstanceObject newValue)
setMetadata in class X3DConcreteNodenewValue - is new value for the metadata field.Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).setMetadata(X3DMetadataObject)public boolean hasMetadata()
getMetadata(),
getMetadataProtoInstance(),
X3D Scene Authoring Hints: Metadata Nodespublic float getRadius()
public Arc2DObject setRadius(float newValue)
setRadius in interface Arc2DnewValue - is new value for the radius field.Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public Arc2DObject setRadius(SFFloatObject newValue)
setRadius(float).newValue - is new value for the radius field.Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public float getStartAngle()
getStartAngle in interface Arc2Dpublic Arc2DObject setStartAngle(float newValue)
setStartAngle in interface Arc2DnewValue - is new value for the startAngle field.Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public Arc2DObject setStartAngle(SFFloatObject newValue)
setStartAngle(float).newValue - is new value for the startAngle field.Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public final Arc2DObject setDEF(java.lang.String newValue)
setDEF in interface X3DNodesetDEF in interface Arc2DsetDEF in interface X3DGeometryNodesetDEF in class X3DConcreteNodenewValue - is new value for the DEF field.Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public Arc2DObject setDEF(SFStringObject newValue)
setDEF(String).newValue - is new value for the DEF field.Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public final Arc2DObject setUSE(java.lang.String newValue)
USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.setUSE in interface X3DNodesetUSE in interface Arc2DsetUSE in interface X3DGeometryNodesetUSE in class X3DConcreteNodenewValue - is new value for the USE field.Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public Arc2DObject setUSE(SFStringObject newValue)
setUSE(String).newValue - is new value for the USE field.Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public final Arc2DObject setCssClass(java.lang.String newValue)
setCssClass in interface X3DNodesetCssClass in interface Arc2DsetCssClass in interface X3DGeometryNodesetCssClass in class X3DConcreteNodenewValue - is new value for the class field.Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public Arc2DObject setCssClass(SFStringObject newValue)
setCssClass(String).newValue - is new value for the class field.Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public Arc2DObject setIS(ISObject newValue)
setIS in class X3DConcreteNodenewValue - is new value for the description field.Arc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ISObject getIS()
getIS in class X3DConcreteNodepublic Arc2DObject setUSE(Arc2DObject DEFnode)
setUSE(String).
setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
DEFnode - must have a DEF value definedArc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public Arc2DObject addComments(java.lang.String newComment)
addComments in class X3DConcreteElementnewComment - initial valueArc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public Arc2DObject addComments(java.lang.String[] newComments)
addComments in class X3DConcreteElementnewComments - array of commentsArc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public Arc2DObject addComments(CommentsBlock newCommentsBlock)
addComments in class X3DConcreteElementnewCommentsBlock - block of comments to addArc2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public java.lang.String toStringX3D(int indentLevel)
toStringX3D in class X3DConcreteElementindentLevel - number of levels of indentation for this elementX3DObject.FILE_EXTENSION_X3D,
X3DObject.FILE_EXTENSION_XML,
X3DObject.toStringXML(),
X3DObject.toFileXML(String),
X3DObject.toFileX3D(String),
X3D XML Encoding,
X3D Compressed Binary Encoding: X3D Canonical Formpublic java.lang.String toStringClassicVRML(int indentLevel)
toStringClassicVRML in class X3DConcreteElementindentLevel - number of levels of indentation for this elementX3DObject.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: Grammarpublic java.lang.String toStringVRML97(int indentLevel)
toStringVRML97 in class X3DConcreteElementindentLevel - number of levels of indentation for this elementX3DObject.FILE_EXTENSION_VRML97,
X3D Resources: Virtual Reality Modeling Language (VRML) 97,
Virtual Reality Modeling Language (VRML) 97 specification,
VRML 97 v2.1 Amendmentpublic X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
findElementByNameValue in class X3DConcreteElementnameValue - is value of the name field being searched for in this element and child elements(if any)findNodeByDEF(String),
X3DConcreteElement.hasAncestorSceneObject(),
X3DConcreteElement.findAncestorX3DObject()public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
findElementByNameValue in class X3DConcreteElementnameValue - 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.)findNodeByDEF(String),
X3DConcreteElement.hasAncestorSceneObject(),
X3DConcreteElement.findAncestorX3DObject()public boolean hasElementByNameValue(java.lang.String nameValue,
java.lang.String elementName)
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.)findElementByNameValue(String, String)public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
findNodeByDEF in class X3DConcreteElementDEFvalue - is value of the name field being searched for in this element and child elements(if any)findElementByNameValue(String),
X3DConcreteElement.hasAncestorSceneObject(),
X3DConcreteElement.findAncestorX3DObject()public boolean hasNodeByDEF(java.lang.String DEFvalue)
DEFvalue - is value of the name field being searched for in this element and child elements(if any)findNodeByDEF(String)public java.lang.String validate()
validate in class X3DConcreteElementCopyright ©2005-2017 Web3D Consortium under an open-source license, free for any use. Feedback is welcome.