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

SoShape Class Reference

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 Methods

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 Methods

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

Protected Methods

 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 SoDetail * createTriangleDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp)
virtual SoDetail * createLineSegmentDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, SoPickedPoint *pp)
virtual SoDetail * createPointDetail (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
 

For internal use only.

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, SoText3, SoFaceSet, SoImage, SoIndexedFaceSet, SoIndexedLineSet, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoIndexedShape, SoIndexedTriangleStripSet, SoLineSet, SoMarkerSet, SoNonIndexedShape, SoNurbsCurve, SoNurbsSurface, SoPointSet, SoQuadMesh, SoSphere, SoText2, 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, SoText3, SoFaceSet, SoImage, SoIndexedFaceSet, SoIndexedLineSet, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoIndexedTriangleStripSet, SoLineSet, SoMarkerSet, SoNurbsCurve, SoNurbsSurface, SoPointSet, SoQuadMesh, SoSphere, SoText2, 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]
 

For internal use only.

Reimplemented in SoAsciiText, SoCone, SoCube, SoCylinder, SoText3, SoFaceSet, SoImage, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoIndexedShape, SoLineSet, SoNurbsCurve, SoNurbsSurface, SoPointSet, SoQuadMesh, SoSphere, SoText2, 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, SoText3, SoFaceSet, SoImage, SoIndexedFaceSet, SoIndexedLineSet, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoIndexedTriangleStripSet, SoLineSet, SoMarkerSet, SoNurbsCurve, SoNurbsSurface, SoPointSet, SoQuadMesh, SoSphere, SoText2, 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]
 

For internal use only.

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

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

For internal use only.

Reimplemented in SoVertexShape.

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

For internal use only.

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

For internal use only.

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]
 

For internal use only.

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

For internal use only.

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

For internal use only.

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

For internal use only.

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

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]
 

For internal use only.

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

For internal use only.

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

For internal use only.

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

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]
 

For internal use only.

void SoShape::endShape (  void )  [protected]
 

For internal use only.

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 at Tue Mar 5 03:31:30 2002 for Coin by doxygen1.2.9 written by Dimitri van Heesch, © 1997-2001