Open Inventor Reference
SoCacheElement Class Reference

Element that stores the most recently opened cache.

#include <Inventor/elements/SoCacheElement.h>

Inheritance diagram for SoCacheElement:
SoElement

List of all members.

Public Member Functions

virtual void init (SoState *state)
 Initializes element.
SoCachegetCache () const
 Returns the cache stored in an instance. This may be NULL.
virtual void pop (SoState *state, const SoElement *prevTopElement)
 Overrides this method to unref cache.
virtual SbBool matches (const SoElement *elt) const
 Overrides this method to print an error message and return FALSE.
virtual SoElementcopyMatchInfo () const
 Copy method prints error and returns NULL; see comment above.
SoCacheElementgetNextCacheElement () const
 Returns the next cache element in the stack.
virtual ~SoCacheElement ()

Static Public Member Functions

static void set (SoState *state, SoCache *cache)
 Sets cache in element accessed from state.
static SbBool anyOpen (SoState *state)
 Returns TRUE if any cache is currently open in the state.
static void invalidate (SoState *state)
 Invalidate any open caches.
static void initClass ()
 Initializes the SoCacheElement class.
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.
static void addCacheDependency (SoState *state, SoCache *cache)
 Adds a dependency on the given cache to all currently open caches in the state.
static SbBool setInvalid (SbBool newValue)
 Sets invalidated bit, and returns its old value.
static SoCachegetCurrentCache (SoState *state)
 returns the current cache, from the top of the stack.

Friends

class SoElement

Detailed Description

Definition at line 71 of file SoCacheElement.h.


Constructor & Destructor Documentation

virtual SoCacheElement::~SoCacheElement ( ) [virtual]

Member Function Documentation

static void SoCacheElement::addCacheDependency ( SoState state,
SoCache cache 
) [static]
static void SoCacheElement::addElement ( SoState state,
const SoElement elt 
) [static]
static SbBool SoCacheElement::anyOpen ( SoState state) [static]
virtual SoElement* SoCacheElement::copyMatchInfo ( ) const [virtual]

Implements SoElement.

SoCache* SoCacheElement::getCache ( ) const [inline]

Definition at line 83 of file SoCacheElement.h.

static SoCache* SoCacheElement::getCurrentCache ( SoState state) [inline, static]

Does not cause a cache dependence like getConstElement().

Definition at line 125 of file SoCacheElement.h.

References SoState::getElementNoPush().

SoCacheElement* SoCacheElement::getNextCacheElement ( ) const [inline]

Definition at line 104 of file SoCacheElement.h.

References SoElement::getNextInStack().

virtual void SoCacheElement::init ( SoState state) [virtual]

Reimplemented from SoElement.

static void SoCacheElement::initClass ( ) [static]

Reimplemented from SoElement.

static void SoCacheElement::invalidate ( SoState state) [static]

This is called by nodes that should not be cached.

virtual SbBool SoCacheElement::matches ( const SoElement elt) const [virtual]

Cache elements should never be compared, since they never appear in the elements-used list of caches!

Implements SoElement.

virtual void SoCacheElement::pop ( SoState state,
const SoElement prevTopElement 
) [virtual]

Reimplemented from SoElement.

static void SoCacheElement::set ( SoState state,
SoCache cache 
) [static]
static SbBool SoCacheElement::setInvalid ( SbBool  newValue) [static]

Used by SoGLCacheList so auto-caching doesn't cache too much.


Friends And Related Function Documentation

friend class SoElement [friend]

Definition at line 135 of file SoCacheElement.h.


The documentation for this class was generated from the following file: