RAS_IRenderTools.h

Go to the documentation of this file.

/*
 * $Id: RAS_IRenderTools.h 35072 2011-02-22 12:42:55Z jesterking $
 *
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program 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.
 *
 * This program 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 this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef __RAS_IRENDERTOOLS
#define __RAS_IRENDERTOOLS

#include "MT_Transform.h"
#include "RAS_IRasterizer.h"
#include "RAS_2DFilterManager.h"

#include <vector>
#include <algorithm>

#ifdef WITH_CXX_GUARDEDALLOC
#include "MEM_guardedalloc.h"
#endif

class           RAS_IPolyMaterial;
struct          RAS_LightObject;


class RAS_IRenderTools
{

protected:
        void*   m_clientobject;
        void*   m_auxilaryClientInfo;

        std::vector<struct      RAS_LightObject*> m_lights;
        
        RAS_2DFilterManager m_filtermanager;

public:
        enum RAS_TEXT_RENDER_MODE {
                RAS_TEXT_RENDER_NODEF = 0,
                RAS_TEXT_NORMAL,
                RAS_TEXT_PADDED,
                RAS_TEXT_MAX
        };

        RAS_IRenderTools(
        ) :
                m_clientobject(NULL)
        {
        };

        virtual 
        ~RAS_IRenderTools(
        ) {};

        virtual 
                void    
        BeginFrame(
                RAS_IRasterizer* rasty
        )=0;

        virtual 
                void    
        EndFrame(
                RAS_IRasterizer* rasty
        )=0;

        // the following function was formerly called 'Render'
        // by it doesn't render anymore
        // It only sets the transform for the rasterizer
        // so must be renamed to 'applyTransform' or something

        virtual 
                void    
        applyTransform(
                class RAS_IRasterizer* rasty,
                double* oglmatrix,
                int drawingmode
        )=0;

        virtual 
                void    
        RenderText3D(int fontid,
                                 const char* text,
                                 int size,
                                 int dpi,
                                 float* color,
                                 double* mat,
                                 float aspect
        ) = 0;


        virtual 
                void    
        RenderText2D(
                RAS_TEXT_RENDER_MODE mode,
                const char* text,
                int xco,
                int yco,
                int width,
                int height
        ) = 0;

        // 3d text, mapped on polygon
        virtual 
                void    
        RenderText(
                int mode,
                RAS_IPolyMaterial* polymat,
                float v1[3],
                float v2[3],
                float v3[3],
                float v4[3],
                int glattrib
        )=0;

        virtual 
                void            
        ProcessLighting(
                RAS_IRasterizer *rasty,
                bool uselights,
                const MT_Transform& trans
        )=0;

        virtual
                void    
        SetClientObject(
                RAS_IRasterizer* rasty,
                void* obj
        );

                void    
        SetAuxilaryClientInfo(
                void* inf
        );

        virtual 
                void    
        PushMatrix(
        )=0;

        virtual 
                void    
        PopMatrix(
        )=0;

        virtual 
                void            
        AddLight(
                struct  RAS_LightObject* lightobject
        );

        virtual 
                void            
        RemoveLight(
                struct RAS_LightObject* lightobject
        );

        virtual
                void
        MotionBlur(RAS_IRasterizer* rasterizer)=0;
                
                
#ifdef WITH_CXX_GUARDEDALLOC
public:
        void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:RAS_IRenderTools"); }
        void operator delete( void *mem ) { MEM_freeN(mem); }
#endif
};

#endif //__RAS_IRENDERTOOLS