Coin Logo http://www.coin3d.org/
http://www.kongsberg.com/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 <stdio.h>
38 #include <assert.h>
39 
40 class SoAction;
41 class SoTypeList;
42 class SoElement;
43 
44 class COIN_DLL_API SoState {
45 public:
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 
69 private:
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 
78 inline SbBool
79 SoState::isElementEnabled(const int stackindex) const
80 {
81  return (stackindex < this->numstacks) && (this->stack[stackindex] != NULL);
82 }
83 
84 inline const SoElement *
85 SoState::getConstElement(const int stackindex) const
86 {
87  assert(this->isElementEnabled(stackindex));
88  return this->stack[stackindex];
89 }
90 
91 inline SbBool
93 {
94  return this->cacheopen;
95 }
96 
97 inline SoElement *
98 SoState::getElementNoPush(const int stackindex) const
99 {
100  assert(this->isElementEnabled(stackindex));
101  return this->stack[stackindex];
102 }
103 
104 
105 #endif // !COIN_SOSTATE_H
SbBool isElementEnabled(const int stackindex) const
Definition: SoState.h:79
const SoElement * getConstElement(const int stackindex) const
Definition: SoState.h:85
SoElement is the abstract base class for all elements.
Definition: SoElement.h:43
The SoState class manages the Coin scenegraph traversal state data.The SoState class is used by actio...
Definition: SoState.h:44
The SoTypeList class is a container class for arrays of SoType objects.
Definition: SoTypeList.h:39
The SoAction class is the base class for all traversal actions.Applying actions is the basic mechanis...
Definition: SoAction.h:77
SbBool isCacheOpen(void) const
Definition: SoState.h:92

Copyright © by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated for Coin by Doxygen