Coin Logo http://www.sim.no/
http://www.coin3d.org/

Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | List of all members
SoLineSet Class Reference

The SoLineSet class is used to render and organize non-indexed polylines.Polylines are specified using the numVertices field. Coordinates, normals, materials and texture coordinates are fetched in order from the current state or from the vertexProperty node if set. For example, if numVertices is set to [3, 4, 2], this node would specify a line through coordinates 0, 1 and 2, a line through coordinates 3, 4, 5 and 6, and finally a single line segment between coordinates 7 and 8. More...

#include <Inventor/nodes/SoLineSet.h>

Inheritance diagram for SoLineSet:
SoNonIndexedShape SoVertexShape SoShape SoNode SoFieldContainer SoBase

Public Member Functions

virtual SoType getTypeId (void) const
 SoLineSet (void)
virtual void GLRender (SoGLRenderAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

Static Public Member Functions

static SoType getClassTypeId (void)
static void initClass (void)

Public Attributes

SoMFInt32 numVertices
- Public Attributes inherited from SoNonIndexedShape
SoSFInt32 startIndex
- Public Attributes inherited from SoVertexShape
SoSFNode vertexProperty

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
virtual ~SoLineSet ()
virtual void generatePrimitives (SoAction *action)
virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)
- Protected Member Functions inherited from SoNonIndexedShape
 SoNonIndexedShape (void)
virtual ~SoNonIndexedShape ()
void computeCoordBBox (SoAction *action, int numVertices, SbBox3f &box, SbVec3f &center)
void fixNumVerticesPointers (SoState *state, const int32_t *&start, const int32_t *&end, int32_t *dummyarray) const
- Protected Member Functions inherited from SoVertexShape
 SoVertexShape (void)
virtual ~SoVertexShape ()
virtual SbBool shouldGLRender (SoGLRenderAction *action)
void setNormalCache (SoState *const state, const int num, const SbVec3f *normals)
SoNormalCachegetNormalCache (void) const
SoNormalCachegenerateAndReadLockNormalCache (SoState *const state)
void getVertexData (SoState *state, const SoCoordinateElement *&coords, const SbVec3f *&normals, const SbBool neednormals)
void readLockNormalCache (void)
void readUnlockNormalCache (void)
- Protected Member Functions inherited from SoShape
 SoShape (void)
virtual ~SoShape ()
float getComplexityValue (SoAction *action)
void beginSolidShape (SoGLRenderAction *action)
void endSolidShape (SoGLRenderAction *action)
void GLRenderBoundingBox (SoGLRenderAction *action)
SbBool shouldPrimitiveCount (SoGetPrimitiveCountAction *action)
SbBool shouldRayPick (SoRayPickAction *const action)
void computeObjectSpaceRay (SoRayPickAction *const action)
void computeObjectSpaceRay (SoRayPickAction *const action, const SbMatrix &matrix)
virtual SoDetailcreateTriangleDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp)
virtual SoDetailcreateLineSegmentDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, SoPickedPoint *pp)
virtual SoDetailcreatePointDetail (SoRayPickAction *action, const SoPrimitiveVertex *v, SoPickedPoint *pp)
void invokeTriangleCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2, const SoPrimitiveVertex *const v3)
void invokeLineSegmentCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2)
void invokePointCallbacks (SoAction *const action, const SoPrimitiveVertex *const v)
void beginShape (SoAction *const action, const TriangleShape shapetype, SoDetail *const detail=NULL)
void shapeVertex (const SoPrimitiveVertex *const v)
void endShape (void)
void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoTextureCoordinateElement *const tce, const float s, const float t, const SbVec3f &normal)
void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoTextureCoordinateElement *const tce, const float s, const float t, const float r, const SbVec3f &normal)
SbBool startVertexArray (SoGLRenderAction *action, const SoCoordinateElement *coords, const SbVec3f *pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex)
void finishVertexArray (SoGLRenderAction *action, const SbBool vbo, const SbBool normpervertex, const SbBool texpervertex, const SbBool colorpervertex)
- Protected Member Functions inherited from SoNode
 SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer (void)
virtual ~SoFieldContainer ()
- Protected Member Functions inherited from SoBase
 SoBase (void)
virtual ~SoBase ()
virtual void destroy (void)
SbBool hasMultipleWriteRefs (void) const
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
void writeFooter (SoOutput *out) const
virtual const char * getFileFormatName (void) const

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)

Additional Inherited Members

- Public Types inherited from SoShape
enum  TriangleShape {
  TRIANGLE_STRIP, TRIANGLE_FAN, TRIANGLES, POLYGON,
  QUADS, QUAD_STRIP, POINTS, LINES,
  LINE_STRIP
}
- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
- Protected Attributes inherited from SoNode
uint32_t uniqueId
- Static Protected Attributes inherited from SoNode
static uint32_t nextUniqueId = 1
static int nextActionMethodIndex = 0

Detailed Description

The SoLineSet class is used to render and organize non-indexed polylines.

Polylines are specified using the numVertices field. Coordinates, normals, materials and texture coordinates are fetched in order from the current state or from the vertexProperty node if set. For example, if numVertices is set to [3, 4, 2], this node would specify a line through coordinates 0, 1 and 2, a line through coordinates 3, 4, 5 and 6, and finally a single line segment between coordinates 7 and 8.

Here's a very simple usage example:

#Inventor V2.1 ascii

Separator {
   Coordinate3 {
      point [ 0 0 0, 1 1 1, 2 1 1, 2 2 1, 2 2 2, 2 2 3, 2 3 2, 2 3 3, 3 3 3 ]
   }

   LineSet {
      numVertices [ 3, 4, 2 ]
   }
}

Binding PER_VERTEX, PER_FACE, PER_PART or OVERALL can be set for material, and normals. The default material binding is OVERALL. The default normal binding is PER_VERTEX. If no normals are set, the line set will be rendered with lighting disabled.

The width of the rendered lines can be controlled through the insertion of an SoDrawStyle node in front of SoLineSet node(s) in the scenegraph.

FILE FORMAT/DEFAULTS:

LineSet {
}
See Also
SoIndexedLineSet

Constructor & Destructor Documentation

SoLineSet::SoLineSet ( void  )

Constructor.

SoLineSet::~SoLineSet ( )
protectedvirtual

Destructor.

Member Function Documentation

SoType SoLineSet::getClassTypeId ( void  )
static

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoNonIndexedShape.

SoType SoLineSet::getTypeId ( void  ) const
virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.

Usage example:

void foo(SoNode * node)
{
if (node->getTypeId() == SoFile::getClassTypeId()) {
SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type
}
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoNonIndexedShape.

const SoFieldData ** SoLineSet::getFieldDataPtr ( void  )
staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Reimplemented from SoNonIndexedShape.

const SoFieldData * SoLineSet::getFieldData ( void  ) const
protectedvirtual

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoNonIndexedShape.

void SoLineSet::initClass ( void  )
static

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoNonIndexedShape.

void SoLineSet::GLRender ( SoGLRenderAction action)
virtual

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoShape.

void SoLineSet::getBoundingBox ( SoGetBoundingBoxAction action)
virtual

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node.

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoShape.

void SoLineSet::getPrimitiveCount ( SoGetPrimitiveCountAction action)
virtual

Action method for the SoGetPrimitiveCountAction.

Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.

Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoShape.

void SoLineSet::generatePrimitives ( SoAction action)
protectedvirtual

The method implements action behavior for shape nodes for SoCallbackAction. It is invoked from SoShape::callback(). (Subclasses should not override SoNode::callback().)

The subclass implementations uses the convenience methods SoShape::beginShape(), SoShape::shapeVertex(), and SoShape::endShape(), with SoDetail instances, to pass the primitives making up the shape back to the caller.

Implements SoShape.

void SoLineSet::computeBBox ( SoAction action,
SbBox3f box,
SbVec3f center 
)
protectedvirtual

Implemented by SoShape subclasses to let the SoShape superclass know the exact size and weighted center point of the shape's bounding box.

The bounding box and center point should be calculated and returned in the local coordinate system.

The method implements action behavior for shape nodes for SoGetBoundingBoxAction. It is invoked from SoShape::getBoundingBox(). (Subclasses should not override SoNode::getBoundingBox().)

The box parameter sent in is guaranteed to be an empty box, while center is undefined upon function entry.

Implements SoShape.

Member Data Documentation

SoMFInt32 SoLineSet::numVertices

Used to specify polylines. Each entry specifies the number of coordinates in a line. The coordinates are taken in order from the state or from the vertexProperty node.


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

Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated on Mon Mar 17 2014 18:54:37 for Coin by Doxygen 1.8.1.2.