OSDLRenderer.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2003-2009 Olivier Boudeville
 *
 * This file is part of the OSDL library.
 *
 * The OSDL library is free software: you can redistribute it and/or modify
 * it under the terms of either the GNU Lesser General Public License or
 * the GNU General Public License, as they are published by the Free Software
 * Foundation, either version 3 of these Licenses, or (at your option) 
 * any later version.
 *
 * The OSDL 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 and the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License and of the GNU General Public License along with the OSDL library.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Olivier Boudeville (olivier.boudeville@esperide.com)
 *
 */


#ifndef OSDL_RENDERER_H_
#define OSDL_RENDERER_H_


#include "OSDLEvents.h"               // for RenderingTick

#include "OSDLException.h"            // for Exception

#include "Ceylan.h"                   // for inheritance

#include <string>




namespace OSDL
{



    namespace Rendering 
    {
    
        
                
        class OSDL_DLL RenderingException : public OSDL::Exception
        {
            public:

                explicit RenderingException( const std::string & reason ) ;
                
                virtual ~RenderingException() throw() ;

        } ;



        
        typedef Ceylan::Uint32 RenderCount ;        
                
        
                
                
        class OSDL_DLL Renderer : public Ceylan::Object
        {
        
        
        
            public:
            
            
            
                explicit Renderer( bool registerToScheduler = true ) ;
                
                
                
                virtual ~Renderer() throw() ;
            
            

                virtual void render( 
                    Events::RenderingTick currentRenderingTick = 0 ) ;

                
                
                virtual void onRenderingSkipped( 
                    Events::RenderingTick skippedRenderingTick ) ;
                
                
                    
                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const ;





                // Static section.



                static bool HasExistingRootRenderer() ;
                 
                 
                 
                static Renderer & GetExistingRootRenderer() ;



                static void DeleteExistingRootRenderer() ;
        
        
        
                static void DeleteRootRenderer() ;
                    
        
        
                    
                    
            protected:
            
            

                RenderCount _renderingDone ;
        
        
        
                RenderCount _renderingSkipped ;
        
        
        
                Events::RenderingTick _lastRender ;
        


                // No data structure enforced for views here.

                 
                 
            
            private:
            
            
                explicit Renderer( const Renderer & source ) ;
            
            
            
                Renderer & operator = ( const Renderer & source ) ;
                
                
                
                static Renderer * _internalRootRenderer ;
                
                
        } ;
        

    }

}



#endif // OSDL_RENDERER_H_

---