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

SoShape Class Reference
[Nodes]

The SoShape class is the superclass for geometry shapes.

The node types which have actual geometry to render inherits this class. For convenience, the SoShape class contains various common code used by the subclasses. More...

#include <Inventor/nodes/SoShape.h>

Inheritance diagram for SoShape:

SoNode SoFieldContainer SoBase SoAsciiText SoCone SoCube SoCylinder SoImage SoIndexedNurbsCurve SoIndexedNurbsSurface SoNurbsCurve SoNurbsSurface SoSphere SoText2 SoText3 SoVertexShape SoVRMLGeometry

List of all members.

Public Types

enum  TriangleShape {
  TRIANGLE_STRIP, TRIANGLE_FAN, TRIANGLES, POLYGON,
  QUADS, QUAD_STRIP, POINTS, LINES,
  LINE_STRIP
}

Public Member Functions

virtual SoType getTypeId (void) const
virtual SbBool affectsState (void) const
virtual void notify (SoNotList *nl)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void callback (SoCallbackAction *action)
virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)=0
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
const SoBoundingBoxCache * getBoundingBoxCache (void) const

Static Public Member Functions

static SoType getClassTypeId (void)
static void initClass (void)
static void getScreenSize (SoState *const state, const SbBox3f &boundingbox, SbVec2s &rectsize)
static float getDecimatedComplexity (SoState *state, float complexity)

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
 SoShape (void)
virtual ~SoShape ()
float getComplexityValue (SoAction *action)
virtual void generatePrimitives (SoAction *action)=0
virtual SbBool shouldGLRender (SoGLRenderAction *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)

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)

Friends

class soshape_primdata
class so_generate_prim_private


Detailed Description

The SoShape class is the superclass for geometry shapes.

The node types which have actual geometry to render inherits this class. For convenience, the SoShape class contains various common code used by the subclasses.


Member Enumeration Documentation

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


Constructor & Destructor Documentation

SoShape::SoShape ( void   )  [protected]

Constructor.

SoShape::~SoShape (  )  [protected, virtual]

Destructor.


Member Function Documentation

SoType SoShape::getClassTypeId ( void   )  [static]

SoType SoShape::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
    }
    else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
      SoGroup * group = (SoGroup *)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.

Implements SoBase.

Reimplemented in SoAsciiText, SoCone, SoCube, SoCylinder, SoFaceSet, SoImage, SoIndexedFaceSet, SoIndexedLineSet, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoIndexedShape, SoIndexedTriangleStripSet, SoLineSet, SoMarkerSet, SoNonIndexedShape, SoNurbsCurve, SoNurbsSurface, SoPointSet, SoQuadMesh, SoSphere, SoText2, SoText3, SoTriangleStripSet, SoVertexShape, SoVRMLBox, SoVRMLCone, SoVRMLCylinder, SoVRMLElevationGrid, SoVRMLExtrusion, SoVRMLGeometry, SoVRMLIndexedFaceSet, SoVRMLIndexedLine, SoVRMLIndexedLineSet, SoVRMLIndexedShape, SoVRMLPointSet, SoVRMLSphere, SoVRMLText, SoVRMLVertexLine, SoVRMLVertexPoint, and SoVRMLVertexShape.

Referenced by SoCallbackAction::invokeLineSegmentCallbacks(), SoCallbackAction::invokePointCallbacks(), SoCallbackAction::invokeTriangleCallbacks(), and SoCallbackAction::shouldGeneratePrimitives().

const SoFieldData ** SoShape::getFieldDataPtr ( void   )  [static, protected]

const SoFieldData * SoShape::getFieldData ( void   )  const [protected, virtual]

void SoShape::initClass ( void   )  [static]

SbBool SoShape::affectsState ( void   )  const [virtual]

Returns TRUE if the node could have any effect on the state during traversal.

If it returns FALSE, no data in the traversal-state will change from the pre-traversal state to the post-traversal state. The SoSeparator node will for instance return FALSE, as it pushes and pops the state before and after traversal of its children. All SoShape nodes will also return FALSE, as just pushing out geometry data to the rendering engine won't affect the actual rendering state.

The default method returns TRUE, on a "better safe than sorry" philosophy.

Reimplemented from SoNode.

void SoShape::notify ( SoNotList l  )  [virtual]

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

Reimplemented in SoIndexedLineSet, SoIndexedNurbsCurve, SoLineSet, SoNurbsCurve, SoPointSet, SoVRMLIndexedLineSet, SoVRMLPointSet, SoVRMLVertexLine, SoVRMLVertexPoint, and SoVRMLVertexShape.

References SoGetBoundingBoxAction::extendBy(), SbBox3f::isEmpty(), and SoGetBoundingBoxAction::setCenter().

Referenced by SoVRMLVertexShape::getBoundingBox(), SoVRMLVertexPoint::getBoundingBox(), SoVRMLVertexLine::getBoundingBox(), SoPointSet::getBoundingBox(), SoNurbsCurve::getBoundingBox(), SoLineSet::getBoundingBox(), SoIndexedNurbsCurve::getBoundingBox(), and SoIndexedLineSet::getBoundingBox().

void SoShape::GLRender ( SoGLRenderAction action  )  [virtual]

void SoShape::rayPick ( SoRayPickAction action  )  [virtual]

void SoShape::callback ( SoCallbackAction action  )  [virtual]

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Reimplemented from SoNode.

Reimplemented in SoVRMLVertexLine, SoVRMLVertexPoint, and SoVRMLVertexShape.

References generatePrimitives(), and SoCallbackAction::shouldGeneratePrimitives().

Referenced by SoVRMLVertexShape::callback(), SoVRMLVertexPoint::callback(), and SoVRMLVertexLine::callback().

void SoShape::computeBBox ( SoAction action,
SbBox3f box,
SbVec3f center 
) [pure 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.

Implemented in SoAsciiText, SoCone, SoCube, SoCylinder, SoFaceSet, SoImage, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoIndexedShape, SoLineSet, SoNurbsCurve, SoNurbsSurface, SoPointSet, SoQuadMesh, SoSphere, SoText2, SoText3, SoTriangleStripSet, SoVRMLBox, SoVRMLCone, SoVRMLCylinder, SoVRMLElevationGrid, SoVRMLExtrusion, SoVRMLIndexedLine, SoVRMLIndexedShape, SoVRMLSphere, SoVRMLText, and SoVRMLVertexPoint.

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

Reimplemented in SoAsciiText, SoCone, SoCube, SoCylinder, SoFaceSet, SoImage, SoIndexedFaceSet, SoIndexedLineSet, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoIndexedTriangleStripSet, SoLineSet, SoMarkerSet, SoNurbsCurve, SoNurbsSurface, SoPointSet, SoQuadMesh, SoSphere, SoText2, SoText3, SoTriangleStripSet, SoVRMLBox, SoVRMLCone, SoVRMLCylinder, SoVRMLElevationGrid, SoVRMLExtrusion, SoVRMLIndexedFaceSet, SoVRMLIndexedLineSet, SoVRMLSphere, SoVRMLText, and SoVRMLVertexPoint.

References generatePrimitives(), and shouldPrimitiveCount().

Referenced by SoText3::getPrimitiveCount().

void SoShape::getScreenSize ( SoState *const   state,
const SbBox3f boundingbox,
SbVec2s rectsize 
) [static]

A convenience function that returns the size of a boundingbox projected onto the screen. Useful for SCREEN_SPACE complexity geometry.

References SbBox2f::extendBy(), SoFieldContainer::get(), SbBox3f::getBounds(), SbBox2f::getSize(), SbBox2f::makeEmpty(), SbMatrix::multVecMatrix(), and SbVec3f::setValue().

Referenced by SoLevelOfDetail::doAction(), and getComplexityValue().

float SoShape::getDecimatedComplexity ( SoState state,
float  complexity 
) [static]

Not implemented in Coin. Should probably have been private in TGS Inventor API.

const SoBoundingBoxCache * SoShape::getBoundingBoxCache ( void   )  const

Return the bounding box cache for this shape. It might return NULL if no bounding box cache has been created. If not NULL, the caller must check if the cache is valid before using it. This can be done using SoCache::isValid().

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

float SoShape::getComplexityValue ( SoAction action  )  [protected]

void SoShape::generatePrimitives ( SoAction action  )  [protected, pure virtual]

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.

Implemented in SoAsciiText, SoCone, SoCube, SoCylinder, SoFaceSet, SoImage, SoIndexedFaceSet, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoIndexedTriangleStripSet, SoLineSet, SoNurbsCurve, SoNurbsSurface, SoPointSet, SoQuadMesh, SoSphere, SoText2, SoText3, SoTriangleStripSet, SoVRMLBox, SoVRMLCone, SoVRMLCylinder, SoVRMLElevationGrid, SoVRMLExtrusion, SoVRMLIndexedFaceSet, SoVRMLIndexedLineSet, SoVRMLPointSet, SoVRMLSphere, and SoVRMLText.

Referenced by callback(), getPrimitiveCount(), GLRender(), rayPick(), and shouldGLRender().

SbBool SoShape::shouldGLRender ( SoGLRenderAction action  )  [protected, virtual]

void SoShape::beginSolidShape ( SoGLRenderAction action  )  [protected]

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

References SoAction::getState(), SoState::push(), and SoFieldContainer::set().

void SoShape::endSolidShape ( SoGLRenderAction action  )  [protected]

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

References SoAction::getState(), and SoState::pop().

void SoShape::GLRenderBoundingBox ( SoGLRenderAction action  )  [protected]

Render a bounding box.

References SbBox3f::getMax(), SbBox3f::getMin(), and SoAction::getState().

Referenced by shouldGLRender().

SbBool SoShape::shouldPrimitiveCount ( SoGetPrimitiveCountAction action  )  [protected]

SbBool SoShape::shouldRayPick ( SoRayPickAction *const   action  )  [protected]

void SoShape::computeObjectSpaceRay ( SoRayPickAction *const   action  )  [protected]

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

References SoRayPickAction::setObjectSpace().

Referenced by rayPick(), and SoImage::rayPick().

void SoShape::computeObjectSpaceRay ( SoRayPickAction *const   action,
const SbMatrix matrix 
) [protected]

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

References SoRayPickAction::setObjectSpace().

SoDetail * SoShape::createTriangleDetail ( SoRayPickAction action,
const SoPrimitiveVertex v1,
const SoPrimitiveVertex v2,
const SoPrimitiveVertex v3,
SoPickedPoint pp 
) [protected, virtual]

Will create triangle detail for a SoPickedPoint. This method will only be called internally, when generatePrimitives() is used for picking (SoShape::rayPick() is not overridden).

This method returns NULL in Open Inventor, and subclasses will need to override this method to create details for a SoPickedPoint.

This is not necessary with Coin. Of course, if you choose to override it, it will work in the same way as Open Inventor.

For this to work, you must supply a face or line detail when generating primitives. If you supply NULL for the detail argument in SoShape::beginShape(), you'll have to override this method.

Reimplemented in SoAsciiText, SoIndexedNurbsSurface, SoNurbsSurface, SoText3, and SoVRMLExtrusion.

References SoDebugError::postInfo().

Referenced by invokeTriangleCallbacks().

SoDetail * SoShape::createLineSegmentDetail ( SoRayPickAction action,
const SoPrimitiveVertex v1,
const SoPrimitiveVertex v2,
SoPickedPoint pp 
) [protected, virtual]

Will create line detail for a SoPickedPoint. This method will only be called internally, when generatePrimitives() is used for picking (SoShape::rayPick() is not overridden).

This method returns NULL in Open Inventor, and subclasses will need to override this method to create details for a SoPickedPoint.

This is not necessary with Coin. Of course, if you choose to override it, it will work in the same way as Open Inventor.

For this to work, you must supply a face or line detail when generating primitives. If you supply NULL for the detail argument in SoShape::beginShape(), you'll have to override this method.

Reimplemented in SoIndexedNurbsCurve, and SoNurbsCurve.

References SoDebugError::postInfo().

Referenced by invokeLineSegmentCallbacks().

SoDetail * SoShape::createPointDetail ( SoRayPickAction action,
const SoPrimitiveVertex v,
SoPickedPoint pp 
) [protected, virtual]

Will create point detail for a SoPickedPoint. This method will only be called internally, when generatePrimitives() is used for picking (SoShape::rayPick() is not overridden).

This method returns NULL in Open Inventor, and subclasses will need to override this method to create details for a SoPickedPoint.

This is not necessary with Coin. Of course, if you choose to override it, it will work in the same way as Open Inventor.

For this to work, you must supply a point detail in the SoPrimitiveVertex in generatePrimitives().

References SoDetail::copy(), and SoPrimitiveVertex::getDetail().

Referenced by invokePointCallbacks().

void SoShape::invokeTriangleCallbacks ( SoAction *const   action,
const SoPrimitiveVertex *const   v1,
const SoPrimitiveVertex *const   v2,
const SoPrimitiveVertex *const   v3 
) [protected]

void SoShape::invokeLineSegmentCallbacks ( SoAction *const   action,
const SoPrimitiveVertex *const   v1,
const SoPrimitiveVertex *const   v2 
) [protected]

void SoShape::invokePointCallbacks ( SoAction *const   action,
const SoPrimitiveVertex *const   v 
) [protected]

void SoShape::beginShape ( SoAction *const   action,
const TriangleShape  shapetype,
SoDetail *const   detail = NULL 
) [protected]

This method is used to generate primitives for a shape. It's typically called from a node's generatePrimitives() method. If you have your own shape and want to write a generatePrimitives() method for that shape, it's probably a good idea to take a peek in the generatePrimitives() method for a similar shape in Coin.

generatePrimitives() can contain several beginShape()/endShape() sequences. shapeVertex() is used for each vertex between beginShape() and endShape(). For instance, to generate primitives for a triangle you'd do something like this:

  SoPrimitiveVertex vertex;

  this->beginShape(action, SoShape::POLYGON);
  vertex.setPoint(SbVec3f(0.0f, 0.0f, 0.0f));
  this->shapeVertex(&vertex);
  vertex.setPoint(SbVec3f(1.0f, 0.0f, 0.0f));
  this->shapeVertex(&vertex);
  vertex.setPoint(SbVec3f(1.0f, 1.0f, 0.0f));
  this->shapeVertex(&vertex);
  this->endShape();
  

Note that the SoPrimitiveVertex instance can simply be placed on the stack and not allocated. SoShape will copy the needed information when you call shapeVertex().

Before calling shapeVertex(), you can set extra information for the SoPrimitiveVertex, including normal, material index, and texture coordinates.

This method is slightly different from its counterpart from the original Open Inventor library, as this method has an SoDetail as the last argument, and not an SoFaceDetail. This is because we accept more TriangleShape types, and the detail might be a SoFaceDetail or a SoLineDetail. There is no use sending in a SoPointDetail, as nothing will be done with it.

Referenced by SoVRMLText::generatePrimitives(), SoTriangleStripSet::generatePrimitives(), SoQuadMesh::generatePrimitives(), SoPointSet::generatePrimitives(), SoLineSet::generatePrimitives(), SoIndexedTriangleStripSet::generatePrimitives(), SoIndexedFaceSet::generatePrimitives(), SoImage::generatePrimitives(), SoFaceSet::generatePrimitives(), SoAsciiText::generatePrimitives(), SoVRMLPointSet::generatePrimitives(), SoVRMLIndexedLineSet::generatePrimitives(), SoVRMLIndexedFaceSet::generatePrimitives(), SoVRMLExtrusion::generatePrimitives(), and SoVRMLElevationGrid::generatePrimitives().

void SoShape::shapeVertex ( const SoPrimitiveVertex *const   v  )  [protected]

void SoShape::endShape ( void   )  [protected]

void SoShape::generateVertex ( SoPrimitiveVertex *const   pv,
const SbVec3f point,
const SbBool  usetexfunc,
const SoTextureCoordinateElement *const   tce,
const float  s,
const float  t,
const SbVec3f normal 
) [protected]

Convenience function which sets up an SoPrimitiveVertex, and sends it using the SoShape::shapeVertex() function. 2D version

void SoShape::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 
) [protected]

Convenience function which sets up an SoPrimitiveVertex, and sends it using the SoShape::shapeVertex() function. 3D version.

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

References SoPrimitiveVertex::setNormal(), SoPrimitiveVertex::setPoint(), SoPrimitiveVertex::setTextureCoords(), SbVec4f::setValue(), and shapeVertex().

SbBool SoShape::startVertexArray ( SoGLRenderAction action,
const SoCoordinateElement *  coords,
const SbVec3f pervertexnormals,
const SbBool  texpervertex,
const SbBool  colorpervertex 
) [protected]

Convenience method that enables vertex arrays and/or VBOs Returns TRUE if VBO is used.

See also:
finishVertexArray()
Since:
Coin 2.5

References SoGLRenderAction::getCacheContext(), and SoAction::getState().

Referenced by SoPointSet::GLRender(), SoIndexedLineSet::GLRender(), SoIndexedFaceSet::GLRender(), SoVRMLPointSet::GLRender(), SoVRMLIndexedLineSet::GLRender(), and SoVRMLIndexedFaceSet::GLRender().

void SoShape::finishVertexArray ( SoGLRenderAction action,
const SbBool  vbo,
const SbBool  normpervertex,
const SbBool  texpervertex,
const SbBool  colorpervertex 
) [protected]

Should be called after rendering with vertex arrays. This method will disable arrays and VBOs enabled in the startVertexArray() function.

See also:
startVertexArray()
Since:
Coin 2.5

References SoAction::getState().

Referenced by SoPointSet::GLRender(), SoIndexedLineSet::GLRender(), SoIndexedFaceSet::GLRender(), SoVRMLPointSet::GLRender(), SoVRMLIndexedLineSet::GLRender(), and SoVRMLIndexedFaceSet::GLRender().


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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 23 16:34:01 2009 for Coin by Doxygen. 1.5.8