Open Inventor Reference
SoCache.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (C) 2000 Silicon Graphics, Inc. All Rights Reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * Further, this software is distributed without any warranty that it is
16  * free of the rightful claim of any third person regarding infringement
17  * or the like. Any license provided herein, whether implied or
18  * otherwise, applies only to this software file. Patent licenses, if
19  * any, provided herein do not apply to combinations of this program with
20  * other software, or any other product whatsoever.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with this library; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25  *
26  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
27  * Mountain View, CA 94043, or:
28  *
29  * http://www.sgi.com
30  *
31  * For further information regarding this notice, see:
32  *
33  * http://oss.sgi.com/projects/GenInfo/NoticeExplan/
34  *
35  */
36 
37 
38 /*
39  * Copyright (C) 1990,91 Silicon Graphics, Inc.
40  *
41  _______________________________________________________________________
42  ______________ S I L I C O N G R A P H I C S I N C . ____________
43  |
44  | $Revision: 1.1.1.1 $
45  |
46  | Description:
47  | This file defines the abstract SoCache class, the base class
48  | for all caches in Inventor.
49  |
50  | Author(s) : Paul S. Strauss
51  |
52  ______________ S I L I C O N G R A P H I C S I N C . ____________
53  _______________________________________________________________________
54  */
55 
56 #ifndef _SO_CACHE
57 #define _SO_CACHE
58 
77 
78 #include <Inventor/SoLists.h>
79 
80 class SoElement;
81 class SoState;
82 
84 
85  public:
86 
90  SoCache(SoState *state);
91 
93  void ref();
94  void unref(SoState *state = NULL);
95 
97  void addElement(const SoElement *elt);
98 
102  virtual void addCacheDependency(const SoState *state,
103  SoCache *cache);
104 
106  virtual bool isValid(const SoState *state) const;
107 
112  const SoElement * getInvalidElement(const SoState *state) const;
113 
115  void invalidate();
116 
117  protected:
122  virtual void destroy(SoState *state);
123 
125  virtual ~SoCache();
126 
127  private:
128  SbPList elementsUsed;
129  unsigned char *elementsUsedFlags;
130 
131  int refCount;
132  int invalidated;
133  int depth;
134 };
135 
136 #endif /* _SO_CACHE */
#define SoEXTENDER
Provide inline template functions for abs, swap, min, max, and clamp.
Definition: SbBasic.h:154
#define INVENTOR_API
Disable some annoying warnings on MSVC 6.
Definition: SbSystem.h:81
List of generic (void *) pointers.
Definition: SbPList.h:78
virtual void destroy(SoState *state)
Subclasses can use this to clean up just before they are deleted.
const SoElement * getInvalidElement(const SoState *state) const
Assuming isValid() returns FALSE, this will return the first element that is invalid (auto-caching us...
void unref(SoState *state=NULL)
void ref()
Reference/unreference.
void addElement(const SoElement *elt)
Adds an element to elements-used list if not already there.
void invalidate()
Make this cache invalid.
virtual void addCacheDependency(const SoState *state, SoCache *cache)
Adds a dependency of this instance on another cache instance.
virtual ~SoCache()
Destructor.
virtual bool isValid(const SoState *state) const
Returns TRUE if cache is valid with respect to the given state.
SoCache(SoState *state)
Constructor.
This is the abstract base class for all state elements.
Definition: SoElement.h:96
An SoState collects and holds state while traversing a scene graph.
Definition: SoState.h:82