NAME

       SoCacheElement -

       The SoCacheElement class stores and manages the open caches.

SYNOPSIS

       #include <Inventor/elements/SoCacheElement.h>

       Inherits SoElement.

   Public Member Functions
       virtual void init (SoState *state)
       virtual void push (SoState *state)
       virtual void pop (SoState *state, const SoElement *prevTopElement)
       SoCache * getCache (void) const
       virtual SbBool matches (const SoElement *element) const
       virtual SoElement * copyMatchInfo (void) const
       SoCacheElement * getNextCacheElement (void) const

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static int getClassStackIndex (void)
       static void * createInstance (void)
       static void initClass (void)
       static void set (SoState *const state, SoCache *const cache)
       static SbBool anyOpen (SoState *const state)
       static void invalidate (SoState *const state)
       static void addElement (SoState *const state, const SoElement *const element)
       static void addCacheDependency (SoState *const state, SoCache *const cache)
       static SbBool setInvalid (const SbBool newvalue)
       static SoCache * getCurrentCache (SoState *const state)

   Protected Member Functions
       virtual ~SoCacheElement ()

   Additional Inherited Members

Detailed Description

       The SoCacheElement class stores and manages the open caches.

Constructor & Destructor Documentation

   SoCacheElement::~SoCacheElement (void) [protected],  [virtual]
       The destructor.

Member Function Documentation

   void * SoCacheElement::createInstance (void) [static]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

   void SoCacheElement::init (SoState *state) [virtual]
       This function initializes the element type in the given SoState. It is called for the
       first element of each enabled element type in SoState objects.

       Reimplemented from SoElement.

   void SoCacheElement::push (SoState *state) [virtual]
       This method is called every time a new element is required in one of the stacks. This
       happens when a writable element is requested, using SoState::getElement() or indirectly
       SoElement::getElement(), and the depth of the current element is less than the state
       depth.

       Override this method if your element needs to copy data from the previous top of stack.
       The push() method is called on the new element, and the previous element can be found
       using SoElement::getNextInStack().

       Reimplemented from SoElement.

   void SoCacheElement::pop (SoState *state, const SoElement *prevTopElement) [virtual]
       This method is callled when the state is popped, and the depth of the element is bigger
       than the current state depth. pop() is called on the new top of stack, and a pointer to
       the previous top of stack is passed in prevTopElement.

       Override this method if you need to copy some state information from the previous top of
       stack.

       Reimplemented from SoElement.

   void SoCacheElement::set (SoState *conststate, SoCache *constcache) [static]
       Sets the current cache. The cache is ref'ed before returning.

   SoCache * SoCacheElement::getCache (void) const
       This method returns the cache, or NULL if there is no cache.

   SbBool SoCacheElement::anyOpen (SoState *conststate) [static]
       This method returns TRUE if a cache is currently open.

   void SoCacheElement::invalidate (SoState *conststate) [static]
       This method invalidates open caches. It should be called by uncacheable nodes.

   SbBool SoCacheElement::matches (const SoElement *element) const [virtual]
       SoCacheElement objects should not be compared because you obviously don't cache them in
       the cache.

       Implements SoElement.

   SoElement * SoCacheElement::copyMatchInfo (void) const [virtual]
       SoCacheElement objects should not be 'copied' because you obviously don't cache them in
       the cache.

       See Also:
           SbBool SoCacheElement::matches(const SoElement * element) const

       Implements SoElement.

   SoCacheElement * SoCacheElement::getNextCacheElement (void) const
       This method returns the next cache element. That is the next cache element pointing
       towards the bottom of the state.

   void SoCacheElement::addElement (SoState *conststate, const SoElement *constelement) [static]
       This method adds element to the elements used lists of all the open caches in state.

   void SoCacheElement::addCacheDependency (SoState *conststate, SoCache *constcache) [static]
       This method creates dependencies on cache for all the open caches in state.

   SbBool SoCacheElement::setInvalid (const SbBoolnewvalue) [static]
       This method returns the old invalidated bit value, and sets it to newvalue.

   SoCache * SoCacheElement::getCurrentCache (SoState *conststate) [static]
       This method returns the current cache. No cache dependencies are honored.

Author

       Generated automatically by Doxygen for Coin from the source code.