trusty (3) SoIndexedShape.3.gz

Provided by: libcoin80-doc_3.1.4~abc9f50-4ubuntu2_all bug

NAME

       SoIndexedShape -

       The SoIndexedShape class is the superclass for all indexed vertex shapes.

       This is an abstract class which contains storage for four fields for indices to coordinates, normals,
       materials and texture coordinates for it's subclasses.

SYNOPSIS

       #include <Inventor/nodes/SoIndexedShape.h>

       Inherits SoVertexShape.

       Inherited by SoIndexedFaceSet, SoIndexedLineSet, SoIndexedPointSet, and SoIndexedTriangleStripSet.

   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.

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static void initClass (void)

   Public Attributes
       SoMFInt32 coordIndex
       SoMFInt32 materialIndex
       SoMFInt32 normalIndex
       SoMFInt32 textureCoordIndex

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       SoIndexedShape (void)
       virtual ~SoIndexedShape ()
       virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)
       int getNumVerts (const int startCoord)
       void setupIndices (const int numParts, const int numFaces, const SbBool needNormals, const SbBool
           needTexCoords)
       const int32_t * getNormalIndices (void)
       const int32_t * getColorIndices (void)
       const int32_t * getTexCoordIndices (void)
       SbBool getVertexData (SoState *state, const SoCoordinateElement *&coords, const SbVec3f *&normals, const
           int32_t *&cindices, const int32_t *&nindices, const int32_t *&tindices, const int32_t *&mindices, int
           &numcindices, const SbBool needNormals, SbBool &normalCacheUsed)

   Static Protected Member Functions
       static const SoFieldData ** getFieldDataPtr (void)
       static SbBool areTexCoordsIndexed (SoAction *action)

   Additional Inherited Members

Detailed Description

       The SoIndexedShape class is the superclass for all indexed vertex shapes.

       This is an abstract class which contains storage for four fields for indices to coordinates, normals,
       materials and texture coordinates for it's subclasses.

Constructor & Destructor Documentation

   SoIndexedShape::SoIndexedShape (void) [protected]
       Constructor.

   SoIndexedShape::~SoIndexedShape () [protected],  [virtual]
       Destructor.

Member Function Documentation

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

       Reimplemented in SoIndexedFaceSet, SoIndexedLineSet, SoIndexedTriangleStripSet, SoIndexedPointSet, and
       SoIndexedMarkerSet.

   const SoFieldData * SoIndexedShape::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 SoVertexShape.

       Reimplemented in SoIndexedFaceSet, SoIndexedLineSet, SoIndexedTriangleStripSet, SoIndexedPointSet, and
       SoIndexedMarkerSet.

   void SoIndexedShape::computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center) [protected],  [virtual]
       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.

   int SoIndexedShape::getNumVerts (const intstartCoord) [protected]
       Starting at index position startCoord, returns the number of indices until either the end of index array
       or a separator index (-1).

   void SoIndexedShape::setupIndices (const intnumParts, const intnumFaces, const SbBoolneedNormals, const
       SbBoolneedTexCoords) [protected]
       Not implemented. Probably only used for internal purposes in SGI's original Open Inventor, which means it
       should have been private.

       Let us know if you need this method for any code you are porting and we'll look into implement it
       properly.

   const int32_t * SoIndexedShape::getNormalIndices (void) [protected]
       Not implemented. Probably only used for internal purposes in SGI's original Open Inventor, which means it
       should have been private.

       Let us know if you need this method for any code you are porting and we'll look into implement it
       properly.

   const int32_t * SoIndexedShape::getColorIndices (void) [protected]
       Not implemented. Probably only used for internal purposes in SGI's original Open Inventor, which means it
       should have been private.

       Let us know if you need this method for any code you are porting and we'll look into implement it
       properly.

   const int32_t * SoIndexedShape::getTexCoordIndices (void) [protected]
       Not implemented. Probably only used for internal purposes in SGI's original Open Inventor, which means it
       should have been private.

       Let us know if you need this method for any code you are porting and we'll look into implement it
       properly.

   SbBool SoIndexedShape::areTexCoordsIndexed (SoAction *action) [static],  [protected]
       Returns whether texture coordinates should be indexed or not.

       See Also:
           SoTextureCoordinateBinding

   SbBool SoIndexedShape::getVertexData (SoState *state, const SoCoordinateElement *&coords, const SbVec3f
       *&normals, const int32_t *&cindices, const int32_t *&nindices, const int32_t *&tindices, const int32_t
       *&mindices, int &numcindices, const SbBoolneedNormals, SbBool &normalCacheUsed) [protected]
       Convenience method that will fetch data needed for rendering or generating primitives. Takes care of
       normal cache.

       This method was not part of the original SGI Open Inventor API, and is an extension specific for Coin.

Member Data Documentation

   SoMFInt32 SoIndexedShape::coordIndex
       Coordinate indices.

   SoMFInt32 SoIndexedShape::materialIndex
       Material indices.

   SoMFInt32 SoIndexedShape::normalIndex
       Normal indices.

   SoMFInt32 SoIndexedShape::textureCoordIndex
       Texture coordinate indices.

Author

       Generated automatically by Doxygen for Coin from the source code.