Package org.web3d.x3d.jsail.NURBS
Class NurbsPositionInterpolatorObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.NURBS.NurbsPositionInterpolatorObject
- All Implemented Interfaces:
X3DChildNode
,X3DNode
,NurbsPositionInterpolator
public class NurbsPositionInterpolatorObject extends X3DConcreteNode implements NurbsPositionInterpolator
NurbsPositionInterpolator describes a 3D NURBS curve and outputs interpolated position values.
X3D node tooltip: [X3DChildNode] NurbsPositionInterpolator describes a 3D NURBS curve and outputs interpolated position values.
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: [X3DChildNode] NurbsPositionInterpolator describes a 3D NURBS curve and outputs interpolated position values.
- Hint: the SFNode controlPoint field can contain a single 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.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the NurbsPositionInterpolator element: NURBSstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static X3DCoordinateNode
CONTROLPOINT_DEFAULT_VALUE
SFNode field named controlPoint has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
fromField_CONTROLPOINT
fromField ROUTE name for SFNode field named controlPoint.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 java.lang.String
fromField_ORDER
fromField ROUTE name for SFInt32 field named order.static java.lang.String
fromField_VALUE_CHANGED
fromField ROUTE name for SFVec3f field named value_changed.static java.lang.String
fromField_WEIGHT
fromField ROUTE name for MFDouble field named weight.static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static java.util.ArrayList<java.lang.Double>
KNOT_DEFAULT_VALUE
MFDouble field named knot has default value equal to an empty list.static int
LEVEL
Integer constant LEVEL provides default X3D NURBS component level for this element: 1static 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: NurbsPositionInterpolator.static int
ORDER_DEFAULT_VALUE
SFInt32 field named order has default value 3 (Java syntax) or 3 (XML syntax).static java.lang.String
toField_CONTROLPOINT
toField ROUTE name for SFNode field named controlPoint.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_ORDER
toField ROUTE name for SFInt32 field named order.static java.lang.String
toField_SET_FRACTION
toField ROUTE name for SFFloat field named set_fraction.static java.lang.String
toField_WEIGHT
toField ROUTE name for MFDouble field named weight.static java.util.ArrayList<java.lang.Double>
WEIGHT_DEFAULT_VALUE
MFDouble field named weight has default value equal to an empty list.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 NurbsPositionInterpolatorObject()
Constructor for NurbsPositionInterpolatorObject to initialize member variables with default values.NurbsPositionInterpolatorObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description NurbsPositionInterpolatorObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.NurbsPositionInterpolatorObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.NurbsPositionInterpolatorObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.NurbsPositionInterpolatorObject
addKnot(double newValue)
Add singleton double value to MFDouble knot field.NurbsPositionInterpolatorObject
addKnot(SFDoubleObject newValue)
Add singleton SFDoubleObject value to MFDouble knot field.NurbsPositionInterpolatorObject
addWeight(double newValue)
Add singleton double value to MFDouble weight field.NurbsPositionInterpolatorObject
addWeight(SFDoubleObject newValue)
Add singleton SFDoubleObject value to MFDouble weight field.NurbsPositionInterpolatorObject
clearControlPoint()
Utility method to clear SFNode value of controlPoint field.NurbsPositionInterpolatorObject
clearIS()
Utility method to clear SFNode value of IS field.NurbsPositionInterpolatorObject
clearKnot()
Utility method to clear MFDouble value of knot field.NurbsPositionInterpolatorObject
clearMetadata()
Utility method to clear SFNode value of metadata field.NurbsPositionInterpolatorObject
clearWeight()
Utility method to clear MFDouble value of weight 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 NurbsPositionInterpolator element: NURBSint
getComponentLevel()
Provides default X3D component level for this element: 1java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.X3DCoordinateNode
getControlPoint()
Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field controlPoint.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: NurbsPositionInterpolatorjava.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.double[]
getKnot()
Provide array of Double results from initializeOnly MFDouble field named knot.java.util.ArrayList<java.lang.Double>
getKnotList()
Utility method to get ArrayList value of MFDouble knot field, similar togetKnot()
.java.lang.String
getKnotString()
Utility method to get String value of MFDouble knot field, similar togetKnot()
.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.int
getOrder()
Provide int value within allowed range of [2,infinity) from inputOutput SFInt32 field named order.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.float[]
getValue()
Provide array of 3-tuple float results from outputOnly SFVec3f field named value_changed.double[]
getWeight()
Provide array of Double results from inputOutput MFDouble field named weight.java.util.ArrayList<java.lang.Double>
getWeightList()
Utility method to get ArrayList value of MFDouble weight field, similar togetWeight()
.java.lang.String
getWeightString()
Utility method to get String value of MFDouble weight field, similar togetWeight()
.boolean
hasControlPoint()
Indicate whether an object is available for inputOutput SFNode field controlPoint.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.NurbsPositionInterpolatorObject
setControlPoint(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field controlPoint.NurbsPositionInterpolatorObject
setControlPoint(X3DCoordinateNode newValue)
Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field controlPoint.NurbsPositionInterpolatorObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.NurbsPositionInterpolatorObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.NurbsPositionInterpolatorObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.NurbsPositionInterpolatorObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.NurbsPositionInterpolatorObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.NurbsPositionInterpolatorObject
setKnot(double[] newValue)
Accessor method to assign Double array to initializeOnly MFDouble field named knot.NurbsPositionInterpolatorObject
setKnot(int[] newValue)
Assign floating-point array value of MFDouble knot field, similar tosetKnot(double[])
.NurbsPositionInterpolatorObject
setKnot(java.util.ArrayList<java.lang.Double> newValue)
Assign ArrayList value of MFDouble knot field, similar tosetKnot(double[])
.NurbsPositionInterpolatorObject
setKnot(MFDoubleObject newValue)
Assign typed object value to MFDouble knot field, similar tosetKnot(double[])
.NurbsPositionInterpolatorObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.NurbsPositionInterpolatorObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.NurbsPositionInterpolatorObject
setOrder(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named order.NurbsPositionInterpolatorObject
setOrder(SFInt32Object newValue)
Assign typed object value to SFInt32 order field, similar tosetOrder(int)
.NurbsPositionInterpolatorObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.NurbsPositionInterpolatorObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.NurbsPositionInterpolatorObject
setUSE(NurbsPositionInterpolatorObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.NurbsPositionInterpolatorObject
setWeight(double[] newValue)
Accessor method to assign Double array to inputOutput MFDouble field named weight.NurbsPositionInterpolatorObject
setWeight(int[] newValue)
Assign floating-point array value of MFDouble weight field, similar tosetWeight(double[])
.NurbsPositionInterpolatorObject
setWeight(java.util.ArrayList<java.lang.Double> newValue)
Assign ArrayList value of MFDouble weight field, similar tosetWeight(double[])
.NurbsPositionInterpolatorObject
setWeight(MFDoubleObject newValue)
Assign typed object value to MFDouble weight field, similar tosetWeight(double[])
.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: NurbsPositionInterpolator.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the NurbsPositionInterpolator element: NURBS- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D NURBS component level for this element: 1- See Also:
- Constant Field Values
-
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
public static final java.util.ArrayList<java.lang.Double> KNOT_DEFAULT_VALUEMFDouble field named knot has default value equal to an empty list. -
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:
- Constant Field Values
-
WEIGHT_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.Double> WEIGHT_DEFAULT_VALUEMFDouble field named weight has default value equal to an empty list. -
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_CONTROLPOINT
public static final java.lang.String fromField_CONTROLPOINTfromField ROUTE name for SFNode field named controlPoint.- See Also:
- Constant Field Values
-
toField_CONTROLPOINT
public static final java.lang.String toField_CONTROLPOINTtoField ROUTE name for SFNode field named controlPoint.- See Also:
- Constant Field Values
-
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
-
fromField_ORDER
public static final java.lang.String fromField_ORDERfromField ROUTE name for SFInt32 field named order.- See Also:
- Constant Field Values
-
toField_ORDER
public static final java.lang.String toField_ORDERtoField ROUTE name for SFInt32 field named order.- See Also:
- Constant Field Values
-
toField_SET_FRACTION
public static final java.lang.String toField_SET_FRACTIONtoField ROUTE name for SFFloat field named set_fraction.- See Also:
- Constant Field Values
-
fromField_VALUE_CHANGED
public static final java.lang.String fromField_VALUE_CHANGEDfromField ROUTE name for SFVec3f field named value_changed.- See Also:
- Constant Field Values
-
fromField_WEIGHT
public static final java.lang.String fromField_WEIGHTfromField ROUTE name for MFDouble field named weight.- See Also:
- Constant Field Values
-
toField_WEIGHT
public static final java.lang.String toField_WEIGHTtoField ROUTE name for MFDouble field named weight.- See Also:
- Constant Field Values
-
-
Constructor Details
-
NurbsPositionInterpolatorObject
public NurbsPositionInterpolatorObject()Constructor for NurbsPositionInterpolatorObject to initialize member variables with default values. -
NurbsPositionInterpolatorObject
public NurbsPositionInterpolatorObject(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: NurbsPositionInterpolator- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the NurbsPositionInterpolator 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
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
-
getControlPoint
Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field controlPoint.- Specified by:
getControlPoint
in interfaceNurbsPositionInterpolator
- Returns:
- value of controlPoint field
- See Also:
Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies control points for NURBS geometry definitions. *
-
setControlPoint
Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field controlPoint.- Specified by:
setControlPoint
in interfaceNurbsPositionInterpolator
- Parameters:
newValue
- is new value for the controlPoint field.- Returns:
NurbsPositionInterpolatorObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies control points for NURBS geometry definitions. *
-
clearControlPoint
Utility method to clear SFNode value of controlPoint field.- Returns:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setControlPoint(X3DCoordinateNode)
-
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:
getControlPoint()
,getControlPointProtoInstance()
-
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:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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()
-
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 interfaceNurbsPositionInterpolator
- Returns:
- value of knot field
-
getKnotList
public java.util.ArrayList<java.lang.Double> getKnotList()Utility method to get ArrayList value of MFDouble knot field, similar togetKnot()
.- Returns:
- value of knot field
-
getKnotString
public java.lang.String getKnotString()Utility method to get String value of MFDouble knot field, similar togetKnot()
.- Returns:
- value of knot field
-
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 interfaceNurbsPositionInterpolator
- Parameters:
newValue
- is new value for the knot field.- Returns:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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.- Returns:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addKnot
Add singleton SFDoubleObject value to MFDouble knot field.- Parameters:
newValue
- is new value to add to the knot field.- Returns:
NurbsPositionInterpolatorObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceNurbsPositionInterpolator
- Specified by:
getMetadata
in interfaceX3DChildNode
- 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 interfaceNurbsPositionInterpolator
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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
-
getOrder
public int getOrder()Provide int value within allowed range of [2,infinity) from inputOutput SFInt32 field named order.
Tooltip: define order of surface by polynomials of degree = order-1. *- Specified by:
getOrder
in interfaceNurbsPositionInterpolator
- Returns:
- value of order field
-
setOrder
Accessor method to assign int value to inputOutput SFInt32 field named order.
Tooltip: define order of surface by polynomials of degree = order-1. *- Specified by:
setOrder
in interfaceNurbsPositionInterpolator
- Parameters:
newValue
- is new value for the order field.- Returns:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getValue
public float[] getValue()Provide array of 3-tuple float results from outputOnly SFVec3f field named value_changed.
Tooltip: Computationaly interpolated output value determined by current key time and corresponding keyValue pair.- Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
- Specified by:
getValue
in interfaceNurbsPositionInterpolator
- Returns:
- value of value_changed field
-
getWeight
public double[] getWeight()Provide array of Double results from inputOutput MFDouble field named weight.
Tooltip: Output values for linear interpolation, each corresponding to knots.- Hint: number of weights must match number of knots!.
- Specified by:
getWeight
in interfaceNurbsPositionInterpolator
- Returns:
- value of weight field
-
getWeightList
public java.util.ArrayList<java.lang.Double> getWeightList()Utility method to get ArrayList value of MFDouble weight field, similar togetWeight()
.- Returns:
- value of weight field
-
getWeightString
public java.lang.String 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: Output values for linear interpolation, each corresponding to knots.- Hint: number of weights must match number of knots!.
- Specified by:
setWeight
in interfaceNurbsPositionInterpolator
- Parameters:
newValue
- is new value for the weight field.- Returns:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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.- Returns:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addWeight
Add singleton SFDoubleObject value to MFDouble weight field.- Parameters:
newValue
- is new value to add to the weight field.- Returns:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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:
NurbsPositionInterpolatorObject
- 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)
-