H3DDisplayListObject.h

Go to the documentation of this file.

//    Copyright 2004, SenseGraphics AB
//
//    This file is part of H3D API.
//
//    H3D API is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    H3D API 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 General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with H3D API; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//    A commercial license is also available. Please contact us at 
//    www.sensegraphics.com for more information.
//
//
//
#ifndef __H3DDISPLAYLISTOBJECT_H__
#define __H3DDISPLAYLISTOBJECT_H__

#include "H3DApi.h"
#include "Field.h"
#include "Instantiate.h"
#include "GL/glew.h"
#include "FieldTemplates.h"
#include "SFBool.h"
#include "SFTime.h"

#ifdef _MSC_VER
#pragma comment( lib, "OpenGL32.lib" )
#pragma comment( lib, "glu32.lib" )
#pragma comment( lib, "glew32.lib" )
#endif

namespace H3D {
  class H3DAPI_API H3DDisplayListObject {
  public:

    class H3DAPI_API DisplayList : public Field {
    protected:
      class IsActive: public AutoUpdate< TypedField< SFBool, SFTime > > {
        public:
        IsActive():
          active( true ) {}
        
        virtual void update() {
          value = active;
          active = false;
        }

        friend class DisplayList;

      protected:
        void callListCalled() {
          setValue( true );
          active = true;
        }
        bool active;
      };
      
    public:
      typedef enum {
        ON, 
        OFF,
        OPTIONS
      } CacheMode;
        
      DisplayList();

      ~DisplayList() {
        if( display_list ) glDeleteLists( display_list, 1 );
      }
      
      void setCacheMode( CacheMode m ) {
        cache_mode = m;
      }

      CacheMode setCacheMode( ) {
        return cache_mode;
      }

      bool usingCaching();

      unsigned int cachingDelay();

      void breakCache();

      virtual void update();
      
      virtual void propagateEvent( Event e );
      
      virtual void callList( bool build_list = true );

      inline Field *getEventPointer() {
        return event.ptr;
      }

      inline bool hasCausedEvent( Field *f ) {
        return event_fields.find( f ) != event_fields.end();
      }

      template< class FieldType >
      inline bool hasCausedEvent( auto_ptr< FieldType > &f ) {
        return hasCausedEvent( f.get() );
      }

    protected:
      bool childrenCachesReady( bool consider_active_field );

      inline bool haveValidDisplayList() {
        return have_valid_display_list;
      }
      
      bool tryBuildDisplayList( bool cache_broken ); 

    private:
      set< Field * > event_fields;

        unsigned int delay_cache_counter;

      GLuint display_list;

      CacheMode cache_mode;
      
      bool have_valid_display_list;
      
      auto_ptr< IsActive > isActive;

      friend class H3DDisplayListObject;
    };
    
    H3DDisplayListObject( Inst< DisplayList > _displayList = 0 );
    
    auto_ptr< DisplayList > displayList;
  };
}

#endif

---