Package org.web3d.x3d.jsail.NURBS

Class NurbsSweptSurface

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.NURBS.NurbsSweptSurface

All Implemented Interfaces:

X3DNode, NurbsSweptSurface, X3DParametricGeometryNode, X3DGeometryNode

public class NurbsSweptSurface
extends X3DConcreteNode
implements NurbsSweptSurface

NurbsSweptSurface uses a trajectoryCurve path to describe a generalized surface that is swept by a crossSectionCurve.

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. X3D node tooltip: [X3DParametricGeometryNode] NurbsSweptSurface uses a trajectoryCurve path to describe a generalized surface that is swept by a crossSectionCurve. Hint: conceptually it is the NURBS equivalent of Extrusion but permits the use of non-closed cross sections. *


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:

• X3D Abstract Specification: NurbsSweptSurface
• X3D Tooltips: NurbsSweptSurface
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	CCW_DEFAULT_VALUE	SFBool field named ccw has default value true (Java syntax) or true (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the NurbsSweptSurface element: NURBS
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final X3DNurbsControlCurveNode	CROSSSECTIONCURVE_DEFAULT_VALUE	SFNode field named crossSectionCurve has default value null (Java syntax) or NULL (XML syntax).
static final String	fromField_CROSSSECTIONCURVE	fromField ROUTE name for SFNode field named crossSectionCurve.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_TRAJECTORYCURVE	fromField ROUTE name for SFNode field named trajectoryCurve.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D NURBS component level for this element: 3
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: NurbsSweptSurface.
static final boolean	SOLID_DEFAULT_VALUE	SFBool field named solid has default value true (Java syntax) or true (XML syntax).
static final String	toField_CROSSSECTIONCURVE	toField ROUTE name for SFNode field named crossSectionCurve.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_TRAJECTORYCURVE	toField ROUTE name for SFNode field named trajectoryCurve.
static final NurbsCurve	TRAJECTORYCURVE_DEFAULT_VALUE	SFNode field named trajectoryCurve has default value null (Java syntax) or NULL (XML syntax).

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

containerField_ALTERNATE_VALUES, 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

Constructors

Constructor	Description
NurbsSweptSurface()	Constructor for NurbsSweptSurface to initialize member variables with default values.
NurbsSweptSurface(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
NurbsSweptSurface	addComments(String newComment)	Add comment as String to contained commentsList.
NurbsSweptSurface	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
NurbsSweptSurface	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
NurbsSweptSurface	clearCrossSectionCurve()	Utility method to clear SFNode value of crossSectionCurve field.
NurbsSweptSurface	clearIS()	Utility method to clear SFNode value of IS field.
NurbsSweptSurface	clearMetadata()	Utility method to clear SFNode value of metadata field.
NurbsSweptSurface	clearTrajectoryCurve()	Utility method to clear SFNode value of trajectoryCurve field.
X3DConcreteElement	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.
X3DConcreteElement	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.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
boolean	getCcw()	Provide boolean value from initializeOnly SFBool field named ccw.
final String	getComponent()	Defines X3D component for the NurbsSweptSurface element: NURBS
final int	getComponentLevel()	Provides default X3D component level for this element: 3
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
X3DNurbsControlCurveNode	getCrossSectionCurve()	Provide org.web3d.x3d.sai.NURBS.X3DNurbsControlCurveNode instance (using a properly typed node) from inputOutput SFNode field crossSectionCurve.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
final String	getElementName()	Provides name of this element: NurbsSweptSurface
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
boolean	getSolid()	Provide boolean value from initializeOnly SFBool field named solid.
NurbsCurve	getTrajectoryCurve()	Provide org.web3d.x3d.sai.NURBS.NurbsCurve instance (using a properly typed node) from inputOutput SFNode field trajectoryCurve.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasCrossSectionCurve()	Indicate whether an object is available for inputOutput SFNode field crossSectionCurve.
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	hasMetadata()	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.
boolean	hasTrajectoryCurve()	Indicate whether an object is available for inputOutput SFNode field trajectoryCurve.
final void	initialize()	Initialize all member variables to default values.
NurbsSweptSurface	setCcw(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named ccw.
NurbsSweptSurface	setCcw(SFBool newValue)	Assign typed object value to SFBool ccw field, similar to setCcw(boolean). // #0.e
NurbsSweptSurface	setCrossSectionCurve(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field crossSectionCurve.
NurbsSweptSurface	setCrossSectionCurve(X3DNurbsControlCurveNode newValue)	Accessor method to assign org.web3d.x3d.sai.NURBS.X3DNurbsControlCurveNode instance (using a properly typed node) to inputOutput SFNode field crossSectionCurve.
final NurbsSweptSurface	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
NurbsSweptSurface	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String). // #0.e
final NurbsSweptSurface	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
NurbsSweptSurface	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String). // #0.e
final NurbsSweptSurface	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
NurbsSweptSurface	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String). // #0.e
final NurbsSweptSurface	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
NurbsSweptSurface	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String). // #0.e
NurbsSweptSurface	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
NurbsSweptSurface	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
NurbsSweptSurface	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
NurbsSweptSurface	setSolid(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named solid.
NurbsSweptSurface	setSolid(SFBool newValue)	Assign typed object value to SFBool solid field, similar to setSolid(boolean). // #0.e
NurbsSweptSurface	setTrajectoryCurve(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field trajectoryCurve.
NurbsSweptSurface	setTrajectoryCurve(NurbsCurve newValue)	Accessor method to assign org.web3d.x3d.sai.NURBS.NurbsCurve instance (using a properly typed node) to inputOutput SFNode field trajectoryCurve.
final NurbsSweptSurface	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
NurbsSweptSurface	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String). // #0.e
NurbsSweptSurface	setUSE(NurbsSweptSurface DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
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, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

String constant NAME provides name of this element: NurbsSweptSurface.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the NurbsSweptSurface element: NURBS

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D NURBS component level for this element: 3

See Also:

• Constant Field Values

CCW_DEFAULT_VALUE

public static final boolean CCW_DEFAULT_VALUE

SFBool field named ccw has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

CROSSSECTIONCURVE_DEFAULT_VALUE

public static final X3DNurbsControlCurveNode CROSSSECTIONCURVE_DEFAULT_VALUE

SFNode field named crossSectionCurve has default value null (Java syntax) or NULL (XML syntax).

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

SOLID_DEFAULT_VALUE

public static final boolean SOLID_DEFAULT_VALUE

SFBool field named solid has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

TRAJECTORYCURVE_DEFAULT_VALUE

public static final NurbsCurve TRAJECTORYCURVE_DEFAULT_VALUE

SFNode field named trajectoryCurve has default value null (Java syntax) or NULL (XML syntax).

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

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.

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_CROSSSECTIONCURVE

public static final String fromField_CROSSSECTIONCURVE

fromField ROUTE name for SFNode field named crossSectionCurve.

See Also:

• Constant Field Values

toField_CROSSSECTIONCURVE

public static final String toField_CROSSSECTIONCURVE

toField ROUTE name for SFNode field named crossSectionCurve.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_TRAJECTORYCURVE

public static final String fromField_TRAJECTORYCURVE

fromField ROUTE name for SFNode field named trajectoryCurve.

See Also:

• Constant Field Values

toField_TRAJECTORYCURVE

public static final String toField_TRAJECTORYCURVE

toField ROUTE name for SFNode field named trajectoryCurve.

See Also:

• Constant Field Values

Constructor Details

NurbsSweptSurface

public NurbsSweptSurface()

Constructor for NurbsSweptSurface to initialize member variables with default values.

NurbsSweptSurface

public NurbsSweptSurface(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 String getElementName()

Provides name of this element: NurbsSweptSurface

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the NurbsSweptSurface element: NURBS

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 3

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public String getFieldType(String fieldName)

Indicate type corresponding to given fieldName.

Specified by:

getFieldType in class X3DConcreteElement

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 String getAccessType(String fieldName)

Indicate accessType corresponding to given fieldName.

Specified by:

getAccessType in class X3DConcreteElement

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 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 class X3DConcreteNode

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 class X3DConcreteNode

getCcw

public boolean getCcw()

Provide boolean value from initializeOnly SFBool field named ccw.

Tooltip: ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in turn defines front/back orientation of polygon normals according to Right-Hand Rule (RHR). Hint: a good debugging technique for problematic polygons is to try changing the value of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector direction. Warning: consistent and correct ordering of left-handed or right-handed point sequences is important throughout the coord array of point values. Hint: clockwise <a href="https://en.wikipedia.org/wiki/Clockwise" target="_blank">https://en.wikipedia.org/wiki/Clockwise</a> *

Specified by:

getCcw in interface NurbsSweptSurface

Returns:

value of ccw field

setCcw

public NurbsSweptSurface setCcw(boolean newValue)

Accessor method to assign boolean value to initializeOnly SFBool field named ccw.

Tooltip: ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in turn defines front/back orientation of polygon normals according to Right-Hand Rule (RHR). Hint: a good debugging technique for problematic polygons is to try changing the value of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector direction. Warning: consistent and correct ordering of left-handed or right-handed point sequences is important throughout the coord array of point values. Hint: clockwise <a href="https://en.wikipedia.org/wiki/Clockwise" target="_blank">https://en.wikipedia.org/wiki/Clockwise</a> *

Specified by:

setCcw in interface NurbsSweptSurface

Parameters:

newValue - is new value for the ccw field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCcw

public NurbsSweptSurface setCcw(SFBool newValue)

Assign typed object value to SFBool ccw field, similar to setCcw(boolean). // #0.e

Parameters:

newValue - is new value for the ccw field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCrossSectionCurve

public X3DNurbsControlCurveNode getCrossSectionCurve()

Provide org.web3d.x3d.sai.NURBS.X3DNurbsControlCurveNode instance (using a properly typed node) from inputOutput SFNode field crossSectionCurve.

Specified by:

getCrossSectionCurve in interface NurbsSweptSurface

Returns:

value of crossSectionCurve field

See Also:

• 

Tooltip: [X3DNurbsControlCurveNode] defines cross-section of the surface traced about the trajectoryCurve axis. *


setCrossSectionCurve

public NurbsSweptSurface setCrossSectionCurve(X3DNurbsControlCurveNode newValue)

Accessor method to assign org.web3d.x3d.sai.NURBS.X3DNurbsControlCurveNode instance (using a properly typed node) to inputOutput SFNode field crossSectionCurve.

Specified by:

setCrossSectionCurve in interface NurbsSweptSurface

Parameters:

newValue - is new value for the crossSectionCurve field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• 

Tooltip: [X3DNurbsControlCurveNode] defines cross-section of the surface traced about the trajectoryCurve axis. *


clearCrossSectionCurve

public NurbsSweptSurface clearCrossSectionCurve()

Utility method to clear SFNode value of crossSectionCurve field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setCrossSectionCurve

public NurbsSweptSurface setCrossSectionCurve(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field crossSectionCurve.

Parameters:

newValue - is new value for the crossSectionCurve field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setCrossSectionCurve(org.web3d.x3d.sai.NURBS.X3DNurbsControlCurveNode)

hasCrossSectionCurve

public boolean hasCrossSectionCurve()

Indicate whether an object is available for inputOutput SFNode field crossSectionCurve.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getCrossSectionCurve()
• getCrossSectionCurveProtoInstance()

getIS

public IS getIS()

Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.

Specified by:

getIS in class X3DConcreteNode

Returns:

value of IS field

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

setIS

public NurbsSweptSurface setIS(IS newValue)

Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the IS field.

Returns:

NurbsSweptSurface - 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

public NurbsSweptSurface clearIS()

Utility method to clear SFNode value of IS field.

Returns:

NurbsSweptSurface - 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

public X3DMetadataObject getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface NurbsSweptSurface

Specified by:

getMetadata in interface X3DGeometryNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DParametricGeometryNode

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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *

• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public NurbsSweptSurface setMetadata(X3DMetadataObject newValue)

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 interface NurbsSweptSurface

Specified by:

setMetadata in interface X3DGeometryNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DParametricGeometryNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

NurbsSweptSurface - 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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *

• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public NurbsSweptSurface clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public NurbsSweptSurface setMetadata(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setMetadata(org.web3d.x3d.sai.Core.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

getSolid

public boolean getSolid()

Provide boolean value from initializeOnly SFBool field named solid.

Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off). Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick). Warning: default value true can completely hide geometry if viewed from wrong side! Hint: if in doubt, use solid='false' for maximum visibility. Hint: (X3D version 4.0 draft) accessType relaxed to inputOutput in order to support animation and visualization. *

Specified by:

getSolid in interface NurbsSweptSurface

Returns:

value of solid field

setSolid

public NurbsSweptSurface setSolid(boolean newValue)

Accessor method to assign boolean value to initializeOnly SFBool field named solid.

Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off). Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick). Warning: default value true can completely hide geometry if viewed from wrong side! Hint: if in doubt, use solid='false' for maximum visibility. Hint: (X3D version 4.0 draft) accessType relaxed to inputOutput in order to support animation and visualization. *

Specified by:

setSolid in interface NurbsSweptSurface

Parameters:

newValue - is new value for the solid field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setSolid

public NurbsSweptSurface setSolid(SFBool newValue)

Assign typed object value to SFBool solid field, similar to setSolid(boolean). // #0.e

Parameters:

newValue - is new value for the solid field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getTrajectoryCurve

public NurbsCurve getTrajectoryCurve()

Provide org.web3d.x3d.sai.NURBS.NurbsCurve instance (using a properly typed node) from inputOutput SFNode field trajectoryCurve.

Specified by:

getTrajectoryCurve in interface NurbsSweptSurface

Returns:

value of trajectoryCurve field

See Also:

• 

Tooltip: [NurbsCurve] describes the center-line path using a NurbsCurve node, oriented so that it is defined counterclockwise when looking down the −Y axis, thus defining a concept of inside and outside. *


setTrajectoryCurve

public NurbsSweptSurface setTrajectoryCurve(NurbsCurve newValue)

Accessor method to assign org.web3d.x3d.sai.NURBS.NurbsCurve instance (using a properly typed node) to inputOutput SFNode field trajectoryCurve.

Specified by:

setTrajectoryCurve in interface NurbsSweptSurface

Parameters:

newValue - is new value for the trajectoryCurve field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• 

Tooltip: [NurbsCurve] describes the center-line path using a NurbsCurve node, oriented so that it is defined counterclockwise when looking down the −Y axis, thus defining a concept of inside and outside. *


clearTrajectoryCurve

public NurbsSweptSurface clearTrajectoryCurve()

Utility method to clear SFNode value of trajectoryCurve field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setTrajectoryCurve

public NurbsSweptSurface setTrajectoryCurve(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field trajectoryCurve.

Parameters:

newValue - is new value for the trajectoryCurve field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setTrajectoryCurve(org.web3d.x3d.sai.NURBS.NurbsCurve)

hasTrajectoryCurve

public boolean hasTrajectoryCurve()

Indicate whether an object is available for inputOutput SFNode field trajectoryCurve.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getTrajectoryCurve()
• getTrajectoryCurveProtoInstance()

getDEF

public 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 <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final NurbsSweptSurface setDEF(String newValue)

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 <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *


Note that setting the DEF value clears the USE value.

Specified by:

setDEF in class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public NurbsSweptSurface setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String). // #0.e

Parameters:

newValue - is new value for the DEF field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUSE

public 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 class X3DConcreteNode

Returns:

value of USE field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setUSE

public final NurbsSweptSurface setUSE(String newValue)

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: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

Warning: invoking the setUSE() 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 class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public NurbsSweptSurface setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String). // #0.e

Parameters:

newValue - is new value for the USE field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final NurbsSweptSurface setCssClass(String newValue)

Accessor method to assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public NurbsSweptSurface setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String). // #0.e

Parameters:

newValue - is new value for the class field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final NurbsSweptSurface setHtmlID(String newValue)

Accessor method to assign String value to inputOutput SFString field named id.

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public NurbsSweptSurface setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String). // #0.e

Parameters:

newValue - is new value for the id field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final NurbsSweptSurface setCssStyle(String newValue)

Accessor method to assign String value to inputOutput SFString field named style.

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public NurbsSweptSurface setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String). // #0.e

Parameters:

newValue - is new value for the style field.

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public NurbsSweptSurface setUSE(NurbsSweptSurface DEFnode)

Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

Warning: note that the setUSE() 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:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addComments

public NurbsSweptSurface addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public NurbsSweptSurface addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public NurbsSweptSurface addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

NurbsSweptSurface - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

public 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 class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

public String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

• X3D.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 String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

• X3D.FILE_EXTENSION_VRML97
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Virtual Reality Modeling Language (VRML) 97 specification
• VRML 97 v2.1 Amendment

findElementByNameValue

public X3DConcreteElement 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. 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 class X3DConcreteElement

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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

findElementByNameValue

public X3DConcreteElement 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. 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 class X3DConcreteElement

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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public 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.

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

public X3DConcreteNode findNodeByDEF(String DEFvalue)

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 class X3DConcreteElement

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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(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 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 class X3DConcreteElement

Returns:

validation results (if any)