include/gdb/terModCbInfo.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2001 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: terModCbInfo.h,v $ $Revision: 1.4 $ $State: Exp $
*********************************************************************/

#ifndef terModCbInfo_H_
#define terModCbInfo_H_

#include "gdb/gdbDefines.h"
#include <vlutil/vlList.h>

class DtExtent;
class DtTerrainDatabase;

// Define the callback function format
typedef void (*DtTerrainModifiedCallbackFunction)(
   DtTerrainDatabase* terrain, const DtExtent& changedVolume, void* usrData);

// class DtTerrainModifiedCallbackInfo:
//
// Instances of DtTerrainModifiedCallbackInfo are used to save callback
// information for "terrain modified" callbacks from DtTerrainDatabase
// objects.

class DT_DLL_gdb DtTerrainModifiedCallbackInfo : public DtListedObj
{
public:

   // normal constructor
   DtTerrainModifiedCallbackInfo(DtTerrainModifiedCallbackFunction cb,
      void* userData);

   // default constructor
   DtTerrainModifiedCallbackInfo();

   // copy constructor
   DtTerrainModifiedCallbackInfo(const DtTerrainModifiedCallbackInfo& orig);

   // destructor
   virtual ~DtTerrainModifiedCallbackInfo();

   // assignment operator
   DtTerrainModifiedCallbackInfo& operator=(
      const DtTerrainModifiedCallbackInfo& orig);

   // equality operators
   int operator==(const DtTerrainModifiedCallbackInfo& orig) const;
   int operator!=(const DtTerrainModifiedCallbackInfo& orig) const;

   // Get callback function
   virtual DtTerrainModifiedCallbackFunction callbackFunction() const;
   // Set callback function
   virtual void setCallbackFunction(DtTerrainModifiedCallbackFunction arg);

   // Get user data
   virtual void* userData() const;
   // Set user data
   virtual void setUserData(void* arg);

protected:
   DtTerrainModifiedCallbackFunction myCallbackFunction;
   void* myUserData;
};

#endif