SoProfile(3)

NAME
SoProfile - The SoProfile class is the abstract superclass for profile definitions.

Node subclasses of SoProfile specifies profiles for extruded 3D text and nurbs surface data.

SYNOPSIS

#include <Inventor/nodes/SoProfile.h>

Inherits SoNode.

Inherited by SoLinearProfile, and SoNurbsProfile.

  Public Types
enum Profile { START_FIRST = SoProfileElement::START_FIRST, START_NEW = SoProfileElement::START_NEW, ADD_TO_CURRENT = SoProfileElement::ADD_TO_CURRENT }

  Public Member Functions
virtual SoType getTypeId (void) const
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void pick (SoPickAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void getTrimCurve (SoState *state, int32_t &numpoints, float *&points, int &floatspervec, int32_t &numknots, float *&knotvector)=0
virtual void getVertices (SoState *state, int32_t &numvertices, SbVec2f *&vertices)=0

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

  Public Attributes
SoMFInt32 index
SoSFEnum linkage

  Protected Member Functions
virtual const SoFieldData * getFieldData (void) const
SoProfile (void)
virtual ~SoProfile ()

  Static Protected Member Functions
static const SoFieldData ** getFieldDataPtr (void)

  Additional Inherited Members

Detailed Description

The SoProfile class is the abstract superclass for profile definitions.

Node subclasses of SoProfile specifies profiles for extruded 3D text and nurbs surface data.

Member Enumeration Documentation

  enum SoProfile::Profile
Enumeration of various choices of how to link together multiple profiles.

Enumerator

START_FIRST
    Replace the current profile state set with this profile alone.

START_NEW
    Append this profile to the state as a new profile.

ADD_TO_CURRENT
    Append indices of this node to the last profile.

Constructor & Destructor Documentation

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

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

Member Function Documentation

  SoType SoProfile::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 SoNurbsProfile, and SoLinearProfile.

  const SoFieldData * SoProfile::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 SoNurbsProfile, and SoLinearProfile.

  void SoProfile::doAction (SoAction * action) [virtual]
This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

  void SoProfile::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 SoProfile::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.

  void SoProfile::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.

  void SoProfile::pick (SoPickAction * action) [virtual]
Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

  void SoProfile::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.

  void SoProfile::getTrimCurve (SoState * state, int32_t & numpoints, float *& points, int & floatspervec, int32_t & numknots, float *& knotvector) [pure virtual]
Return points and knotvector of the state.

Implemented in SoNurbsProfile, and SoLinearProfile.

  void SoProfile::getVertices (SoState * state, int32_t & numvertices, SbVec2f *& vertices) [pure virtual]
Return vertex set of state.

Implemented in SoNurbsProfile, and SoLinearProfile.

Member Data Documentation

  SoMFInt32 SoProfile::index
Profile coordinate indices.

These must match what is available from previous SoProfileCoordinate2 and SoProfileCoordinate3 nodes in the traversal.

  SoSFEnum SoProfile::linkage
How the indices of this profile node should be combined with the current profile index set of the traversal state.

Default value is SoProfile::START_FIRST.

Author

Generated automatically by Doxygen for Coin from the source code.