gzEnvironment.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzEnvironment.h
// Module       : 
// Description  : Class definition of the gzEnvironment classes
// 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  990312  Created file    
//
//******************************************************************************
#ifndef __GZ_ENVIRONMENT_H__
#define __GZ_ENVIRONMENT_H__

#include "gzGroup.h"
#include "gzLight.h"
#include "gzClipPlane.h"

enum gzFogMode
{
    GZ_FOG_MODE_EXP     =GZ_EXP,
    GZ_FOG_MODE_EXP2    =GZ_EXP2,
    GZ_FOG_MODE_LINEAR  =GZ_LINEAR
};

//******************************************************************************
// Class    : gzFogInfo
//                                  
// Purpose  : Hold information about the fog.
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  990312  Created 
//                                  
//******************************************************************************
class gzFogInfo
{
public:
    GZ_GRAPH_EXPORT gzFogInfo();

private:

    gzVoid activate(gzContext *context);

    static gzVoid deactivate(gzContext *context);

    friend class gzEnvironment;

    gzBool      enabled;
    gzFogMode   mode;
    gzRGBA      color;
    gzFloat     density;
    gzFloat     start;
    gzFloat     end;
};

//******************************************************************************
// Class    : gzEnvironment
//                                  
// Purpose  : An environment that hold lights, clipplanes etc.
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  990312  Created 
//                                  
//******************************************************************************

class gzEnvironment : public gzGroup    
{
public:

    GZ_GRAPH_EXPORT gzEnvironment(const gzString & name=GZ_EMPTY_STRING):gzGroup(name){};

    GZ_GRAPH_EXPORT virtual ~gzEnvironment(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

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

    // ---------- Action Interface --------------------------------------
    GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzTraverseAction *actionclass , gzContext *context);

    GZ_GRAPH_EXPORT virtual gzVoid postTraverseAction( gzTraverseAction *actionclass , gzContext *context);

    // ---------- Light Management interface ----------------------------

    GZ_GRAPH_EXPORT static gzVoid resetLightStateIndex(gzContext *context );
    GZ_GRAPH_EXPORT static gzVoid invalidateActiveLightState(gzContext *context );
    GZ_GRAPH_EXPORT static gzVoid activateLightStateIndex(gzContext *context ,gzULong index);
    GZ_GRAPH_EXPORT static gzVoid setMainLightState(gzContext *context);


    GZ_GRAPH_EXPORT gzVoid  addLight( gzLight *light);
    

    GZ_GRAPH_EXPORT gzVoid  removeLight( gzLight *light);
    
    GZ_GRAPH_EXPORT gzULong getNumberOfLights();


    GZ_GRAPH_EXPORT gzLight *getLight(gzULong lightIndex);


    // ---------- Clip Management interface ----------------------------

    GZ_GRAPH_EXPORT static gzVoid resetClipStateIndex(gzContext *context );
    GZ_GRAPH_EXPORT static gzVoid activateClipStateIndex(gzContext *context , gzULong index);


    GZ_GRAPH_EXPORT gzVoid addClipPlane(gzClip *clip);


    GZ_GRAPH_EXPORT gzVoid removeClipPlane(gzClip *clip);

    GZ_GRAPH_EXPORT gzULong getNumberOfClipPlanes();


    GZ_GRAPH_EXPORT gzClip *getClipPlane(gzULong clipIndex);

    // ---------- Fog interface ----------------------------------------

    GZ_GRAPH_EXPORT static gzVoid resetFogStateIndex(gzContext *context);
    GZ_GRAPH_EXPORT static gzVoid activateFogStateIndex(gzContext *context , gzULong index);


    GZ_GRAPH_EXPORT gzVoid useFog( gzBool enable );


    GZ_GRAPH_EXPORT gzVoid setFogMode( gzFogMode mode );

    GZ_GRAPH_EXPORT gzVoid setFogColor( const gzRGBA &color );

    GZ_GRAPH_EXPORT gzVoid setFogDensity( gzFloat density );

    GZ_GRAPH_EXPORT gzVoid setFogStart( gzFloat start );

    GZ_GRAPH_EXPORT gzVoid setFogEnd( gzFloat end );


    // ---------- generic environment, immediate activation ------------

    GZ_GRAPH_EXPORT static gzVoid setLightModel(gzContext *context);
    
    GZ_GRAPH_EXPORT static gzVoid setTwoSideLighting(gzContext *context , gzBool on);
    GZ_GRAPH_EXPORT static gzVoid setLocalViewer(gzContext *context,gzBool on);

    GZ_GRAPH_EXPORT static gzVoid setGlobalAmbientColor(gzContext *context , gzFloat red=0.2f , gzFloat green=0.2f, gzFloat blue=0.2f , gzFloat alpha=1.0f );

private:

    gzLightState        m_lightState;

    gzClipState         m_clipState;

    gzFogInfo           m_fogInfo;
};

// Declare smart pointer type
GZ_DECLARE_REFPTR(gzEnvironment);

#endif

---