gzRenderBase.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzRenderBase.h
// Module       : 
// Description  : Class definition of the gzRenderBase class types
// Author       : Anders Modén      
// Product      : Gizmo3D 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden
//          
// NOTE:    Gizmo3D is a high performance 3D Scene Graph and effect visualisation 
//          C++ toolkit for Linux, Mac OS X, Windows (Win32) and IRIX® for  
//          usage in Game or VisSim development.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  000903  Created file    
//
//******************************************************************************
#ifndef __GZ_RENDER_BASE_H__
#define __GZ_RENDER_BASE_H__

#include "gzContext.h"
#include "gzCamera.h"

//******************************************************************************
// Class    : gzRenderBase
//                                  
// Purpose  : Base class for rendering of a scene graph to a target
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  990607  Created 
//                                  
//******************************************************************************
class gzRenderBase : public gzObject
{
public:

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    GZ_GRAPH_EXPORT gzRenderBase();

    GZ_GRAPH_EXPORT virtual ~gzRenderBase();

    GZ_GRAPH_EXPORT virtual gzVoid onPreRender(gzContext *context, gzULong size_x , gzULong size_y);
    GZ_GRAPH_EXPORT virtual gzVoid onPostRender(gzContext *context, gzULong size_x , gzULong size_y);
    GZ_GRAPH_EXPORT virtual gzVoid onInitContext(gzContext *context);

    GZ_GRAPH_EXPORT gzVoid      setBackground( gzFloat red , gzFloat green , gzFloat blue , gzFloat alpha=1.0f );
    GZ_GRAPH_EXPORT gzVec4      getBackground();

    GZ_GRAPH_EXPORT gzVoid      setClearDepth( gzFloat depth );

    GZ_GRAPH_EXPORT gzVoid      setDepthFunc( gzEnum func );

    GZ_GRAPH_EXPORT gzVoid      setContext( gzContext *context );
    GZ_GRAPH_EXPORT gzContext   *getContext() const;

    GZ_GRAPH_EXPORT gzVoid      setCamera( gzCamera *camera );
    GZ_GRAPH_EXPORT gzCamera    *getCamera() const;

    GZ_GRAPH_EXPORT virtual gzVoid render(gzContext *context, gzULong size_x,gzULong size_y,gzULong max_width);

    GZ_GRAPH_EXPORT gzDouble    getFrameRate();

    GZ_GRAPH_EXPORT gzVoid      setForcedRenderTime(const gzDouble &renderTime);

    GZ_GRAPH_EXPORT gzVoid      setViewportOffset(gzFloat x , gzFloat y);

    GZ_GRAPH_EXPORT gzVoid      setViewportScale(gzFloat sx , gzFloat sy);

    GZ_GRAPH_EXPORT gzVoid      useFinish(gzBool active=FALSE);

protected:

    gzDouble    m_lastFrameTime;
    gzULong     m_frameCount;
    gzDouble    m_frameRate;

    gzFloat                 m_backColor_red;
    gzFloat                 m_backColor_green;
    gzFloat                 m_backColor_blue; 
    gzFloat                 m_backColor_alpha;
    gzFloat                 m_clearDepth;

    gzFloat                 m_refreshRate;

    gzEnum                  m_depthFunc;

    gzFloatXY               m_viewportOffset;

    gzFloatXY               m_viewportScale;

    gzRefPointer<gzContext> m_context;

    //---------------- graph members ----------------------------

    gzRefPointer<gzCamera>  m_camera;

private:

    gzBool                  m_hasInitContext;

    gzBool                  m_useFinish;

    gzDouble                m_forceRenderTime;

};


//******************************************************************************
// Class    : gzImageRenderInterface
//                                  
// Purpose  : Base interface for image rendering
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  990607  Created 
//                                  
//******************************************************************************
class gzImageRenderInterface : public gzRenderBase
{
public:

    GZ_GRAPH_EXPORT gzImageRenderInterface(){};

    GZ_GRAPH_EXPORT ~gzImageRenderInterface(){};

    //--------- some virtual convenience callbacks -------------
    
    GZ_GRAPH_EXPORT virtual gzVoid  refreshImage()=0;

    GZ_GRAPH_EXPORT virtual gzVoid  setImage(gzImage *image)=0;

    GZ_GRAPH_EXPORT virtual gzImage *getImage()=0;

    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const=0;

    // ---------- Image rendering factory -------------------------------

    GZ_GRAPH_EXPORT static gzVoid   installFactory(gzImageRenderInterface *instance);

    GZ_GRAPH_EXPORT static gzVoid   unInstallFactory();

    GZ_GRAPH_EXPORT static gzBool   hasFactory();

    GZ_GRAPH_EXPORT static gzImageRenderInterface * getImageRender();

private:

    static gzRefPointer<gzImageRenderInterface> s_factoryInstance;

};


#endif // __GZ_RENDER_BASE_H__

---