gzLod.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzLod.h
// Module       : 
// Description  : Class definition of the gzLod class
// 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  990516  Created file 
// AMO  011004  Added access to LOD levels array    
//
//******************************************************************************
#ifndef __GZ_LOD_H__
#define __GZ_LOD_H__

#include "gzGroup.h"
#include "gzNodeAction.h"


class gzLodLevel
{
public:
    gzLodLevel():m_near_distance(0),m_far_distance(GZ_REAL_MAX),m_near_fade_distance(0),m_far_fade_distance(0),m_enabled(TRUE),m_lodEnableMask(0),m_lodDisableMask(0){};

    //Destructor
    virtual ~gzLodLevel(){};

    gzReal      m_near_distance;
    gzReal      m_far_distance;
    gzReal      m_near_fade_distance;
    gzReal      m_far_fade_distance;
    gzULong     m_lodEnableMask;
    gzULong     m_lodDisableMask;
    gzBool      m_enabled:1;
};

//******************************************************************************
// Class    : gzLod
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  990516  Created 
//                                  
//******************************************************************************
class gzLod : public gzGroup
{
public:

    GZ_GRAPH_EXPORT gzLod(const gzString & name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzLod(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface


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

    // ---------- gzLod commands ----------------------------------------


    GZ_GRAPH_EXPORT gzVoid setLOD(gzULong index , gzBool enable , gzReal near_dist = 0 , gzReal far_dist = 1, gzReal near_fade=0 , gzReal far_fade=-1);
    GZ_GRAPH_EXPORT gzVoid getLOD(gzULong index , gzBool *enable=NULL , gzReal *near_dist=NULL , gzReal *far_dist=NULL , gzReal *near_fade=NULL , gzReal *far_fade=NULL) const;

    GZ_GRAPH_EXPORT gzVoid setFadeDistance(gzULong index , gzReal near_fade,gzReal far_fade=-1);

    GZ_GRAPH_EXPORT gzVoid  useForceLodEnableMask(gzULong index , gzULong lodMask);
    GZ_GRAPH_EXPORT gzULong useForceLodEnableMask(gzULong index) const;

    GZ_GRAPH_EXPORT gzVoid  useForceLodDisableMask(gzULong index , gzULong lodMask);
    GZ_GRAPH_EXPORT gzULong useForceLodDisableMask(gzULong index) const;


    GZ_GRAPH_EXPORT gzVoid setCenter(const gzVec3 &center);

    GZ_GRAPH_EXPORT const gzVec3& getCenter() const;


    GZ_GRAPH_EXPORT gzVoid setCenter(gzReal x , gzReal y , gzReal z);


    GZ_GRAPH_EXPORT gzVoid useLevels(gzBool on);

    GZ_GRAPH_EXPORT gzBool useLevels() const;

    GZ_GRAPH_EXPORT gzDynamicArray<gzLodLevel> & getLevels();

    GZ_GRAPH_EXPORT static gzVoid setLodFactor( gzContext *context , gzFloat factor );

    GZ_GRAPH_EXPORT static gzVoid setGenericFadeDistance( gzContext *context , gzReal fade );

    GZ_GRAPH_EXPORT static gzVoid setForceLodMask( gzContext *context , gzULong lodMask);

    // ----------- gzGroup interface ------------------------------------

    GZ_GRAPH_EXPORT virtual gzBool  isChildOrderDependant();

    // ---------- Action Interface --------------------------------------
    GZ_GRAPH_EXPORT virtual gzBool isTraversable( gzTraverseAction *action , gzNode *node , gzULong index, gzContext *context);
    GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzTraverseAction *actionclass , gzContext *context);
    GZ_GRAPH_EXPORT virtual gzVoid postTraverseAction( gzTraverseAction *actionclass , gzContext *context);

    // ---------- Debug Inteface ----------------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid debugOutput(gzString base , gzString anchor , gzDebugFlags features);

private:
    
    mutable gzDynamicArray<gzLodLevel>  m_levels;
    gzVec3                              m_center;

    gzRefPointer<gzState>       m_transparencyState;

    gzUByte                     m_useLevels:1;
    gzUByte                     m_useFading:1;
};

// Declare smart pointer type
GZ_DECLARE_REFPTR(gzLod);


class gzLodForceAction : public gzNodeAction 
{
public:

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    GZ_GRAPH_EXPORT gzLodForceAction(const gzString & name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzLodForceAction(){};

    GZ_GRAPH_EXPORT virtual gzVoid onAction(gzNodeActionEvent action , gzContext *context , gzNodeActionProvider *trigger ,gzTraverseAction *actionclass ,gzVoid *userdata);

    GZ_GRAPH_EXPORT gzVoid  setForceLodMask(gzULong mask);

    //---------------- Generic action interface ----------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid attach(gzNode *node);
    GZ_GRAPH_EXPORT virtual gzVoid deattach(gzNode *node);

private:

    gzULong m_forceLodMask;

};

#endif

---