SoProfilerStats.h
#ifndef COIN_SOPROFILERSTATS_H
#define COIN_SOPROFILERSTATS_H
/**************************************************************************\
* Copyright (c) Kongsberg Oil & Gas Technologies AS
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\**************************************************************************/
#include <Inventor/fields/SoMFName.h>
#include <Inventor/fields/SoMFNode.h>
#include <Inventor/fields/SoMFTime.h>
#include <Inventor/fields/SoMFUInt32.h>
#include <Inventor/fields/SoSFTrigger.h>
#include <Inventor/nodes/SoSubNode.h>
#include <Inventor/tools/SbPimplPtr.h>
class SbProfilingData;
class SoSeparator;
class COIN_DLL_API SoProfilerStats : public SoNode {
typedef SoNode inherited;
SO_NODE_HEADER(SoProfilerStats);
public:
static void initClass(void);
SoProfilerStats(void);
//fields for storing information on rendering time spent per node type
SoMFName renderedNodeType;
SoMFTime renderingTimePerNodeType;
SoMFTime renderingTimeMaxPerNodeType;
SoMFUInt32 renderedNodeTypeCount;
SoMFName profiledAction;
SoMFTime profiledActionTime;
SoMFNode separatorsCullRoots;
SoSFTrigger profilingUpdate;
// FIXME: below are suggestions for fields exposing future profiling
// functionality. -mortene.
//fields for storing time spent rendering in each node in the scene graph
// SoMFNode renderedNode;
// SoMFTime renderingTimePerNode;
//fields for storing time spent handling events in each node in the scene
//graph
// SoMFNode handlingNode;
// SoMFTime handlingTimePerNode;
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;
protected:
virtual ~SoProfilerStats();
virtual void notify (SoNotList *l);
private:
SbPimplPtr<class SoProfilerStatsP> pimpl;
SoProfilerStats(const SoProfilerStats & rhs);
SoProfilerStats & operator=(const SoProfilerStats & rhs);
}; // SoProfilerStats
#endif // !COIN_SOPROFILERSTATS_H
SbPimplPtr
Definition SbPimplPtr.h:55
SbProfilingData
Data structure for gathering scene graph traversal profiling information.
Definition SbProfilingData.h:52
SoAudioRenderAction
The SoAudioRenderAction class renders the aural parts of the scene graph.
Definition SoAudioRenderAction.h:42
SoCallbackAction
The SoCallbackAction class invokes callbacks at specific nodes.
Definition SoCallbackAction.h:80
SoGLRenderAction
The SoGLRenderAction class renders the scene graph with OpenGL calls.
Definition SoGLRenderAction.h:50
SoGetBoundingBoxAction
The SoGetBoundingBoxAction class calculates bounding boxes for nodes and subgraphs.
Definition SoGetBoundingBoxAction.h:45
SoGetMatrixAction
The SoGetMatrixAction class is an action for accumulating the transformation matrix of a subgraph.
Definition SoGetMatrixAction.h:46
SoGetPrimitiveCountAction
The SoGetPrimitiveCountAction class counts the primitives in a scene.
Definition SoGetPrimitiveCountAction.h:44
SoHandleEventAction
The SoHandleEventAction class distributes user events to the scene.
Definition SoHandleEventAction.h:46
SoMFName
The SoMFName class is a container for SbName values.
Definition SoMFName.h:40
SoMFNode
The SoMFNode class is a container for nodes.
Definition SoMFNode.h:41
SoMFTime
The SoMFTime class is a container for SbTime values.
Definition SoMFTime.h:40
SoMFUInt32
The SoMFUInt32 class is a container for 32-bit unsigned integer values.
Definition SoMFUInt32.h:39
SoNode::SoNode
SoNode(void)
Definition SoNode.cpp:417
SoNode::notify
virtual void notify(SoNotList *l)
Definition SoNode.cpp:506
SoNode::getPrimitiveCount
virtual void getPrimitiveCount(SoGetPrimitiveCountAction *action)
Definition SoNode.cpp:943
SoNode::handleEvent
virtual void handleEvent(SoHandleEventAction *action)
Definition SoNode.cpp:1132
SoNode::getBoundingBox
virtual void getBoundingBox(SoGetBoundingBoxAction *action)
Definition SoNode.cpp:914
SoNode::audioRender
virtual void audioRender(SoAudioRenderAction *action)
Definition SoNode.cpp:1356
SoNode::callback
virtual void callback(SoCallbackAction *action)
Definition SoNode.cpp:1075
SoNode::getMatrix
virtual void getMatrix(SoGetMatrixAction *action)
Definition SoNode.cpp:1102
SoNode::rayPick
virtual void rayPick(SoRayPickAction *action)
Definition SoNode.cpp:1188
SoNode::pick
virtual void pick(SoPickAction *action)
Definition SoNode.cpp:1158
SoNode::search
virtual void search(SoSearchAction *action)
Definition SoNode.cpp:1221
SoNode::write
virtual void write(SoWriteAction *action)
Definition SoNode.cpp:1290
SoNode::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoNode.cpp:573
SoNode::GLRender
virtual void GLRender(SoGLRenderAction *action)
Definition SoNode.cpp:1003
SoNotList
The SoNotList class is a list of SoNotRec notification records.
Definition SoNotification.h:43
SoPickAction
The SoPickAction class is the base class for picking actions.
Definition SoPickAction.h:43
SoProfilerStats::SoProfilerStats
SoProfilerStats(void)
Definition SoProfilerStats.cpp:368
SoProfilerStats::renderingTimePerNodeType
SoMFTime renderingTimePerNodeType
Definition SoProfilerStats.h:58
SoProfilerStats::renderedNodeType
SoMFName renderedNodeType
Definition SoProfilerStats.h:57
SoRayPickAction
The SoRayPickAction class does ray intersection with scene graphs.
Definition SoRayPickAction.h:50
SoSFTrigger
The SoSFTrigger class is the "void" class used for detecting field changes.
Definition SoSFTrigger.h:41
SoSearchAction
The SoSearchAction class provides methods for searching through scene graphs.
Definition SoSearchAction.h:44
SoSeparator
The SoSeparator class is a state-preserving group node.
Definition SoSeparator.h:44
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59
SoWriteAction
The SoWriteAction class writes a scene graph to file.
Definition SoWriteAction.h:42
SO_NODE_HEADER
#define SO_NODE_HEADER(classname)
Definition Coin_macros.dox:50