Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
SoLineSet Class Reference
Inventor » Nodes » Shapes

Polyline shape node. More...

#include <Inventor/nodes/SoLineSet.h>

+ Inheritance diagram for SoLineSet:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoLineSet ()
 Creates a line set node with default settings.
 
- Public Member Functions inherited from SoVertexShape
SoNormalCache * getNormalCache () const
 Returns the current normal cache, or NULL if there is none.
 
SoTangentCache * getTangentCache () const
 Returns the current tangent cache, or NULL if there is none.
 
- Public Member Functions inherited from SoShape
virtual SbBool affectsState () const
 Overrides default method on SoNode.
 
ShapeType getShapeType ()
 Gets the current shape Full Scene Antialiasing type.
 
- 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 SoNode * copy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
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 SoField * getField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoField * getEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoField * getEventOut (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 SoNonIndexedShape
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoVertexShape
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoShape
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SbBool isPrimitiveRestartAvailable (SoState *state=NULL)
 Returns TRUE if the primitive restart feature is available.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNode * getByName (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

SoMFInt32 numVertices
 Number of vertices per polyline.
 
- Public Attributes inherited from SoNonIndexedShape
SoSFInt32 startIndex
 Index of first coordinate of shape.
 
- Public Attributes inherited from SoVertexShape
SoSFNode vertexProperty
 vertex property node.
 
- Public Attributes inherited from SoShape
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Additional Inherited Members

- Public Types inherited from SoShape
enum  ShapeType {
  POINTS ,
  LINES ,
  POLYGONS ,
  TEXT
}
 Basic type for antialiased rendering for this shape (Do not consider the SoDrawStyle property currently in the state). More...
 

Detailed Description

Polyline shape node.

This node represents a 3D shape formed by constructing a set of polylines from vertices located at the coordinates specified in the vertexProperty field (from SoVertexShape), or the current inherited coordinates. For optimal performance, the vertexProperty field is recommended.

Coordinates are used in order, starting with startIndex (zero by default).

If the numVertices field contains -1 (the default), then all the coordinates (starting with startIndex) are rendered as a single polyline.

Otherwise each polyline uses the number of vertices specified by a value in the numVertices field. For example, an SoLineSet with a numVertices of [3,4,2] would use the first three coordinates for the first polyline, the next four coordinates for the second polyline, and the next two coordinates for the third polyline. Thus the number of values in the numVertices field indicates the number of polylines in the set.

The coordinates of the line set are transformed by the current cumulative transformation.

The line width and pattern are controlled by fields in SoDrawStyle.

The lines are drawn with the current drawing style (see SoDrawStyle), but drawing style FILLED is treated as LINES.

Treatment of the current material, normal and tangent binding is as follows:

  • PER_PART binding specifies a material, normal or tangent for each segment of the line.
  • PER_FACE binding specifies a material, normal or tangent for each polyline.
  • PER_VERTEX specifies a material, normal or tangent for each vertex.
  • The _INDEXED bindings mean exactly the same as their non-indexed counterparts.
  • The default material binding is OVERALL.
  • The default normal and tangent bindings are PER_VERTEX

The current complexity value has no effect on the rendering of line sets.

Shape Antialiasing type is SoShape::LINES.

Lighting:

  • By default, lighting is enabled (SoLightModel model = PER_VERTEX_PHONG). But...
    Unlike polygonal shapes, lighting will not be applied to line shapes unless the application explicitly sets normal vectors (using SoVertexProperty or SoNormal) or sets tangent vectors (using SoVertexProperty). Normal vectors are not automatically computed for line shapes.

  • If lighting is enabled and tangent vectors are specified:
    then normal vectors are ignored and lines are lighted using the Illuminated Stream Lines algorithm (Zöckler, Stalling & Hege, 1996) (http://www.zib.de/visual-publications/sources/src-1996/isl.pdf).

  • If lighting is enabled and normal vectors are specified but not tangent vectors:
    then lines are lighted using the same algorithm as polygonal shapes.

  • Note the above discussion is specific to rendering of line shapes , e.g. this node.
    If you render a polygonal shape, e.g. SoFaceSet, using LINES mode (SoDrawStyle), the rules for polygonal shapes apply (if lighting is enabled and no normal vectors were specified, then normal vectors are automatically computed by Open Inventor).

  • NOTE: If you want to apply lighting in a shader, you must explicitly set normal or tangent vectors, otherwise lighting will be disabled for the line shape.

Limitations:

  • Currently does not use VBOs (vertex buffer objects) for rendering. For very large line sets, performance may be better using SoIndexedLineSet.

FILE FORMAT/DEFAULT

    LineSet {
    vertexProperty NULL
    startIndex 0
    numVertices -1
    }

ACTION BEHAVIOR

    SoGLRenderAction
    Draws lines based on the current coordinates, normals, tangents, materials, drawing style, and so on.

    SoRayPickAction
    Picks lines based on the current coordinates and transformation. Details about the intersection are returned in an SoLineDetail.

    SoGetBoundingBoxAction
    Computes the bounding box that encloses all vertices of the line set with the current transformation applied to them. Sets the center to the average of the coordinates of all vertices.

    SoCallbackAction
    If any line segment callbacks are registered with the action, they will be invoked for each successive segment in the line set.

SEE ALSO

SoCoordinate3, SoDrawStyle, SoFullSceneAntialiasing, SoIndexedLineSet, SoLineDetail, SoVertexProperty

Definition at line 189 of file SoLineSet.h.

Constructor & Destructor Documentation

◆ SoLineSet()

SoLineSet::SoLineSet ( )

Creates a line set node with default settings.

Member Function Documentation

◆ getClassTypeId()

static SoType SoLineSet::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoLineSet::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNonIndexedShape.

Reimplemented in PlaneBoxIntersection.

Member Data Documentation

◆ numVertices

SoMFInt32 SoLineSet::numVertices

Number of vertices per polyline.

Definition at line 198 of file SoLineSet.h.

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