paperMap.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2003 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: pprMap.h,v $ $Revision: 1.22 $ $State: Exp $
*******************************************************************************/

#ifndef PPRMAP_H
#define PPRMAP_H

#include "terrainDbFactory/terrainDbFactoryDefines.h"
#include <vlutil/vlString.h>

class DtPoint;
class DtDisplaySize;
class DtPaperMapRecord;
class Coordinate_System;
class DtExtent;
class DtFilename;
class QImage;
class QString;
class QColor;


// class DtPaperMap:
//
// Instances of this class are individual papermaps, loaded from a file in
// in some raster format.

class DT_DLL_terrainDbFactory DtPaperMap
{

public:

   enum DtCoordinateSystem
   {
      DtCSGeodetic,
      DtCSUtm,
      DtCSLcc,
      DtCSInvalid,
      DtCSFlatEarth,
      DtCSLast
   };

   enum AlphaMode
   {
      NoAlpha,
      AlphaMask,
      AlphaBlend
   };

   // default constructor.
   DtPaperMap();

   // destructor
   virtual ~DtPaperMap();

   // Load the papermap.
   virtual bool init
   (
      const DtFilename& path,
      DtPaperMapRecord* paperMapRec,
      const Coordinate_System* coordSys
   );

   // Returns a pointer to the scaled bitmap.
   virtual bool getScaledImage
   (
      const Coordinate_System* coordSys,
      const DtExtent& viewportExtent,
      const DtDisplaySize& screenSize,
      DtPoint& bitmapLocation,
      QImage& image,
      bool useMask,
      QColor* backgroundColor = 0,
      int* scaledBitmapX = NULL, int* scaledBitmapY = NULL
   ) = 0;

   // Returns the type of papermap (pixmap, rpf, multires)
   virtual const DtString mapType() const = 0;

   // Returns the name of this papermap level
   virtual const DtString& name(void) const;

   virtual void setName(const DtString& name);

   // Sets whether or not to hide/show papermap
   virtual void setShow(bool b);
   
   // Gets whether or not to show this papermap
   virtual bool show(void);

   // Get/set the alpha method to be used when drawing this map.
   virtual DtPaperMap::AlphaMode alphaMode() const;

   virtual void setAlphaMode(DtPaperMap::AlphaMode alphaMode);

   // Sets transparency level for bitmaps that do not have an alpha
   // channel.  Set from 0 (opaque) to 100 (completely transparent).
   virtual void setTransparencyLevel(int d);

   virtual int transparencyLevel() const;

   virtual const Coordinate_System* coordSys() const;

   // Set up the coordinate system of the papermap. Check it against the terrain's
   // coordinate system.
   virtual bool setCoordSys(DtPaperMap::DtCoordinateSystem sys,const Coordinate_System* terrainSys);
   DtPaperMap::DtCoordinateSystem coordinateSystemType() const;

   static DtPaperMap * create();

protected:

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

   // assignment operator
   DtPaperMap& operator=(const DtPaperMap& rhs);

   const Coordinate_System* myCoordinateSystem;

   bool myDeleteCoordSys;
   bool myShow;
   DtString myName;
   DtPaperMap::AlphaMode myAlphaMode;
   DtPaperMap::DtCoordinateSystem myCoordinateSystemType;

   int myTransparencyLevel;
};

#endif