Coin Logo http://www.sim.no/
http://www.coin3d.org/

SoCacheElement Class Reference
[Element Classes]

The SoCacheElement class stores and manages the open caches. More...

#include <Inventor/elements/SoCacheElement.h>

Inheritance diagram for SoCacheElement:

SoElement

List of all members.

Public Member Functions

virtual void init (SoState *state)
virtual void push (SoState *state)
virtual void pop (SoState *state, const SoElement *prevTopElement)
SoCachegetCache (void) const
virtual SbBool matches (const SoElement *element) const
virtual SoElementcopyMatchInfo (void) const
SoCacheElementgetNextCacheElement (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 SoCachegetCurrentCache (SoState *const state)

Protected Member Functions

virtual ~SoCacheElement ()


Detailed Description

The SoCacheElement class stores and manages the open caches.

Constructor & Destructor Documentation

SoCacheElement::~SoCacheElement ( void   )  [protected, virtual]

The destructor.


Member Function Documentation

SoType SoCacheElement::getClassTypeId ( void   )  [static]

This static method returns the class type.

Reimplemented from SoElement.

int SoCacheElement::getClassStackIndex ( void   )  [static]

This static method returns the state stack index for the class.

Reimplemented from SoElement.

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::initClass ( void   )  [static]

Initialize relevant common data for all instances, like the type system.

Reimplemented from SoElement.

void SoCacheElement::set ( SoState *const   state,
SoCache *const   cache 
) [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 *const   state  )  [static]

This method returns TRUE if a cache is currently open.

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

This method invalidates open caches. It should be called by uncacheable nodes.

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 *const   state,
const SoElement *const   element 
) [static]

This method adds element to the elements used lists of all the open caches in state.

void SoCacheElement::addCacheDependency ( SoState *const   state,
SoCache *const   cache 
) [static]

This method creates dependencies on cache for all the open caches in state.

SbBool SoCacheElement::setInvalid ( const SbBool  newvalue  )  [static]

This method returns the old invalidated bit value, and sets it to newvalue.

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

This method returns the current cache. No cache dependencies are honored.


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

Copyright © 1998-2009 by Kongsberg SIM. All rights reserved.

Generated on Mon Jun 15 11:58:29 2009 for Coin by Doxygen 1.5.9.