Coin: SoProfilerElement.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoProfilerElement.h
1#ifndef COIN_SOPROFILERELEMENT_H
2#define COIN_SOPROFILERELEMENT_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/elements/SoElement.h>
37#include <Inventor/elements/SoSubElement.h>
38
39#include <Inventor/annex/Profiler/SbProfilingData.h>
40
41// *************************************************************************
42
43 class COIN_DLL_API SoProfilerElement : public SoElement {
44 typedef SoElement inherited;
45 SO_ELEMENT_HEADER(SoProfilerElement);
46
47public:
48 static void initClass(void);
49
50 static SoProfilerElement * get(SoState * state);
51
52 virtual SbBool matches(const SoElement * element) const;
53 virtual SoElement * copyMatchInfo(void) const;
54
55 SbProfilingData & getProfilingData(void);
56 const SbProfilingData & getProfilingData(void) const;
57
58protected:
59 virtual ~SoProfilerElement(void);
60
61 SbProfilingData data;
62
63private:
64 virtual void push(SoState * state);
65 virtual void pop(SoState * state, const SoElement * elt);
66
67}; // SoProfilerElement
68
69#endif // !COIN_SOPROFILERELEMENT_H
SbProfilingData
Data structure for gathering scene graph traversal profiling information.
Definition SbProfilingData.h:52
SoElement
SoElement is the abstract base class for all elements.
Definition SoElement.h:43
SoElement::pop
virtual void pop(SoState *state, const SoElement *prevTopElement)
Definition SoElement.cpp:585
SoElement::matches
virtual SbBool matches(const SoElement *element) const =0
Definition SoElement.cpp:609
SoElement::initClass
static void initClass(void)
Definition SoElement.cpp:507
SoElement::copyMatchInfo
virtual SoElement * copyMatchInfo(void) const =0
SoElement::push
virtual void push(SoState *state)
Definition SoElement.cpp:570
SoProfilerElement
The SoProfilerElement element class is for registering statistics during scene graph traversals.
Definition SoProfilerElement.h:43
SoState
The SoState class manages the Coin scene graph traversal state data.
Definition SoState.h:44