NAME

       SoProfilerStats -

       The SoProfilerStats class is a node for exposing profiling results gathered by
       SoProfilerElement.

SYNOPSIS

       #include <Inventor/annex/Profiler/nodes/SoProfilerStats.h>

       Inherits SoNode.

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase.
           This is used for run-time type checking and 'downward' casting.
       SoProfilerStats (void)
       virtual void GLRender (SoGLRenderAction *action)
       virtual void handleEvent (SoHandleEventAction *action)
       virtual void rayPick (SoRayPickAction *action)
       virtual void getBoundingBox (SoGetBoundingBoxAction *action)
       virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
       virtual void audioRender (SoAudioRenderAction *action)
       virtual void callback (SoCallbackAction *action)
       virtual void getMatrix (SoGetMatrixAction *action)
       virtual void pick (SoPickAction *action)
       virtual void search (SoSearchAction *action)
       virtual void write (SoWriteAction *action)
       const SbProfilingData & getProfilingData (SoType actiontype) const

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

   Public Attributes
       SoMFName renderedNodeType
       SoMFTime renderingTimePerNodeType
       SoMFTime renderingTimeMaxPerNodeType
       SoMFUInt32 renderedNodeTypeCount
       SoMFName profiledAction
       SoMFTime profiledActionTime
       SoMFNode separatorsCullRoots
       SoSFTrigger profilingUpdate

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoProfilerStats ()
       virtual void notify (SoNotList *l)

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

   Additional Inherited Members

Detailed Description

       The SoProfilerStats class is a node for exposing profiling results gathered by
       SoProfilerElement.

       TODO: Describe functionality and provide usage example.

       See Also:
           SoProfilerElement

Constructor & Destructor Documentation

   SoProfilerStats::SoProfilerStats (void)
       Constructor

   SoProfilerStats::~SoProfilerStats () [protected],  [virtual]
       Destructor

Member Function Documentation

   SoType SoProfilerStats::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.

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

   void SoProfilerStats::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 SoProfilerStats::handleEvent (SoHandleEventAction *action) [virtual]
       Action method for SoHandleEventAction.

       Inspects the event data from action, and processes it if it is something which this node
       should react to.

       Nodes influencing relevant state variables for how event handling is done also overrides
       this method.

       Reimplemented from SoNode.

   void SoProfilerStats::rayPick (SoRayPickAction *action) [virtual]
       Action method for SoRayPickAction.

       Checks the ray specification of the action and tests for intersection with the data of the
       node.

       Nodes influencing relevant state variables for how picking is done also overrides this
       method.

       Reimplemented from SoNode.

   void SoProfilerStats::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 SoProfilerStats::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 SoProfilerStats::audioRender (SoAudioRenderAction *action) [virtual]
       Action method for SoAudioRenderAction.

       Does common processing for SoAudioRenderAction action instances.

       Reimplemented from SoNode.

   void SoProfilerStats::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 SoProfilerStats::getMatrix (SoGetMatrixAction *action) [virtual]
       Action method for SoGetMatrixAction.

       Updates action by accumulating with the transformation matrix of this node (if any).

       Reimplemented from SoNode.

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

       Does common processing for SoPickAction action instances.

       Reimplemented from SoNode.

   void SoProfilerStats::search (SoSearchAction *action) [virtual]
       Action method for SoSearchAction.

       Compares the search criteria from the action to see if this node is a match. Searching is
       done by matching up all criteria set up in the SoSearchAction -- if any of the requested
       criteria is a miss, the search is not deemed successful for the node.

       See Also:
           SoSearchAction

       Reimplemented from SoNode.

   void SoProfilerStats::write (SoWriteAction *action) [virtual]
       Action method for SoWriteAction.

       Writes out a node object, and any connected nodes, engines etc, if necessary.

       Reimplemented from SoNode.

   void SoProfilerStats::notify (SoNotList *l) [protected],  [virtual]
       Notifies all auditors for this instance when changes are made.

       Reimplemented from SoNode.

Author

       Generated automatically by Doxygen for Coin from the source code.