Package org.web3d.x3d.jsail.NURBS
Class NurbsCurve
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.NURBS.NurbsCurve
- All Implemented Interfaces:
X3DNode
,NurbsCurve
,X3DParametricGeometryNode
,X3DGeometryNode
NurbsCurve is a 3D curve analogous to NurbsPatchSurface.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
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.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
NurbsCurve node tooltip: [X3DParametricGeometryNode] NurbsCurve is a 3D curve analogous to NurbsPatchSurface.
- Hint: the contained controlPoint field can hold a Coordinate or CoordinateDouble node.
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.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
SFBool field named closed has default value false (Java syntax) or false (XML syntax).static final String
String constant COMPONENT defines X3D component for the NurbsCurve element: NURBSstatic final String
containerField describes typical field relationship of a node to its parent.static final X3DNode
SFNode field named controlPoint has default value null (Java syntax) or NULL (XML syntax).static final String
fromField ROUTE name for SFNode field named controlPoint.static final String
fromField ROUTE name for SFNode field named IS.static final String
fromField ROUTE name for SFNode field named metadata.static final String
fromField ROUTE name for SFInt32 field named tessellation.static final String
fromField ROUTE name for MFDouble field named weight.static final IS
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).MFDouble field named knot has default value equal to an empty list.static final int
Integer constant LEVEL provides default X3D NURBS component level for this element: 1static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static final String
String constant NAME provides name of this element: NurbsCurve.static final int
SFInt32 field named order has default value 3 (Java syntax) or 3 (XML syntax).static final int
SFInt32 field named tessellation has default value 0 (Java syntax) or 0 (XML syntax).static final String
toField ROUTE name for SFNode field named controlPoint.static final String
toField ROUTE name for SFNode field named metadata.static final String
toField ROUTE name for SFInt32 field named tessellation.static final String
toField ROUTE name for MFDouble field named weight.MFDouble field named weight has default value equal to an empty list.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult
-
Constructor Summary
ConstructorDescriptionConstructor for NurbsCurve to initialize member variables with default values.NurbsCurve
(String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and TypeMethodDescriptionaddComments
(String newComment) Add comment as String to contained commentsList.addComments
(String[] newComments) Add comments as String[] array to contained commentsList.addComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.addKnot
(double newValue) Add singleton double value to MFDouble knot field.Add singleton SFDouble value to MFDouble knot field.addWeight
(double newValue) Add singleton double value to MFDouble weight field.Add singleton SFDouble value to MFDouble weight field.Utility method to clear SFNode value of controlPoint field.clearIS()
Utility method to clear SFNode value of IS field.Utility method to clear MFDouble value of knot field.Utility method to clear SFNode value of metadata field.Utility method to clear MFDouble value of weight field.findElementByNameValue
(String nameValue) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.findElementByNameValue
(String nameValue, String elementName) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.findNodeByDEF
(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.getAccessType
(String fieldName) Indicate accessType corresponding to given fieldName.boolean
Provide boolean value from initializeOnly SFBool field named closed.final String
Defines X3D component for the NurbsCurve element: NURBSfinal int
Provides default X3D component level for this element: 1final String
containerField describes typical field relationship of a node to its parent.Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to Coordinate|CoordinateDouble, from inputOutput SFNode field controlPoint.Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.getDEF()
Provide String value from inputOutput SFString field named DEF.final String
Provides name of this element: NurbsCurvegetFieldType
(String fieldName) Indicate type corresponding to given fieldName.Provide String value from inputOutput SFString field named id.getIS()
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.double[]
getKnot()
Provide array of Double results from initializeOnly MFDouble field named knot.Utility method to get ArrayList value of MFDouble knot field, similar togetKnot()
.Utility method to get String value of MFDouble knot field, similar togetKnot()
.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.int
getOrder()
Provide int value within allowed range of [2,infinity) from initializeOnly SFInt32 field named order.int
Provide int value from inputOutput SFInt32 field named tessellation.getUSE()
Provide String value from inputOutput SFString field named USE.double[]
Provide array of Double results within allowed range of (0,infinity) from inputOutput MFDouble field named weight.Utility method to get ArrayList value of MFDouble weight field, similar togetWeight()
.Utility method to get String value of MFDouble weight field, similar togetWeight()
.boolean
Indicate whether an object is available for inputOutput SFNode field controlPoint.boolean
hasElementByNameValue
(String nameValue, String elementName) Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
Indicate whether an object is available for inputOutput SFNode field metadata.boolean
hasNodeByDEF
(String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.final void
Initialize all member variables to default values.setClosed
(boolean newValue) Accessor method to assign boolean value to initializeOnly SFBool field named closed.Assign typed object value to SFBool closed field, similar tosetClosed(boolean)
.setControlPoint
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field controlPoint.setControlPoint
(X3DNode newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field controlPoint.final NurbsCurve
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final NurbsCurve
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.final NurbsCurve
Accessor method to assign String value to inputOutput SFString field named DEF.Assign typed object value to SFString DEF field, similar tosetDEF(String)
.final NurbsCurve
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.setKnot
(double[] newValue) Accessor method to assign Double array to initializeOnly MFDouble field named knot.setKnot
(int[] newValue) Assign floating-point array value of MFDouble knot field, similar tosetKnot(double[])
.Assign ArrayList value of MFDouble knot field, similar tosetKnot(double[])
.Assign typed object value to MFDouble knot field, similar tosetKnot(double[])
.setMetadata
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setOrder
(int newValue) Accessor method to assign int value to initializeOnly SFInt32 field named order.Assign typed object value to SFInt32 order field, similar tosetOrder(int)
.setTessellation
(int newValue) Accessor method to assign int value to inputOutput SFInt32 field named tessellation.setTessellation
(SFInt32 newValue) Assign typed object value to SFInt32 tessellation field, similar tosetTessellation(int)
.final NurbsCurve
Accessor method to assign String value to inputOutput SFString field named USE.Assign typed object value to SFString USE field, similar tosetUSE(String)
.setUSE
(NurbsCurve DEFnode) Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.setWeight
(double[] newValue) Accessor method to assign Double array to inputOutput MFDouble field named weight.setWeight
(int[] newValue) Assign floating-point array value of MFDouble weight field, similar tosetWeight(double[])
.Assign ArrayList value of MFDouble weight field, similar tosetWeight(double[])
.Assign typed object value to MFDouble weight field, similar tosetWeight(double[])
.toStringClassicVRML
(int indentLevel) Recursive method to provide ClassicVRML string serialization.toStringVRML97
(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX3D
(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.validate()
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
String constant NAME provides name of this element: NurbsCurve.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the NurbsCurve element: NURBS- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D NURBS component level for this element: 1- See Also:
-
CLOSED_DEFAULT_VALUE
public static final boolean CLOSED_DEFAULT_VALUESFBool field named closed has default value false (Java syntax) or false (XML syntax).- See Also:
-
CONTROLPOINT_DEFAULT_VALUE
SFNode field named controlPoint has default value null (Java syntax) or NULL (XML syntax). -
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
KNOT_DEFAULT_VALUE
-
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
ORDER_DEFAULT_VALUE
public static final int ORDER_DEFAULT_VALUESFInt32 field named order has default value 3 (Java syntax) or 3 (XML syntax).- See Also:
-
TESSELLATION_DEFAULT_VALUE
public static final int TESSELLATION_DEFAULT_VALUESFInt32 field named tessellation has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
-
WEIGHT_DEFAULT_VALUE
-
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "geometry";
containerField_ALLOWED_VALUES = {"geometry" }; type xs:NMTOKEN- See Also:
-
fromField_CONTROLPOINT
fromField ROUTE name for SFNode field named controlPoint.- See Also:
-
toField_CONTROLPOINT
toField ROUTE name for SFNode field named controlPoint.- See Also:
-
fromField_IS
-
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.- See Also:
-
toField_METADATA
toField ROUTE name for SFNode field named metadata.- See Also:
-
fromField_TESSELLATION
fromField ROUTE name for SFInt32 field named tessellation.- See Also:
-
toField_TESSELLATION
toField ROUTE name for SFInt32 field named tessellation.- See Also:
-
fromField_WEIGHT
fromField ROUTE name for MFDouble field named weight.- See Also:
-
toField_WEIGHT
toField ROUTE name for MFDouble field named weight.- See Also:
-
-
Constructor Details
-
NurbsCurve
public NurbsCurve()Constructor for NurbsCurve to initialize member variables with default values. -
NurbsCurve
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
Provides name of this element: NurbsCurve- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the NurbsCurve element: NURBS- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
-
getAccessType
Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
-
getContainerFieldDefault
containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getClosed
public boolean getClosed()Provide boolean value from initializeOnly SFBool field named closed.
Tooltip: Whether or not the curve is closed (i.e. matching end values). *- Specified by:
getClosed
in interfaceNurbsCurve
- Returns:
- value of closed field
-
setClosed
Accessor method to assign boolean value to initializeOnly SFBool field named closed.
Tooltip: Whether or not the curve is closed (i.e. matching end values). *- Specified by:
setClosed
in interfaceNurbsCurve
- Parameters:
newValue
- is new value for the closed field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setClosed
Assign typed object value to SFBool closed field, similar tosetClosed(boolean)
.- Parameters:
newValue
- is new value for the closed field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getControlPoint
Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to Coordinate|CoordinateDouble, from inputOutput SFNode field controlPoint.- Specified by:
getControlPoint
in interfaceNurbsCurve
- Returns:
- value of controlPoint field
- See Also:
-
setControlPoint
Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field controlPoint.- Specified by:
setControlPoint
in interfaceNurbsCurve
- Parameters:
newValue
- is new value for the controlPoint field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearControlPoint
Utility method to clear SFNode value of controlPoint field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setControlPoint
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field controlPoint.- Parameters:
newValue
- is new value for the controlPoint field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
hasControlPoint
public boolean hasControlPoint()Indicate whether an object is available for inputOutput SFNode field controlPoint.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
-
getIS
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
-
setIS
Accessor method to assign IS 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:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
NurbsCurve
- 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:
-
getKnot
public double[] getKnot()Provide array of Double results from initializeOnly MFDouble field named knot.
Tooltip: knot vector, where size = number of control points + order of curve. *- Specified by:
getKnot
in interfaceNurbsCurve
- Returns:
- value of knot field
-
getKnotList
-
getKnotString
-
setKnot
Accessor method to assign Double array to initializeOnly MFDouble field named knot.
Tooltip: knot vector, where size = number of control points + order of curve. *- Specified by:
setKnot
in interfaceNurbsCurve
- Parameters:
newValue
- is new value for the knot field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKnot
Assign typed object value to MFDouble knot field, similar tosetKnot(double[])
.- Parameters:
newValue
- is new value for the knot field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKnot
Assign ArrayList value of MFDouble knot field, similar tosetKnot(double[])
.- Parameters:
newValue
- is new value for the knot field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearKnot
Utility method to clear MFDouble value of knot field. This method does not initialize withKNOT_DEFAULT_VALUE.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setKnot
Assign floating-point array value of MFDouble knot field, similar tosetKnot(double[])
.- Parameters:
newValue
- is new value for the knot field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addKnot
Add singleton double value to MFDouble knot field.- Parameters:
newValue
- is new value to add to the knot field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addKnot
Add singleton SFDouble value to MFDouble knot field.- Parameters:
newValue
- is new value to add to the knot field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceNurbsCurve
- Specified by:
getMetadata
in interfaceX3DGeometryNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DParametricGeometryNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceNurbsCurve
- Specified by:
setMetadata
in interfaceX3DGeometryNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DParametricGeometryNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
NurbsCurve
- 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:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
getOrder
public int getOrder()Provide int value within allowed range of [2,infinity) from initializeOnly SFInt32 field named order.
Tooltip: define order of surface by polynomials of degree = order-1. *- Specified by:
getOrder
in interfaceNurbsCurve
- Returns:
- value of order field
-
setOrder
Accessor method to assign int value to initializeOnly SFInt32 field named order.
Tooltip: define order of surface by polynomials of degree = order-1. *- Specified by:
setOrder
in interfaceNurbsCurve
- Parameters:
newValue
- is new value for the order field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setOrder
Assign typed object value to SFInt32 order field, similar tosetOrder(int)
.- Parameters:
newValue
- is new value for the order field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTessellation
public int getTessellation()Provide int value from inputOutput SFInt32 field named tessellation.
Tooltip: hint for surface tessellation. *- Specified by:
getTessellation
in interfaceNurbsCurve
- Returns:
- value of tessellation field
-
setTessellation
Accessor method to assign int value to inputOutput SFInt32 field named tessellation.
Tooltip: hint for surface tessellation. *- Specified by:
setTessellation
in interfaceNurbsCurve
- Parameters:
newValue
- is new value for the tessellation field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTessellation
Assign typed object value to SFInt32 tessellation field, similar tosetTessellation(int)
.- Parameters:
newValue
- is new value for the tessellation field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getWeight
public double[] getWeight()Provide array of Double results within allowed range of (0,infinity) from inputOutput MFDouble field named weight.
Tooltip: Vector assigning relative weight value to each control point. *- Specified by:
getWeight
in interfaceNurbsCurve
- Returns:
- value of weight field
-
getWeightList
Utility method to get ArrayList value of MFDouble weight field, similar togetWeight()
.- Returns:
- value of weight field
-
getWeightString
Utility method to get String value of MFDouble weight field, similar togetWeight()
.- Returns:
- value of weight field
-
setWeight
Accessor method to assign Double array to inputOutput MFDouble field named weight.
Tooltip: Vector assigning relative weight value to each control point. *- Specified by:
setWeight
in interfaceNurbsCurve
- Parameters:
newValue
- is new value for the weight field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setWeight
Assign typed object value to MFDouble weight field, similar tosetWeight(double[])
.- Parameters:
newValue
- is new value for the weight field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setWeight
Assign ArrayList value of MFDouble weight field, similar tosetWeight(double[])
.- Parameters:
newValue
- is new value for the weight field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearWeight
Utility method to clear MFDouble value of weight field. This method does not initialize withWEIGHT_DEFAULT_VALUE.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setWeight
Assign floating-point array value of MFDouble weight field, similar tosetWeight(double[])
.- Parameters:
newValue
- is new value for the weight field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addWeight
Add singleton double value to MFDouble weight field.- Parameters:
newValue
- is new value to add to the weight field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addWeight
Add singleton SFDouble value to MFDouble weight field.- Parameters:
newValue
- is new value to add to the weight field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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:
-
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:
NurbsCurve
- 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:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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:
-
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:
NurbsCurve
- 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:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Specified by:
setHtmlID
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the id field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Specified by:
setCssStyle
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the style field.- Returns:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
NurbsCurve
- 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:
NurbsCurve
- 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:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
NurbsCurve
- 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:
NurbsCurve
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
-
toStringClassicVRML
Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
-
toStringVRML97
Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
-
hasElementByNameValue
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
-
hasNodeByDEF
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
-
validate
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-