Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoNurbsProperty Class Reference

Node that defines additional properties for rendering a NURBS surface. More...

#include <Inventor/nodes/SoNurbsProperty.h>

+ Inheritance diagram for SoNurbsProperty:

Public Types

enum  DrawStyle {
  NORMAL = 0x01 ,
  BOUNDARIES_AND_TRIM_CURVES = 0x02 ,
  CENTRAL_ISO_PARAM_CURVES = 0x04
}
 Draw style. More...
 
enum  TessellationType {
  CONSTANT ,
  ADAPTIVE
}
 Tesselation type. More...
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoNurbsProperty ()
 Constructor.
 
- Public Member Functions inherited from SoNode
virtual void setOverride (const SbBool state)
 Turns the override flag on or off.
 
virtual SbBool isOverride () const
 Returns the state of the override flag.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual SbBool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal.
 
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
SbBool set (const SbString &fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (const SbName &name)
 A node's name can be set using SoBase::setName().
 
static int getByName (const SbName &name, SoNodeList &list)
 A node's name can be set using SoBase::setName().
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Public Attributes

SoSFBitMask drawStyle
 Indicates which part of the NURBS surface to render.
 
SoSFInt32 numSamplePoints
 numSamplePoints is used during trim curve tessellation.
 
SoSFColor color
 Contains the color used to render trim curves and isoparametric curves.
 
SoSFUShort isoParamCurvesPattern
 Sets a specific line pattern for isoparametric curves.
 
SoSFEnum tessellationType
 Specifies the tessellation type.
 
SoSFFloat tessellationDistance
 Used when tessellationType is set to ADAPTIVE.
 
SoSFFloat tessellationAngle
 Used when tessellationType is set to ADAPTIVE.
 

Detailed Description

Node that defines additional properties for rendering a NURBS surface.

This node defines an additional set of properties used by SoNurbsSurface when rendering NURBS surfaces.

For a large NURBS surface, it is sometimes more effective to display two central isoparametric curves rather than facet boundaries (as in wireframe mode) because the latter may provide an overly complicated view of the surface.

This node allows you to specify the NURBS draw style; the color of the trim curves, boundaries and isoparametric curves; the line pattern of the isoparametric curves; the number of sample points between trim curves control points; the type of tessellation; angle and distance for adaptive tessellation.

The NURBS draw style is a bitmask specifying which combination of the following representations to use for displaying the NURBS: normal display, trim curves and boundaries, and/or central isoparametric curves.

Turning off the normal NURBS surface display, and turning on the display of trim curves, boundaries and isoparametric curves can dramatically speed up rendering of large models.

When in ADAPTIVE tessellation mode, regions with a low curvature will be less tessellated than regions with a high curvature.

FILE FORMAT/DEFAULT

    NurbsProperty {
    drawStyle NORMAL
    numSamplePoints -1
    color 1 1 1
    isoParamCurvesPattern 0xFFFF
    tessellationType CONSTANT
    tessellationDistance 0.01
    tessellationAngle 0.35
    }

ACTION BEHAVIOR

SEE ALSO

SoNurbsSurface

Definition at line 91 of file SoNurbsProperty.h.

Member Enumeration Documentation

◆ DrawStyle

Draw style.

Enumerator
NORMAL 

Draw the NURBS surface normally.

BOUNDARIES_AND_TRIM_CURVES 

Draw the boundaries of the surface and trim curves.

CENTRAL_ISO_PARAM_CURVES 

Draw two isoparametric curves in the middle of the surface (one for U = 0.5 and one for V=0.5)

Definition at line 97 of file SoNurbsProperty.h.

◆ TessellationType

Tesselation type.

Enumerator
CONSTANT 

The tessellation step size is constant and the same for both the U and V axes.

The tessellation step size depends on SoComplexity::value.

ADAPTIVE 

The tessellation depends on the curvature of the geometry.

Regions with a low curvature will be less tessellated than regions with a high curvature.

Definition at line 114 of file SoNurbsProperty.h.

Constructor & Destructor Documentation

◆ SoNurbsProperty()

SoNurbsProperty::SoNurbsProperty ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoNurbsProperty::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoNurbsProperty::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Member Data Documentation

◆ color

SoSFColor SoNurbsProperty::color

Contains the color used to render trim curves and isoparametric curves.

Definition at line 148 of file SoNurbsProperty.h.

◆ drawStyle

SoSFBitMask SoNurbsProperty::drawStyle

Indicates which part of the NURBS surface to render.

Use enum DrawStyle. Default is NORMAL.

Definition at line 133 of file SoNurbsProperty.h.

◆ isoParamCurvesPattern

SoSFUShort SoNurbsProperty::isoParamCurvesPattern

Sets a specific line pattern for isoparametric curves.

Definition at line 153 of file SoNurbsProperty.h.

◆ numSamplePoints

SoSFInt32 SoNurbsProperty::numSamplePoints

numSamplePoints is used during trim curve tessellation.

It specifies the exact number of points to generate between two trim curve control points. If set to -1 (the default), the number of points generated is computed from the SoComplexity node. Setting this field to a small value (less than 3) can reduce the number of triangles generated by the tessellation and thus increase the drawing performance of trimmed NURBS surfaces.

Definition at line 143 of file SoNurbsProperty.h.

◆ tessellationAngle

SoSFFloat SoNurbsProperty::tessellationAngle

Used when tessellationType is set to ADAPTIVE.

Specifies the maximum angle (in radians) between the normals of two adjacent tessellated faces. Decreasing this value adds more tessellation points on flat parts of the surface. Default value is 0.35

NOTE: field available since Open Inventor 6.0

Definition at line 183 of file SoNurbsProperty.h.

◆ tessellationDistance

SoSFFloat SoNurbsProperty::tessellationDistance

Used when tessellationType is set to ADAPTIVE.

The maximum tessellation step size (curvilinear distance) is this fraction of the diagonal of the bounding box of the surface or the group of surfaces (SoNurbsGroup). Increasing this value make the tessellation more dependent on tessellationAngle. Default value is 0.01. That is, the distance must not be more than 1% of the diagonal of the bounding box.

NOTE: field available since Open Inventor 6.0

Definition at line 173 of file SoNurbsProperty.h.

◆ tessellationType

SoSFEnum SoNurbsProperty::tessellationType

Specifies the tessellation type.

NOTE: field available since Open Inventor 6.0

Definition at line 161 of file SoNurbsProperty.h.


The documentation for this class was generated from the following file: