Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoProfilerStats.h
1 #ifndef COIN_SOPROFILERSTATS_H
2 #define COIN_SOPROFILERSTATS_H
3 
4 /**************************************************************************\
5  * Copyright (c) Kongsberg Oil & Gas Technologies AS
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are
10  * met:
11  *
12  * Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in the
17  * documentation and/or other materials provided with the distribution.
18  *
19  * Neither the name of the copyright holder nor the names of its
20  * contributors may be used to endorse or promote products derived from
21  * this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 \**************************************************************************/
35 
36 #include <Inventor/fields/SoMFName.h>
37 #include <Inventor/fields/SoMFNode.h>
38 #include <Inventor/fields/SoMFTime.h>
39 #include <Inventor/fields/SoMFUInt32.h>
40 #include <Inventor/fields/SoSFTrigger.h>
41 #include <Inventor/nodes/SoSubNode.h>
42 #include <Inventor/tools/SbPimplPtr.h>
43 
44 class SbProfilingData;
45 class SoSeparator;
46 
47 class COIN_DLL_API SoProfilerStats : public SoNode {
48  typedef SoNode inherited;
49 
51 
52 public:
53  static void initClass(void);
54  SoProfilerStats(void);
55 
56  //fields for storing information on rendering time spent per node type
59  SoMFTime renderingTimeMaxPerNodeType;
60  SoMFUInt32 renderedNodeTypeCount;
61 
62  SoMFName profiledAction;
63  SoMFTime profiledActionTime;
64  SoMFNode separatorsCullRoots;
65 
66  SoSFTrigger profilingUpdate;
67 
68  // FIXME: below are suggestions for fields exposing future profiling
69  // functionality. -mortene.
70 
71  //fields for storing time spent rendering in each node in the scene graph
72  // SoMFNode renderedNode;
73  // SoMFTime renderingTimePerNode;
74 
75  //fields for storing time spent handling events in each node in the scene
76  //graph
77  // SoMFNode handlingNode;
78  // SoMFTime handlingTimePerNode;
79 
80  virtual void GLRender(SoGLRenderAction * action);
81  virtual void handleEvent(SoHandleEventAction * action);
82  virtual void rayPick(SoRayPickAction * action);
83  virtual void getBoundingBox(SoGetBoundingBoxAction * action);
84  virtual void getPrimitiveCount(SoGetPrimitiveCountAction * action);
85  virtual void audioRender(SoAudioRenderAction * action);
86 
87  virtual void callback(SoCallbackAction * action);
88  virtual void getMatrix(SoGetMatrixAction * action);
89  virtual void pick(SoPickAction * action);
90  virtual void search(SoSearchAction * action);
91  virtual void write(SoWriteAction * action);
92 
93  const SbProfilingData & getProfilingData(SoType actiontype) const;
94 
95 protected:
96  virtual ~SoProfilerStats();
97 
98  virtual void notify (SoNotList *l);
99 
100 private:
102 
103  SoProfilerStats(const SoProfilerStats & rhs);
104  SoProfilerStats & operator=(const SoProfilerStats & rhs);
105 
106 }; // SoProfilerStats
107 
108 #endif // !COIN_SOPROFILERSTATS_H
The SoRayPickAction class does ray intersection with scene graphs.
Definition: SoRayPickAction.h:50
virtual void notify(SoNotList *l)
Definition: SoNode.cpp:461
virtual void getPrimitiveCount(SoGetPrimitiveCountAction *action)
Definition: SoNode.cpp:894
SoMFTime renderingTimePerNodeType
Definition: SoProfilerStats.h:58
The SoGetMatrixAction class is an action for accumulating the transformation matrix of a subgraph...
Definition: SoGetMatrixAction.h:46
#define SO_NODE_HEADER(classname)
The SoSFTrigger class is the "void" class used for detecting field changes.
Definition: SoSFTrigger.h:41
The SoSearchAction class provides methods for searching through scene graphs.
Definition: SoSearchAction.h:44
virtual void search(SoSearchAction *action)
Definition: SoNode.cpp:1172
The SoPickAction class is the base class for picking actions.
Definition: SoPickAction.h:43
The SoNode class is the base class for nodes used in scene graphs.
Definition: SoNode.h:56
The SoProfilerStats class is a node for exposing profiling results gathered by SoProfilerElement.
Definition: SoProfilerStats.h:47
Data structure for gathering scene graph traversal profiling information.
Definition: SbProfilingData.h:52
virtual void rayPick(SoRayPickAction *action)
Definition: SoNode.cpp:1139
virtual void audioRender(SoAudioRenderAction *action)
Definition: SoNode.cpp:1307
virtual void getMatrix(SoGetMatrixAction *action)
Definition: SoNode.cpp:1053
The SoAudioRenderAction class renders the aural parts of the scene graph.
Definition: SoAudioRenderAction.h:42
virtual void pick(SoPickAction *action)
Definition: SoNode.cpp:1109
The SoMFNode class is a container for nodes.
Definition: SoMFNode.h:41
The SoMFUInt32 class is a container for 32-bit unsigned integer values.
Definition: SoMFUInt32.h:39
The SoHandleEventAction class distributes user events to the scene.
Definition: SoHandleEventAction.h:46
The SoGetPrimitiveCountAction class counts the primitives in a scene.
Definition: SoGetPrimitiveCountAction.h:44
The SoGetBoundingBoxAction class calculates bounding boxes for nodes and subgraphs.
Definition: SoGetBoundingBoxAction.h:45
SoMFName renderedNodeType
Definition: SoProfilerStats.h:57
The SoCallbackAction class invokes callbacks at specific nodes.
Definition: SoCallbackAction.h:80
The SoMFName class is a container for SbName values.
Definition: SoMFName.h:40
The SoWriteAction class writes a scene graph to file.
Definition: SoWriteAction.h:42
virtual void getBoundingBox(SoGetBoundingBoxAction *action)
Definition: SoNode.cpp:865
virtual void GLRender(SoGLRenderAction *action)
Definition: SoNode.cpp:954
The SoNotList class is a list of SoNotRec notification records.
Definition: SoNotification.h:43
The SoSeparator class is a state-preserving group node.
Definition: SoSeparator.h:44
The SoType class is the basis for the runtime type system in Coin.
Definition: SoType.h:59
virtual void write(SoWriteAction *action)
Definition: SoNode.cpp:1241
virtual void callback(SoCallbackAction *action)
Definition: SoNode.cpp:1026
The SoMFTime class is a container for SbTime values.
Definition: SoMFTime.h:40
virtual void handleEvent(SoHandleEventAction *action)
Definition: SoNode.cpp:1083
The SoGLRenderAction class renders the scene graph with OpenGL calls.
Definition: SoGLRenderAction.h:50