Package org.web3d.x3d.jsail.Geometry2D
Class Arc2DObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Geometry2D.Arc2DObject
- All Implemented Interfaces:
X3DNode
,Arc2D
,X3DGeometryNode
public class Arc2DObject extends X3DConcreteNode implements Arc2D
Arc2D is a line-based geometry node that defines a linear circular arc with center (0,0) in X-Y plane, with angles measured starting at positive x-axis and sweeping towards positive y-axis.
X3D node tooltip: [X3DGeometryNode] Arc2D is a line-based geometry node that defines a linear circular arc with center (0,0) in X-Y plane, with angles measured starting at positive x-axis and sweeping towards positive y-axis.
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
X3D node tooltip: [X3DGeometryNode] Arc2D is a line-based geometry node that defines a linear circular arc with center (0,0) in X-Y plane, with angles measured starting at positive x-axis and sweeping towards positive y-axis.
- Hint: Material emissiveColor in corresponding Appearance is used for rendering lines.
- Warning: lines are not lit, are not texture-mapped, and do not participate in collision detection.
- Warning: use a different Material emissiveColor than the Background color, otherwise geometry is invisible.
- Hint: adding LineProperties to the corresponding Appearance node can modify the rendering style of these lines.
- Hint: insert a Shape node before adding geometry or Appearance.
- Warning: requires X3D profile='Full' or else include <component name='Geometry2D' level='2'/> Examples: X3D Example Archives, X3D for Web Authors, Chapter 10 Geometry 2D https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter10Geometry2D
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the Arc2D element: Geometry2Dstatic 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_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D Geometry2D component level for this element: 2static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).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.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor 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. -
Method Summary
Modifier and Type Method Description 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
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.Arc2DObject
clearIS()
Utility method to clear SFNode value of IS field.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: Geometry2Dint
getComponentLevel()
Provides default X3D component level for this element: 2java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getElementName()
Provides name of this element: Arc2Dfloat
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 ISObject instance (using a properly typed node) from inputOutput SFNode field IS.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.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.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
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.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(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.Arc2DObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.Arc2DObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.Arc2DObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.Arc2DObject
setEndAngle(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetEndAngle(float)
.Arc2DObject
setEndAngle(float newValue)
Accessor method to assign float value unit axis, angle (in radians) to initializeOnly SFFloat field named endAngle.Arc2DObject
setEndAngle(SFFloatObject newValue)
Assign typed object value to SFFloat endAngle field, similar tosetEndAngle(float)
.Arc2DObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.Arc2DObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.Arc2DObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.Arc2DObject
setRadius(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetRadius(float)
.Arc2DObject
setRadius(float newValue)
Accessor method to assign float value to initializeOnly SFFloat field named radius.Arc2DObject
setRadius(SFFloatObject newValue)
Assign typed object value to SFFloat radius field, similar tosetRadius(float)
.Arc2DObject
setStartAngle(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStartAngle(float)
.Arc2DObject
setStartAngle(float newValue)
Accessor method to assign float value unit axis, angle (in radians) to initializeOnly SFFloat field named startAngle.Arc2DObject
setStartAngle(SFFloatObject newValue)
Assign typed object value to SFFloat startAngle field, similar tosetStartAngle(float)
.Arc2DObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.Arc2DObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.Arc2DObject
setUSE(Arc2DObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.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.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: Arc2D.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the Arc2D element: Geometry2D- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Geometry2D component level for this element: 2- See Also:
- Constant Field Values
-
ENDANGLE_DEFAULT_VALUE
public static final float ENDANGLE_DEFAULT_VALUESFFloat field named endAngle has default value 1.570796f (Java syntax) or 1.570796 (XML syntax).- See Also:
- Constant Field Values
-
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
RADIUS_DEFAULT_VALUE
public static final float RADIUS_DEFAULT_VALUESFFloat field named radius has default value 1f (Java syntax) or 1 (XML syntax).- See Also:
- Constant Field Values
-
STARTANGLE_DEFAULT_VALUE
public static final float STARTANGLE_DEFAULT_VALUESFFloat field named startAngle has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes. -
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
-
Constructor Details
-
Arc2DObject
public Arc2DObject()Constructor for Arc2DObject to initialize member variables with default values. -
Arc2DObject
public Arc2DObject(java.lang.String DEFlabel)Utility constructor that assigns DEF label after initializing member variables with default values.- Parameters:
DEFlabel
- unique DEF name for this X3D node
-
-
Method Details
-
getElementName
public final java.lang.String getElementName()Provides name of this element: Arc2D- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the Arc2D element: Geometry2D- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 2- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
public java.lang.String getFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- 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 node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
-
getContainerFieldDefault
public final java.lang.String getContainerFieldDefault()containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
- X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getEndAngle
public float getEndAngle()Provide float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) from initializeOnly SFFloat field named endAngle.
Tooltip: [0,2pi] Arc extends from startAngle counterclockwise to endAngle, in radians.- Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, avoiding the need for potentially expensive tessellation at run time.
- Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
- Hint: https://en.wikipedia.org/wiki/Radian
- Specified by:
getEndAngle
in interfaceArc2D
- Returns:
- value of endAngle field
-
setEndAngle
Accessor method to assign float value unit axis, angle (in radians) to initializeOnly SFFloat field named endAngle.
Tooltip: [0,2pi] Arc extends from startAngle counterclockwise to endAngle, in radians.- Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, avoiding the need for potentially expensive tessellation at run time.
- Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
- Hint: https://en.wikipedia.org/wiki/Radian
- Specified by:
setEndAngle
in interfaceArc2D
- Parameters:
newValue
- is new value for the endAngle field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setEndAngle
Assign typed object value to SFFloat endAngle field, similar tosetEndAngle(float)
.- Parameters:
newValue
- is new value for the endAngle field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setEndAngle
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetEndAngle(float)
.- Parameters:
newValue
- is new value for field- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasIS
public boolean hasIS()Indicate whether an object is available for inputOutput SFNode field IS.- Returns:
- whether a concrete statement or CommentsBlock is available.
- See Also:
getIS()
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceArc2D
- Specified by:
getMetadata
in interfaceX3DGeometryNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceArc2D
- Specified by:
setMetadata
in interfaceX3DGeometryNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMetadata(X3DMetadataObject)
-
hasMetadata
public boolean hasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getMetadata()
,getMetadataProtoInstance()
, X3D Scene Authoring Hints: Metadata Nodes
-
getRadius
public float getRadius()Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named radius.
Tooltip: (0,+infinity) circle radius, of which the arc is a portion.- Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, avoiding the need for potentially expensive tessellation at run time.
- Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
-
setRadius
Accessor method to assign float value to initializeOnly SFFloat field named radius.
Tooltip: (0,+infinity) circle radius, of which the arc is a portion.- Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, avoiding the need for potentially expensive tessellation at run time.
- Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
- Specified by:
setRadius
in interfaceArc2D
- Parameters:
newValue
- is new value for the radius field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRadius
Assign typed object value to SFFloat radius field, similar tosetRadius(float)
.- Parameters:
newValue
- is new value for the radius field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRadius
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetRadius(float)
.- Parameters:
newValue
- is new value for field- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getStartAngle
public float getStartAngle()Provide float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) from initializeOnly SFFloat field named startAngle.
Tooltip: [0,2pi] Arc extends from startAngle counterclockwise to endAngle, in radians.- Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, avoiding the need for potentially expensive tessellation at run time.
- Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
- Hint: https://en.wikipedia.org/wiki/Radian
- Specified by:
getStartAngle
in interfaceArc2D
- Returns:
- value of startAngle field
-
setStartAngle
Accessor method to assign float value unit axis, angle (in radians) to initializeOnly SFFloat field named startAngle.
Tooltip: [0,2pi] Arc extends from startAngle counterclockwise to endAngle, in radians.- Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, avoiding the need for potentially expensive tessellation at run time.
- Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
- Hint: https://en.wikipedia.org/wiki/Radian
- Specified by:
setStartAngle
in interfaceArc2D
- Parameters:
newValue
- is new value for the startAngle field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setStartAngle
Assign typed object value to SFFloat startAngle field, similar tosetStartAngle(float)
.- Parameters:
newValue
- is new value for the startAngle field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setStartAngle
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStartAngle(float)
.- Parameters:
newValue
- is new value for field- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDEF
public java.lang.String getDEF()Provide String value from inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- 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
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
Accessor method to assign String value to inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- 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
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.String getUSE()Provide String value from inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
- Overrides:
getUSE
in classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
Accessor method to assign String value to inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
Note: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Specified by:
setUSE
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Parameters:
DEFnode
- must have a DEF value defined- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
Arc2DObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
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)
-