Coin: SoCache.h Source File

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

SoCache.h
1#ifndef COIN_SOCACHE_H
2#define COIN_SOCACHE_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
36class SoState;
37class SoElement;
38class SoCacheP;
39
40#include <Inventor/SbBasic.h>
41#include <cstddef> // for NULL
42
43 class COIN_DLL_API SoCache {
44public:
45 SoCache(SoState * const state);
46
47 void ref(void);
48 void unref(SoState * state = NULL);
49
50 void addElement(const SoElement * const elem);
51
52 virtual void addCacheDependency(const SoState * state,
53 SoCache * cache);
54 virtual SbBool isValid(const SoState * state) const;
55 const SoElement * getInvalidElement(const SoState * const state) const;
56 void invalidate(void);
57
58protected:
59 virtual void destroy(SoState * state);
60 virtual ~SoCache();
61
62private:
63 SoCacheP * pimpl;
64};
65
66#endif // !COIN_SOCACHE_H
SoCache::unref
void unref(SoState *state=NULL)
Definition SoCache.cpp:200
SoCache::SoCache
SoCache(SoState *const state)
Definition SoCache.cpp:153
SoCache::invalidate
void invalidate(void)
Definition SoCache.cpp:297
SoCache::ref
void ref(void)
Definition SoCache.cpp:189
SoCache::isValid
virtual SbBool isValid(const SoState *state) const
Definition SoCache.cpp:257
SoCache::addCacheDependency
virtual void addCacheDependency(const SoState *state, SoCache *cache)
Definition SoCache.cpp:240
SoCache::addElement
void addElement(const SoElement *const elem)
Definition SoCache.cpp:215
SoCache::destroy
virtual void destroy(SoState *state)
Definition SoCache.cpp:307
SoCache::getInvalidElement
const SoElement * getInvalidElement(const SoState *const state) const
Definition SoCache.cpp:269
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