Open Inventor Reference
SoCacheElement.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  | Classes:
47  | SoCacheElement
48  |
49  | Author(s) : Paul S. Strauss, Gavin Bell
50  |
51  ______________ S I L I C O N G R A P H I C S I N C . ____________
52  _______________________________________________________________________
53  */
54 
55 #ifndef _SO_CACHE_ELEMENT_
56 #define _SO_CACHE_ELEMENT_
57 
59 
60 class SoCache;
61 
70 
72 
74 
75  public:
77  virtual void init(SoState *state);
78 
80  static void set(SoState *state, SoCache *cache);
81 
83  SoCache * getCache() const { return cache; }
84 
86  static bool anyOpen(SoState *state);
87 
90  static void invalidate(SoState *state);
91 
93  virtual void pop(SoState *state, const SoElement *prevTopElement);
94 
98  virtual bool matches(const SoElement *elt) const;
99 
101  virtual SoElement *copyMatchInfo() const;
102 
105  { return (SoCacheElement *) getNextInStack(); }
106 
107  SoINTERNAL public:
109  static void initClass();
110 
113  static void addElement(SoState *state, const SoElement *elt);
114 
117  static void addCacheDependency(SoState *state, SoCache *cache);
118 
121  static bool setInvalid(bool newValue);
122 
125  static SoCache * getCurrentCache(SoState *state)
126  {return ((SoCacheElement*)(state->getElementNoPush(classStackIndex)))->cache;}
127 
128  virtual ~SoCacheElement();
129 
130  private:
131  SoCache *cache;
132 
133  static bool invalidated;
134 
135 friend class SoElement;
136 };
137 
138 #endif /* _SO_CACHE_ELEMENT_ */
#define SoEXTENDER
Provide inline template functions for abs, swap, min, max, and clamp.
Definition: SbBasic.h:154
#define SoINTERNAL
Definition: SbBasic.h:155
#define INVENTOR_API
Disable some annoying warnings on MSVC 6.
Definition: SbSystem.h:81
#define SO_ELEMENT_HEADER(className)
This one is for non-abstract element classes.
Definition: SoSubElement.h:112
Element that stores the most recently opened cache.
static void invalidate(SoState *state)
Invalidate any open caches.
static void initClass()
Initializes the SoCacheElement class.
virtual ~SoCacheElement()
static bool anyOpen(SoState *state)
Returns TRUE if any cache is currently open in the state.
SoCacheElement * getNextCacheElement() const
Returns the next cache element in the stack.
virtual void pop(SoState *state, const SoElement *prevTopElement)
Overrides this method to unref cache.
static void addElement(SoState *state, const SoElement *elt)
Adds the given element to the elements used lists of all currently open caches in the state.
SoCache * getCache() const
Returns the cache stored in an instance. This may be NULL.
static SoCache * getCurrentCache(SoState *state)
returns the current cache, from the top of the stack.
static bool setInvalid(bool newValue)
Sets invalidated bit, and returns its old value.
static void addCacheDependency(SoState *state, SoCache *cache)
Adds a dependency on the given cache to all currently open caches in the state.
static void set(SoState *state, SoCache *cache)
Sets cache in element accessed from state.
virtual bool matches(const SoElement *elt) const
Overrides this method to print an error message and return FALSE.
virtual void init(SoState *state)
Initializes element.
virtual SoElement * copyMatchInfo() const
Copy method prints error and returns NULL; see comment above.
This is the abstract base class for all state elements.
Definition: SoElement.h:96
SoElement * getNextInStack() const
Returns next instance in specific element stack.
Definition: SoElement.h:187
An SoState collects and holds state while traversing a scene graph.
Definition: SoState.h:82
SoElement * getElementNoPush(int stackIndex) const
Internal-only, dangerous method that returns a writeable element without checking for state depth and...
Definition: SoState.h:135