H3DDisplayListObject.h

Go to the documentation of this file.

//    Copyright 2004-2019, 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 <GL/glew.h>
#include <H3D/H3DApi.h>
#include <H3D/Field.h>
#include <H3D/Instantiate.h>
#include <H3D/FieldTemplates.h>
#include <H3D/SFBool.h>
#include <H3D/SFTime.h>
 
namespace H3D {
  class GraphicsOptions;
 
  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;
 
      typedef CacheMode FrustumCullingMode;
        
      DisplayList();
 
      ~DisplayList() {
        if( display_list ) glDeleteLists( display_list, 1 );
      }
      
      void setCacheMode( CacheMode m  ) {
        cache_mode = m;
      }
 
      CacheMode getCacheMode( ) {
        return cache_mode;
      }
 
      void setFrustumCullingMode( FrustumCullingMode m  ) {
        frustum_culling_mode = m;
      }
 
      FrustumCullingMode getFrustumCullingMode( ) {
        return frustum_culling_mode;
      }
 
      virtual bool usingCaching();
 
      bool usingFrustumCulling();
 
      bool isOutsideViewFrustum();
 
      static void rebuildAllDisplayLists();
 
      virtual 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();
      }
 
#ifdef DEPRECATE_DISPLAYLIST_EVENT_COLLECT
#else
#endif
      template< class FieldType >
      inline bool hasCausedEvent( H3DUniquePtr< FieldType > &f ) {
        return hasCausedEvent( f.get() );
      }
            
      inline size_t nrPendingEvents() {
        return event_fields.size();
      }
 
      void initGraphicOption();
 
    protected:
      bool childrenCachesReady( bool consider_active_field );
 
      inline virtual bool haveValidDisplayList() {
        return have_valid_display_list;
      }
      
      bool tryBuildDisplayList( bool cache_broken ); 
 
    protected:
      set< Field * > event_fields;
 
        unsigned int delay_cache_counter;
 
      GLuint display_list;
 
      CacheMode cache_mode;
 
      FrustumCullingMode frustum_culling_mode;
      
      bool have_valid_display_list;
      
      H3DUniquePtr< IsActive > isActive;
 
      static H3DUniquePtr< Field > break_list_field; 
      
      GraphicsOptions* graphic_options_previous;
      
      static const int cache_delay_default = 3;
 
      bool reset_delay_cache_counter;
 
      friend class H3DDisplayListObject;
    };
    
    H3DDisplayListObject( Inst< DisplayList > _displayList = 0 );
    
    H3DUniquePtr< DisplayList > displayList;
 
  };
}
 
#endif