Package org.web3d.x3d.sai.NURBS

Interface NurbsTrimmedSurface

All Superinterfaces:
X3DGeometryNode, X3DNode, X3DNurbsSurfaceGeometryNode, X3DParametricGeometryNode
All Known Implementing Classes:
NurbsTrimmedSurfaceObject
public interface NurbsTrimmedSurface
extends X3DNurbsSurfaceGeometryNode
NurbsTrimmedSurface generates texture coordinates from a Non-Uniform Rational B-Spline (NURBS) surface.

X3D node tooltip: [X3DNurbsSurfaceGeometryNode] NurbsTrimmedSurface generates texture coordinates from a Non-Uniform Rational B-Spline (NURBS) surface. *


Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: NurbsTrimmedSurface, X3D Tooltips: NurbsTrimmedSurface, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    void addTrimmingContour​(X3DNode[] newValue)
    Add array of child trimmingContour nodes to array of existing nodes (if any).
    X3DCoordinateNode getControlPoint()
    Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field controlPoint.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    boolean getSolid()
    Provide boolean value from initializeOnly SFBool field named solid.
    X3DNode getTexCoord()
    Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTextureCoordinateNode|NurbsTextureCoordinate, from inputOutput SFNode field texCoord.
    X3DNode[] getTrimmingContour()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field trimmingContour.
    boolean getUClosed()
    Provide boolean value from initializeOnly SFBool field named uClosed.
    int getUDimension()
    Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named uDimension.
    double[] getUKnot()
    Provide array of double results from initializeOnly MFDouble field named uKnot.
    int getUOrder()
    Provide int value within allowed range of [2,infinity) from initializeOnly SFInt32 field named uOrder.
    int getUTessellation()
    Provide int value from inputOutput SFInt32 field named uTessellation.
    boolean getVClosed()
    Provide boolean value from initializeOnly SFBool field named vClosed.
    int getVDimension()
    Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named vDimension.
    double[] getVKnot()
    Provide array of double results from initializeOnly MFDouble field named vKnot.
    int getVOrder()
    Provide int value within allowed range of [2,infinity) from initializeOnly SFInt32 field named vOrder.
    int getVTessellation()
    Provide int value from inputOutput SFInt32 field named vTessellation.
    double[] getWeight()
    Provide array of double results within allowed range of (0,infinity) from inputOutput MFDouble field named weight.
    NurbsTrimmedSurface setControlPoint​(X3DCoordinateNode newValue)
    Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field controlPoint.
    NurbsTrimmedSurface setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    NurbsTrimmedSurface setSolid​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named solid.
    NurbsTrimmedSurface setTexCoord​(X3DNode newValue)
    Accessor method to assign X3DNode instance (using a properly typed node) to inputOutput SFNode field texCoord. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTextureCoordinateNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.NURBS.NurbsTextureCoordinateObject); if (!
    void setTrimmingContour​(X3DNode newValue)
    Set single child trimmingContour node, replacing prior array of existing nodes (if any).
    NurbsTrimmedSurface setTrimmingContour​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field trimmingContour.
    NurbsTrimmedSurface setUClosed​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named uClosed.
    NurbsTrimmedSurface setUDimension​(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named uDimension.
    NurbsTrimmedSurface setUKnot​(double[] newValue)
    Accessor method to assign double array to initializeOnly MFDouble field named uKnot.
    NurbsTrimmedSurface setUOrder​(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named uOrder.
    NurbsTrimmedSurface setUTessellation​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named uTessellation.
    NurbsTrimmedSurface setVClosed​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named vClosed.
    NurbsTrimmedSurface setVDimension​(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named vDimension.
    NurbsTrimmedSurface setVKnot​(double[] newValue)
    Accessor method to assign double array to initializeOnly MFDouble field named vKnot.
    NurbsTrimmedSurface setVOrder​(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named vOrder.
    NurbsTrimmedSurface setVTessellation​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named vTessellation.
    NurbsTrimmedSurface setWeight​(double[] newValue)
    Accessor method to assign double array to inputOutput MFDouble field named weight.

  • Method Details

    • getControlPoint

      X3DCoordinateNode getControlPoint()
      Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field controlPoint.

      Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies control points for NURBS geometry definitions. *
      Specified by:
      getControlPoint in interface X3DNurbsSurfaceGeometryNode
      Returns:
      value of controlPoint field

    • setControlPoint

      NurbsTrimmedSurface setControlPoint​(X3DCoordinateNode newValue)
      Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field controlPoint.

      Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies control points for NURBS geometry definitions. *
      Specified by:
      setControlPoint in interface X3DNurbsSurfaceGeometryNode
      Parameters:
      newValue - is new value for the controlPoint field.
      Returns:
      NurbsTrimmedSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide 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.
      Specified by:
      getMetadata in interface X3DGeometryNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DNurbsSurfaceGeometryNode
      Specified by:
      getMetadata in interface X3DParametricGeometryNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      NurbsTrimmedSurface setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign 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.
      Specified by:
      setMetadata in interface X3DGeometryNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DNurbsSurfaceGeometryNode
      Specified by:
      setMetadata in interface X3DParametricGeometryNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      NurbsTrimmedSurface - 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).
      • Warning: default value true can completely hide geometry if viewed from wrong side!
      • Hint: if in doubt, use solid='false' for maximum visibility.
      Specified by:
      getSolid in interface X3DNurbsSurfaceGeometryNode
      Returns:
      value of solid field

    • setSolid

      NurbsTrimmedSurface 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).
      • Warning: default value true can completely hide geometry if viewed from wrong side!
      • Hint: if in doubt, use solid='false' for maximum visibility.
      Specified by:
      setSolid in interface X3DNurbsSurfaceGeometryNode
      Parameters:
      newValue - is new value for the solid field.
      Returns:
      NurbsTrimmedSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getTexCoord

      X3DNode getTexCoord()
      Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTextureCoordinateNode|NurbsTextureCoordinate, from inputOutput SFNode field texCoord.

      Tooltip: [X3DTextureCoordinateNode|NurbsTextureCoordinate] Single contained NurbsTextureCoordinate, TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate node that specifies coordinates for texture mapping onto corresponding geometry. *
      Specified by:
      getTexCoord in interface X3DNurbsSurfaceGeometryNode
      Returns:
      value of texCoord field

    • setTexCoord

      NurbsTrimmedSurface setTexCoord​(X3DNode newValue)
      Accessor method to assign X3DNode instance (using a properly typed node) to inputOutput SFNode field texCoord. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTextureCoordinateNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.NURBS.NurbsTextureCoordinateObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes X3DTextureCoordinateNode|NurbsTextureCoordinate; newValue=" + newValue); }

      Tooltip: [X3DTextureCoordinateNode|NurbsTextureCoordinate] Single contained NurbsTextureCoordinate, TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate node that specifies coordinates for texture mapping onto corresponding geometry. *
      Specified by:
      setTexCoord in interface X3DNurbsSurfaceGeometryNode
      Parameters:
      newValue - is new value for the texCoord field.
      Returns:
      NurbsTrimmedSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getTrimmingContour

      X3DNode[] getTrimmingContour()
      Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field trimmingContour.

      Tooltip: [Contour2D] A set of Contour2D nodes are used as trimming loops.
      • Hint: if no trimming contours are defined, NurbsTrimmedSurface has same semantics as NurbsPatchSurface node.


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Contour2D.
      Returns:
      value of trimmingContour field
      See Also:
      Contour2DObject

    • setTrimmingContour

      NurbsTrimmedSurface setTrimmingContour​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field trimmingContour.

      Tooltip: [Contour2D] A set of Contour2D nodes are used as trimming loops.
      • Hint: if no trimming contours are defined, NurbsTrimmedSurface has same semantics as NurbsPatchSurface node.


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Contour2D.
      Parameters:
      newValue - is new value for the trimmingContour field.
      Returns:
      NurbsTrimmedSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addTrimmingContour

      void addTrimmingContour​(X3DNode[] newValue)
      Add array of child trimmingContour nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Contour2D.
      Parameters:
      newValue - is new value array to be appended the trimmingContour field.

    • setTrimmingContour

      void setTrimmingContour​(X3DNode newValue)
      Set single child trimmingContour node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the trimmingContour field

    • getUClosed

      boolean getUClosed()
      Provide boolean value from initializeOnly SFBool field named uClosed.

      Tooltip: Whether opposite surface sides are closed (seamless) across u dimension. *
      Specified by:
      getUClosed in interface X3DNurbsSurfaceGeometryNode
      Returns:
      value of uClosed field

    • setUClosed

      NurbsTrimmedSurface setUClosed​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named uClosed.

      Tooltip: Whether opposite surface sides are closed (seamless) across u dimension. *
      Specified by:
      setUClosed in interface X3DNurbsSurfaceGeometryNode
      Parameters:
      newValue - is new value for the uClosed field.
      Returns:
      NurbsTrimmedSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUDimension

      int getUDimension()
      Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named uDimension.

      Tooltip: Number of control points in u dimension. *
      Specified by:
      getUDimension in interface X3DNurbsSurfaceGeometryNode
      Returns:
      value of uDimension field

    • setUDimension

      NurbsTrimmedSurface setUDimension​(int newValue)
      Accessor method to assign int value to initializeOnly SFInt32 field named uDimension.

      Tooltip: Number of control points in u dimension. *
      Specified by:
      setUDimension in interface X3DNurbsSurfaceGeometryNode
      Parameters:
      newValue - is new value for the uDimension field.
      Returns:
      NurbsTrimmedSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUKnot

      double[] getUKnot()
      Provide array of double results from initializeOnly MFDouble field named uKnot.

      Tooltip: Knot vector, where size = number of control points + order of curve. *
      Specified by:
      getUKnot in interface X3DNurbsSurfaceGeometryNode
      Returns:
      value of uKnot field

    • setUKnot

      NurbsTrimmedSurface setUKnot​(double[] newValue)
      Accessor method to assign double array to initializeOnly MFDouble field named uKnot.

      Tooltip: Knot vector, where size = number of control points + order of curve. *
      Specified by:
      setUKnot in interface X3DNurbsSurfaceGeometryNode
      Parameters:
      newValue - is new value for the uKnot field.
      Returns:
      NurbsTrimmedSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUOrder

      int getUOrder()
      Provide int value within allowed range of [2,infinity) from initializeOnly SFInt32 field named uOrder.

      Tooltip: Define order of surface by polynomials of degree = order-1. *
      Specified by:
      getUOrder in interface X3DNurbsSurfaceGeometryNode
      Returns:
      value of uOrder field

    • setUOrder

      NurbsTrimmedSurface setUOrder​(int newValue)
      Accessor method to assign int value to initializeOnly SFInt32 field named uOrder.

      Tooltip: Define order of surface by polynomials of degree = order-1. *
      Specified by:
      setUOrder in interface X3DNurbsSurfaceGeometryNode
      Parameters:
      newValue - is new value for the uOrder field.
      Returns:
      NurbsTrimmedSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUTessellation

      int getUTessellation()
      Provide int value from inputOutput SFInt32 field named uTessellation.

      Tooltip: hint for surface tesselation. *
      Specified by:
      getUTessellation in interface X3DNurbsSurfaceGeometryNode
      Returns:
      value of uTessellation field

    • setUTessellation

      NurbsTrimmedSurface setUTessellation​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named uTessellation.

      Tooltip: hint for surface tesselation. *
      Specified by:
      setUTessellation in interface X3DNurbsSurfaceGeometryNode
      Parameters:
      newValue - is new value for the uTessellation field.
      Returns:
      NurbsTrimmedSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getVClosed

      boolean getVClosed()
      Provide boolean value from initializeOnly SFBool field named vClosed.

      Tooltip: Whether opposite surface sides are closed (seamless) across u dimension. *
      Specified by:
      getVClosed in interface X3DNurbsSurfaceGeometryNode
      Returns:
      value of vClosed field

    • setVClosed

      NurbsTrimmedSurface setVClosed​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named vClosed.

      Tooltip: Whether opposite surface sides are closed (seamless) across u dimension. *
      Specified by:
      setVClosed in interface X3DNurbsSurfaceGeometryNode
      Parameters:
      newValue - is new value for the vClosed field.
      Returns:
      NurbsTrimmedSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getVDimension

      int getVDimension()
      Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named vDimension.

      Tooltip: Number of control points in v dimension. *
      Specified by:
      getVDimension in interface X3DNurbsSurfaceGeometryNode
      Returns:
      value of vDimension field

    • setVDimension

      NurbsTrimmedSurface setVDimension​(int newValue)
      Accessor method to assign int value to initializeOnly SFInt32 field named vDimension.

      Tooltip: Number of control points in v dimension. *
      Specified by:
      setVDimension in interface X3DNurbsSurfaceGeometryNode
      Parameters:
      newValue - is new value for the vDimension field.
      Returns:
      NurbsTrimmedSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getVKnot

      double[] getVKnot()
      Provide array of double results from initializeOnly MFDouble field named vKnot.

      Tooltip: Knot vector, where size = number of control points + order of curve. *
      Specified by:
      getVKnot in interface X3DNurbsSurfaceGeometryNode
      Returns:
      value of vKnot field

    • setVKnot

      NurbsTrimmedSurface setVKnot​(double[] newValue)
      Accessor method to assign double array to initializeOnly MFDouble field named vKnot.

      Tooltip: Knot vector, where size = number of control points + order of curve. *
      Specified by:
      setVKnot in interface X3DNurbsSurfaceGeometryNode
      Parameters:
      newValue - is new value for the vKnot field.
      Returns:
      NurbsTrimmedSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getVOrder

      int getVOrder()
      Provide int value within allowed range of [2,infinity) from initializeOnly SFInt32 field named vOrder.

      Tooltip: Define order of surface by polynomials of degree = order-1. *
      Specified by:
      getVOrder in interface X3DNurbsSurfaceGeometryNode
      Returns:
      value of vOrder field

    • setVOrder

      NurbsTrimmedSurface setVOrder​(int newValue)
      Accessor method to assign int value to initializeOnly SFInt32 field named vOrder.

      Tooltip: Define order of surface by polynomials of degree = order-1. *
      Specified by:
      setVOrder in interface X3DNurbsSurfaceGeometryNode
      Parameters:
      newValue - is new value for the vOrder field.
      Returns:
      NurbsTrimmedSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getVTessellation

      int getVTessellation()
      Provide int value from inputOutput SFInt32 field named vTessellation.

      Tooltip: hint for surface tesselation. *
      Specified by:
      getVTessellation in interface X3DNurbsSurfaceGeometryNode
      Returns:
      value of vTessellation field

    • setVTessellation

      NurbsTrimmedSurface setVTessellation​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named vTessellation.

      Tooltip: hint for surface tesselation. *
      Specified by:
      setVTessellation in interface X3DNurbsSurfaceGeometryNode
      Parameters:
      newValue - is new value for the vTessellation field.
      Returns:
      NurbsTrimmedSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getWeight

      double[] getWeight()
      Provide array of double results within allowed range of (0,infinity) from inputOutput MFDouble field named weight.

      Tooltip: Vector assigning relative weight value to each control point. *
      Specified by:
      getWeight in interface X3DNurbsSurfaceGeometryNode
      Returns:
      value of weight field

    • setWeight

      NurbsTrimmedSurface setWeight​(double[] newValue)
      Accessor method to assign double array to inputOutput MFDouble field named weight.

      Tooltip: Vector assigning relative weight value to each control point. *
      Specified by:
      setWeight in interface X3DNurbsSurfaceGeometryNode
      Parameters:
      newValue - is new value for the weight field.
      Returns:
      NurbsTrimmedSurface - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).