Coin: SoState.h Source File

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

SoState.h
1#ifndef COIN_SOSTATE_H
2#define COIN_SOSTATE_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/SbBasic.h>
37#include <cstdio>
38#include <cassert>
39
40class SoAction;
41class SoTypeList;
42class SoElement;
43
44 class COIN_DLL_API SoState {
45public:
46 SoState(SoAction * action,
47 const SoTypeList & enabledelements);
48 ~SoState(void);
49
50 SoAction * getAction(void) const;
51
52 SoElement * getElement(const int stackindex);
53 const SoElement * getConstElement(const int stackindex) const;
54
55 void push(void);
56 void pop(void);
57
58 void print(FILE * const file = stdout) const;
59
60 SbBool isElementEnabled(const int stackindex) const;
61
62 int getDepth(void) const;
63
64 void setCacheOpen(const SbBool flag);
65 SbBool isCacheOpen(void) const;
66
67 SoElement * getElementNoPush(const int stackindex) const;
68
69private:
70 SoElement ** stack;
71 int numstacks;
72 SbBool cacheopen;
73 class SoStateP * pimpl;
74};
75
76// these methods are used very often, and is therefore inlined
77
78inline SbBool
79SoState::isElementEnabled(const int stackindex) const
80{
81 return (stackindex < this->numstacks) && (this->stack[stackindex] != NULL);
82}
83
84inline const SoElement *
85SoState::getConstElement(const int stackindex) const
86{
87 assert(this->isElementEnabled(stackindex));
88 return this->stack[stackindex];
89}
90
91inline SbBool
92SoState::isCacheOpen(void) const
93{
94 return this->cacheopen;
95}
96
97inline SoElement *
98SoState::getElementNoPush(const int stackindex) const
99{
100 assert(this->isElementEnabled(stackindex));
101 return this->stack[stackindex];
102}
103
104
105#endif // !COIN_SOSTATE_H
SoAction
The SoAction class is the base class for all traversal actions.
Definition SoAction.h:77
SoElement
SoElement is the abstract base class for all elements.
Definition SoElement.h:43
SoState
The SoState class manages the Coin scene graph traversal state data.
Definition SoState.h:44
SoState::isElementEnabled
SbBool isElementEnabled(const int stackindex) const
Definition SoState.h:79
SoState::isCacheOpen
SbBool isCacheOpen(void) const
Definition SoState.h:92
SoState::getConstElement
const SoElement * getConstElement(const int stackindex) const
Definition SoState.h:85
SoTypeList
The SoTypeList class is a container class for arrays of SoType objects.
Definition SoTypeList.h:39