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

SoShape Class Reference
[Nodes]

The SoShape class is the superclass for geometry shapes. 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 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 SbBool affectsState (void) const
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)

Static Public Member Functions

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

Protected Member Functions

 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)

Detailed Description

The SoShape class is the superclass for geometry shapes.

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


Member Enumeration Documentation

enum SoShape::TriangleShape
 

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

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

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, and SoVertexShape.

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::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, and SoPointSet.

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

Reimplemented in SoAsciiText, SoCone, SoCube, SoCylinder, SoFaceSet, SoImage, SoIndexedFaceSet, SoIndexedLineSet, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoIndexedTriangleStripSet, SoLineSet, SoMarkerSet, SoNurbsCurve, SoNurbsSurface, SoPointSet, SoQuadMesh, SoSphere, SoText2, SoText3, and SoTriangleStripSet.

void SoShape::rayPick SoRayPickAction action  )  [virtual]
 

Calculates picked point based on primitives generated by subclasses.

Reimplemented from SoNode.

Reimplemented in SoCone, SoCube, SoCylinder, SoImage, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoNurbsCurve, SoNurbsSurface, SoSphere, and SoText2.

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.

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, and SoTriangleStripSet.

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, and SoTriangleStripSet.

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.

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

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

float SoShape::getComplexityValue SoAction action  )  [protected]
 

Returns the complexity value to be used by subclasses. Considers complexity type. For OBJECT_SPACE complexity this will be a number between 0 and 1. For SCREEN_SPACE complexity it is a number from 0 and up.

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, and SoTriangleStripSet.

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

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.

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.

void SoShape::GLRenderBoundingBox SoGLRenderAction action  )  [protected]
 

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

SbBool SoShape::shouldPrimitiveCount SoGetPrimitiveCountAction action  )  [protected]
 

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

SbBool SoShape::shouldRayPick 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.

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.

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.

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, and SoText3.

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.

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().

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

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

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

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

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

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

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:

verbatim 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(); verbatim

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.

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

This method is used while generating primitives for a shape. See beginShape() for more details.

See also:
beginShape(), endShape()

void SoShape::endShape void   )  [protected]
 

This method is used while generating primitives for a shape. See beginShape() for more details.

See also:
beginShape(), shapeVertex()

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.


The documentation for this class was generated from the following files:
Generated on Tue Jul 27 23:53:07 2004 for Coin by doxygen 1.3.7