Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

SoVertexShape Class Reference
[Nodes]

The SoVertexShape class is the superclass for all vertex based shapes. More...

#include <Inventor/nodes/SoVertexShape.h>

Inheritance diagram for SoVertexShape:

SoShape SoNode SoFieldContainer SoBase SoIndexedShape SoNonIndexedShape SoIndexedFaceSet SoIndexedLineSet SoIndexedTriangleStripSet SoFaceSet SoLineSet SoPointSet SoQuadMesh SoTriangleStripSet List of all members.

Public Methods

virtual void notify (SoNotList *nl)
virtual SbBool generateDefaultNormals (SoState *state, SoNormalBundle *bundle)
virtual SbBool generateDefaultNormals (SoState *state, SoNormalCache *cache)
virtual void write (SoWriteAction *action)

Static Public Methods

void initClass (void)

Public Attributes

SoSFNode vertexProperty

Protected Methods

 SoVertexShape (void)
virtual ~SoVertexShape ()
virtual SbBool shouldGLRender (SoGLRenderAction *action)
void setNormalCache (SoState *const state, const int num, const SbVec3f *normals)
SoNormalCache * getNormalCache (void) const
SoNormalCache * generateAndReadLockNormalCache (SoState *const state)
void getVertexData (SoState *state, const SoCoordinateElement *&coords, const SbVec3f *&normals, const SbBool neednormals)
void readLockNormalCache (void)
void readUnlockNormalCache (void)

Detailed Description

The SoVertexShape class is the superclass for all vertex based shapes.

Basically, every polygon, line or point based shape will inherit this class. It contains methods for organizing the normal cache, and also holds the vertexProperty field which can be used to set vertex data inside the node.


Constructor & Destructor Documentation

SoVertexShape::SoVertexShape void    [protected]
 

Constructor.

SoVertexShape::~SoVertexShape   [protected, virtual]
 

Destructor.


Member Function Documentation

void SoVertexShape::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 SoShape.

Reimplemented in SoFaceSet, SoIndexedFaceSet, SoIndexedLineSet, SoIndexedShape, SoIndexedTriangleStripSet, SoLineSet, SoMarkerSet, SoNonIndexedShape, SoPointSet, SoQuadMesh, and SoTriangleStripSet.

void SoVertexShape::notify SoNotList   nl [virtual]
 

Notifies all auditors for this instance when changes are made.

Reimplemented from SoShape.

SbBool SoVertexShape::generateDefaultNormals SoState   state,
SoNormalBundle *    bundle
[virtual]
 

Subclasses should override this method to generate default normals using the SoNormalBundle class. TRUE should be returned if normals were generated, FALSE otherwise. Default method returns FALSE.

Reimplemented in SoFaceSet, SoIndexedFaceSet, SoIndexedTriangleStripSet, SoPointSet, SoQuadMesh, and SoTriangleStripSet.

SbBool SoVertexShape::generateDefaultNormals SoState   state,
SoNormalCache *    cache
[virtual]
 

Subclasses should override this method to generate default normals using the SoNormalCache class. This is more effective than using SoNormalGenerator. Return TRUE if normals were generated, FALSE otherwise. Default method just returns FALSE.

This method is not part of the original SGI Open Inventor API.

Reimplemented in SoFaceSet, SoIndexedFaceSet, SoIndexedTriangleStripSet, SoPointSet, SoQuadMesh, and SoTriangleStripSet.

void SoVertexShape::write SoWriteAction   action [virtual]
 

Action method for SoWriteAction.

Writes out a node object, and any connected nodes, engines etc, if necessary.

Reimplemented from SoNode.

SbBool SoVertexShape::shouldGLRender SoGLRenderAction   action [protected, virtual]
 

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

Reimplemented from SoShape.

void SoVertexShape::setNormalCache SoState *const    state,
const int    num,
const SbVec3f   normals
[protected]
 

Sets normal cache to contain the normals specified by normals and num, and forces cache dependencies on coordinates, shape hints and crease angle.

SoNormalCache * SoVertexShape::getNormalCache void    const [protected]
 

Returns the current normal cache, or NULL if there is none.

SoNormalCache * SoVertexShape::generateAndReadLockNormalCache SoState *const    state [protected]
 

Convenience method that can be used by subclasses to return or create a normal cache. If the current cache is not valid, it takes care of unrefing the old cache and pushing and popping the state to create element dependencies when creating the new cache.

When returning from this method, the normal cache will be read locked, and the caller should call readUnlockNormalCache() when the normals in the cache is no longer needed.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:
Coin 2.0

void SoVertexShape::getVertexData SoState   state,
const SoCoordinateElement *&    coords,
const SbVec3f *&    normals,
const SbBool    neednormals
[protected]
 

Convenience method that returns the current coordinate and normal element. This method is not part of the OIV API.

void SoVertexShape::readLockNormalCache void    [protected]
 

Read lock the normal cache. This method should be called before fetching the normal cache (using getNormalCache()). When the cached normals are no longer needed, readUnlockNormalCache() must be called.

It is also possible to use generateAndReadLockNormalCache().

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

See also:
readUnlockNormalCache()
Since:
Coin 2.0

void SoVertexShape::readUnlockNormalCache void    [protected]
 

Read unlock the normal cache. Should be called when the read-locked cached normals are no longer needed.

See also:
readLockNormalCache()
Since:
Coin 2.0


Member Data Documentation

SoSFNode SoVertexShape::vertexProperty
 

If you set the vertexProperty field, it should be with an SoVertexProperty node. Otherwise it will simply be ignored. Nodetypes inheriting SoVertexShape will then get their coordinate data from the vertexProperty node instead of from the global traversal state.

The vertexProperty field of SoVertexShape-derived nodes breaks somewhat with the basic design of Open Inventor, as its contents are not passed to the global state. This is done to provide a simple path to highly optimized rendering of vertexbased shapes.

See also:
SoVertexProperty


The documentation for this class was generated from the following files:
Generated on Sat May 24 22:39:51 2003 for Coin by doxygen1.2.18