NAME

       SoVertexShape -

       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 SoVertexShape::vertexProperty
       field which can be used to set vertex data inside the node.

SYNOPSIS

       #include <Inventor/nodes/SoVertexShape.h>

       Inherits SoShape.

       Inherited by SoIndexedShape, and SoNonIndexedShape.

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase.
           This is used for run-time type checking and 'downward' casting.
       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 Member Functions
       static SoType getClassTypeId (void)
       static void initClass (void)

   Public Attributes
       SoSFNode vertexProperty

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       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)

   Static Protected Member Functions
       static const SoFieldData ** getFieldDataPtr (void)

   Additional Inherited Members

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 SoVertexShape::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

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

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

   const SoFieldData * SoVertexShape::getFieldData (void) const [protected],  [virtual]
       Returns a pointer to the class-wide field data storage object for this instance. If no
       fields are present, returns NULL.

       Reimplemented from SoShape.

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

   void SoVertexShape::notify (SoNotList *l) [virtual]
       Notifies all auditors for this instance when changes are made.

       Reimplemented from SoShape.

       Reimplemented in SoIndexedLineSet, and SoIndexedPointSet.

   SbBool SoVertexShape::generateDefaultNormals (SoState *state, SoNormalBundle *bundle)
       [virtual]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

       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.

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

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

   SbBool SoVertexShape::generateDefaultNormals (SoState *state, SoNormalCache *cache) [virtual]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

       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 function is an extension for Coin, and it is not available in the original SGI Open
       Inventor v2.1 API.

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

   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 *conststate, const intnum, 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 *conststate)
       [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 SbBoolneednormals) [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

       Since:
           Coin 1.0

           SGI Inventor v2.1

Author

       Generated automatically by Doxygen for Coin from the source code.