SoGLCacheList.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */
 
 
/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |      This file defines the SoGLCacheList class, which can be used
 |      is used by nodes like Separator to maintain a list of render
 |      caches that might be used.  It also implements an auto caching
 |      scheme that tries to be smart about only building caches when
 |      things are not changing.
 |
 |   Typical use:
 |      In a node's GLRender method:
 |         if (cacheList->call(state)) return;
 |         cacheList->open(state, TRUE);
 |         ... do normal children stuff...
 |         cacheList->close();
 |
 |     In a node's notify method:
 |         cacheList->invalidateAll();
 |
 |   Author(s)          : Gavin Bell
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
 
#ifndef  _SO_GL_CACHE_LIST
#define  _SO_GL_CACHE_LIST
 
#include <Inventor/SbBasic.h>
 
 
struct SoGLCacheListEntry;
class SoGLRenderAction;
class SoState;
class SoElement;
 
SoEXTENDER class INVENTOR_API SoGLCacheList {
    
  public:
    SoGLCacheList(int numCaches = 2);
 
    ~SoGLCacheList();
    
    bool call(SoGLRenderAction *);
    
    void open(SoGLRenderAction *, bool autoCache = TRUE);
 
    void close(SoGLRenderAction *);
    
    void invalidateAll();
    
  private:
    SoGLCacheListEntry *getLRU();
    void setMRU(SoGLCacheListEntry *e);
    void setLRU(SoGLCacheListEntry *e);
    void blow(SoState *, SoGLCacheListEntry *);
 
    SoGLCacheListEntry *MRU;
    int maxCaches, numCaches;
    SoGLCacheListEntry *openCache;
    int threshold;      
    int mightBeUsed;    
    SoElement *invalidElement;
    bool saveInvalid; 
    int saveACacheBits; 
 
};
 
 
#endif /* _SO_GL_CACHE_LIST */