SoShape.3coin3 man page

SoShape — 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.

Synopsis

#include <Inventor/nodes/SoShape.h>

Inherits SoNode.

Inherited by SoAsciiText, SoCone, SoCube, SoCylinder, SoImage, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoNurbsCurve, SoNurbsSurface, SoSphere, SoText2, SoText3, SoVertexShape, and SoVRMLGeometry.

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 SoFieldData * getFieldData (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 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)

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)

Additional Inherited Members

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

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

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
  }
}

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 SoVertexShape, SoVRMLElevationGrid, SoVRMLVertexShape, SoText3, SoVRMLIndexedFaceSet, SoImage, SoVRMLIndexedLineSet, SoVRMLText, SoIndexedFaceSet, SoIndexedLineSet, SoIndexedTriangleStripSet, SoVRMLExtrusion, SoAsciiText, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoIndexedPointSet, SoIndexedShape, SoNurbsCurve, SoNurbsSurface, SoVRMLVertexPoint, SoCube, SoFaceSet, SoIndexedMarkerSet, SoText2, SoVRMLCone, SoVRMLCylinder, SoVRMLGeometry, SoVRMLVertexLine, SoCone, SoCylinder, SoNonIndexedShape, SoVRMLBox, SoVRMLIndexedLine, SoVRMLIndexedShape, SoVRMLPointSet, SoVRMLSphere, SoLineSet, SoMarkerSet, SoPointSet, SoQuadMesh, SoSphere, and SoTriangleStripSet.

const SoFieldData * SoShape::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 SoFieldContainer.

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

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]

Notifies all auditors for this instance when changes are made.

Reimplemented from SoNode.

Reimplemented in SoText3, SoImage, SoVRMLVertexShape, SoVRMLElevationGrid, SoAsciiText, SoVRMLExtrusion, SoVRMLText, SoVRMLIndexedLine, SoVRMLIndexedLineSet, SoVertexShape, SoVRMLVertexPoint, SoIndexedLineSet, SoVRMLGeometry, SoVRMLVertexLine, SoVRMLIndexedShape, SoIndexedPointSet, and SoIndexedMarkerSet.

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 SoVRMLVertexShape, SoIndexedNurbsCurve, SoNurbsCurve, SoVRMLIndexedLineSet, SoVRMLVertexLine, SoVRMLVertexPoint, SoIndexedLineSet, SoIndexedPointSet, SoLineSet, SoPointSet, and SoVRMLPointSet.

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 SoMarkerSet, SoVRMLVertexShape, SoText3, SoImage, SoVRMLElevationGrid, SoCylinder, SoVRMLText, SoVRMLExtrusion, SoAsciiText, SoCone, SoIndexedNurbsSurface, SoVRMLIndexedFaceSet, SoNurbsSurface, SoText2, SoIndexedNurbsCurve, SoVRMLCylinder, SoVRMLCone, SoCube, SoNurbsCurve, SoVRMLIndexedLineSet, SoVRMLVertexLine, SoVRMLVertexPoint, SoIndexedFaceSet, SoIndexedLineSet, SoIndexedTriangleStripSet, SoFaceSet, SoIndexedMarkerSet, SoIndexedPointSet, SoLineSet, SoQuadMesh, SoVRMLBox, SoVRMLSphere, SoPointSet, SoSphere, SoTriangleStripSet, and SoVRMLPointSet.

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

Calculates picked point based on primitives generated by subclasses.

Reimplemented from SoNode.

Reimplemented in SoImage, SoVRMLElevationGrid, SoCone, SoCylinder, SoIndexedNurbsSurface, SoNurbsSurface, SoText2, SoIndexedNurbsCurve, SoVRMLCylinder, SoVRMLCone, SoCube, SoNurbsCurve, SoVRMLBox, SoVRMLSphere, and SoSphere.

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 SoVRMLVertexShape, SoVRMLVertexLine, and SoVRMLVertexPoint.

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 SoText3, SoImage, SoVRMLElevationGrid, SoVRMLText, SoCylinder, SoIndexedNurbsSurface, SoCone, SoAsciiText, SoNurbsSurface, SoText2, SoVRMLVertexPoint, SoIndexedNurbsCurve, SoVRMLExtrusion, SoNurbsCurve, SoVRMLCylinder, SoVRMLCone, SoCube, SoFaceSet, SoQuadMesh, SoIndexedShape, SoLineSet, SoVRMLBox, SoVRMLSphere, SoPointSet, SoSphere, SoTriangleStripSet, SoVRMLIndexedShape, and SoVRMLIndexedLine.

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 SoMarkerSet, SoText3, SoImage, SoVRMLElevationGrid, SoVRMLText, SoCone, SoCylinder, SoIndexedNurbsSurface, SoVRMLExtrusion, SoAsciiText, SoNurbsSurface, SoText2, SoVRMLIndexedFaceSet, SoIndexedNurbsCurve, SoVRMLCylinder, SoVRMLVertexPoint, SoVRMLCone, SoCube, SoNurbsCurve, SoIndexedLineSet, SoVRMLIndexedLineSet, SoFaceSet, SoIndexedFaceSet, SoIndexedTriangleStripSet, SoIndexedPointSet, SoLineSet, SoVRMLBox, SoVRMLSphere, SoPointSet, SoQuadMesh, SoSphere, 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.

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]

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 SoText3, SoImage, SoVRMLElevationGrid, SoVRMLText, SoVRMLExtrusion, SoCylinder, SoIndexedNurbsSurface, SoAsciiText, SoCone, SoVRMLIndexedFaceSet, SoNurbsSurface, SoText2, SoIndexedNurbsCurve, SoIndexedFaceSet, SoNurbsCurve, SoVRMLCylinder, SoVRMLCone, SoCube, SoIndexedTriangleStripSet, SoVRMLIndexedLineSet, SoFaceSet, SoIndexedPointSet, SoQuadMesh, SoLineSet, SoVRMLBox, SoVRMLSphere, SoPointSet, SoSphere, SoTriangleStripSet, and SoVRMLPointSet.

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 SoVRMLVertexShape, SoVertexShape, SoVRMLVertexPoint, SoVRMLVertexLine, and SoVRMLGeometry.

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]

Render a bounding box.

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 SoText3, SoVRMLExtrusion, SoIndexedNurbsSurface, SoAsciiText, 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]

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:

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.

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

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 3.0

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 3.0

Author

Generated automatically by Doxygen for Coin from the source code.

Referenced By

SoShape.3coin2(3) is an alias of SoShape.3coin3(3).

Mon Sep 5 2016 Version 3.1.3 Coin