gzRoi.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzRoi.h
// Module       : 
// Description  : Class definition of the gzRoi 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  000503  Created file    
//
//******************************************************************************
#ifndef __GZ_ROI_H__
#define __GZ_ROI_H__

#include "gzTransform.h"
#include "gzDynamicLoader.h"
#include "gzSpatial.h"

// -------------------------- gzRoiDependancyInterface --------------------------------------------

class gzRoiDependancyInterface : public gzReference
{
public:
    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);

    GZ_GRAPH_EXPORT gzRoiDependancyInterface();
    GZ_GRAPH_EXPORT virtual ~gzRoiDependancyInterface();

    GZ_GRAPH_EXPORT virtual gzULong getDependancyMask()=0;
    GZ_GRAPH_EXPORT virtual gzVoid  setDependancy(gzBool on)=0;
};

class gzRoi; // Forward decl of roi node loader

// -------------------------- gzRoiNode ---------------------------------------------------------

class gzRoiNode : public gzTransform , public gzDynamicLoaderInfoInterface 
{
public:

    GZ_GRAPH_EXPORT gzVoid  setRoiPosition(const gzDoubleXYZ & position , gzBool origoAtRoiPosition=TRUE);

    // Implementation specific methods..

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

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    GZ_GRAPH_EXPORT virtual ~gzRoiNode();

    GZ_GRAPH_EXPORT virtual gzVoid onDynamicLoadState(gzDynamicLoadingState state,gzDynamicLoader *loader,gzNode *node);

    // Dependancy management

    GZ_GRAPH_EXPORT gzVoid  setDependacyManager(gzRoiDependancyInterface *manager);
    GZ_GRAPH_EXPORT gzRoiDependancyInterface * getDependacyManager();

private:

    friend class gzRoi;

    gzRoiNode(const gzString & name=GZ_EMPTY_STRING);

    gzDoubleXYZ                             m_position;

    gzDouble                                m_loadDistanceMag;
    gzDouble                                m_purgeDistanceMag;
    gzDouble                                m_loadDistance;
    gzDouble                                m_purgeDistance;

    gzRoi                                   *m_roiManager;

    gzDouble                                m_purgeMinTime;

    gzULong                                 m_pendingNodes;

    gzRefPointer<gzRoiDependancyInterface>  m_depManager;

    gzBool                                  m_origoAtRoiPosition;
};

// ----------------------- gzRoi ----------------------------------------------------------

class gzRoi : public gzTransform
{
public:

    GZ_GRAPH_EXPORT gzRoi(const gzString & name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzRoi();

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    // ---------- Roi interface -----------------------------------------

    GZ_GRAPH_EXPORT gzVoid setRoiPosition(const gzDoubleXYZ & position);

    GZ_GRAPH_EXPORT gzRoiNode *addRoiNode(const gzDoubleXYZ & position , const gzDouble & loadDistance , const gzDouble & purgeDistance , const gzString &url , gzBool origoAtRoiPosition=TRUE, const gzSerializeAdapterFlags & loadFlags=GZ_SERIALIZE_ADAPTER_FLAGS_DEFAULT , const gzReal & scale=0 , const gzReal & heading=0 , const gzReal & pitch=0 , const gzReal & roll=0 , const gzDouble &loadPriority=0.0);

    GZ_GRAPH_EXPORT gzVoid removeRoiNode(const gzDoubleXYZ & position , const gzString &url);

    GZ_GRAPH_EXPORT gzVoid removeRoiNode(gzRoiNode *node);

    GZ_GRAPH_EXPORT gzVoid setPurgeDelayTime(gzDouble seconds);

    GZ_GRAPH_EXPORT gzVoid setMinimumCheckDistance(gzDouble distance);

    GZ_GRAPH_EXPORT gzVoid loadAtPosition(gzContext *context,const gzDoubleXYZ & position,gzBool waitForLoad);

    GZ_GRAPH_EXPORT gzVoid useDistanceValues(gzBool useX , gzBool useY , gzBool useZ);

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

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



protected:

friend class gzRoiNode;

    GZ_GRAPH_EXPORT gzBool checkRoiNodeActivation(gzContext *context,const gzDoubleXYZ &position,gzRoiNode *node,gzBool waitForLoad,const gzDouble &time,gzMatrix4 *localMat=NULL);

    gzDoubleXYZ                             m_position;

    // Possibly we need to move these to context
    gzDoubleXYZ                             m_lastRoiPosition;
    gzDouble                                m_lastRoiCheckTime;

    gzDouble                                m_minCheckDistanceMag;
    gzDouble                                m_purgeDelay;

    gzBool                                  m_useX,m_useY,m_useZ;

    gzSpatialData<gzRefPointer<gzRoiNode> > m_spatialRepository;

    gzDouble                                m_currentInvLodFactorMag;

    gzMutex                                 m_nodeLocker;

};



#endif

---