Package org.web3d.x3d.sai.NURBS

Interface NurbsSweptSurface

All Superinterfaces:

X3DGeometryNode, X3DNode, X3DParametricGeometryNode

All Known Implementing Classes:

NurbsSweptSurface

public interface NurbsSweptSurface
extends X3DParametricGeometryNode

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. NurbsSweptSurface 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 interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

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

Method Summary

Modifier and Type	Method	Description
boolean	getCcw()	Provide boolean value from initializeOnly SFBool field named ccw.
X3DNurbsControlCurveNode	getCrossSectionCurve()	Provide org.web3d.x3d.sai.NURBS.X3DNurbsControlCurveNode instance (using a properly typed node) from inputOutput SFNode field crossSectionCurve.
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.
NurbsSweptSurface	setCcw(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named ccw.
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.
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	setTrajectoryCurve(NurbsCurve newValue)	Accessor method to assign org.web3d.x3d.sai.NURBS.NurbsCurve instance (using a properly typed node) to inputOutput SFNode field trajectoryCurve.

Method Details

getCcw

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 https://en.wikipedia.org/wiki/Clockwise

Returns:

value of ccw field

setCcw

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 https://en.wikipedia.org/wiki/Clockwise

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

X3DNurbsControlCurveNode getCrossSectionCurve()

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

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

Returns:

value of crossSectionCurve field

setCrossSectionCurve

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.

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

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

getMetadata

X3DMetadataObject getMetadata()

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

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/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata

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:

• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

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.

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/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata

Specified by:

setMetadata in interface X3DGeometryNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DParametricGeometryNode

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:

• X3D Scene Authoring Hints: Metadata Nodes

getSolid

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: accessType relaxed to inputOutput in order to support animation and visualization.

Returns:

value of solid field

setSolid

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: accessType relaxed to inputOutput in order to support animation and visualization.

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

NurbsCurve getTrajectoryCurve()

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

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

Returns:

value of trajectoryCurve field

setTrajectoryCurve

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.

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

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