paperMapRecord.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: pprMapRec.h,v $ $Revision: 1.21 $ $State: Exp $
*******************************************************************************/
#ifndef paperMapRecord_H_
#define paperMapRecord_H_

#include "terrainDbFactory/terrainDbFactoryDefines.h"
#include "terrainDbFactory/metafileRecord.h"
#include "terrainDbFactory/paperMap.h"
#include "terrainDbFactory/terrainDefines.h"
#include <vlutil/vlFilename.h>


//
// Instances of this class are accessors to Mak terrain database metafiles.
// Certain database formats require the use of a metafile as the top-level
// file.  Example: gdf, dted
class DT_DLL_terrainDbFactory DtPaperMapRecord : public DtMetafileRecord
{

public:

   // default constructor.
   DtPaperMapRecord();

   // destructor
   virtual ~DtPaperMapRecord() override;

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

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

   virtual DtPaperMapRecord* clone();

   // Returns "paper".
   virtual DtString recordTypeName() const override;

   // Returns DtConfigImageType;
   virtual DtConfigCategoryType recordCategory() const override;

   // Returns the name specified in the 
   virtual const DtString& name() const;
   virtual void setName(const DtString & name);

   // Returns the filename of the bitmap to load for this papermap.
   virtual void setFilename(const DtFilename& filename);
   virtual const DtFilename& filename() const;

   // Returns the level of transparency (0 - opaque, 100 - full transparent)
   virtual void setTransparencyLevel(int i);
   virtual int transparencyLevel() const;

   // Returns the coordinate system used by this papermap.
   virtual void setCoordinateSystem(DtPaperMap::DtCoordinateSystem cs);
   virtual DtPaperMap::DtCoordinateSystem coordinateSystem() const;

   virtual DtPaperMap::AlphaMode alphaMode() const;
   virtual void setAlphaMode(DtPaperMap::AlphaMode mode);

   // Read self from stream.
   virtual bool get(std::istream &stream) override;
   
   // identifies a token or passes it to the parent class.
   virtual bool processToken(std::istream &stream, DtString &token) override;

   static DtMetafileRecord * create();

   // Converts to and from the enum and string representation of the
   // PvCoordinateSystem enumeration.
   virtual DtString coordSysEnumToString(const DtPaperMap::DtCoordinateSystem coordsys) const;
   virtual DtPaperMap::DtCoordinateSystem stringToCoordSysEnum(const DtString& string) const;

   // Converts to and from the enum and string representation of the
   // AlphaMode enumeration.
   virtual DtString alphaEnumToString(const DtPaperMap::AlphaMode alphaMode) const;
   virtual DtPaperMap::AlphaMode stringToAlphaEnum(const DtString& string) const;

protected:

   // Write self to stream.
   virtual bool writeAttributes(std::ostream &stream) const override;
   virtual bool getAttribute(const DtString attrName, DtString &value,
                            unsigned index = 0) override;
   virtual bool setToken(const DtString &token, const DtString value) override;

protected:

   DtString myName;
   DtFilename myFilename;
   DtPaperMap::AlphaMode myAlphaMode;
   int myTransparencyLevel;

   DtPaperMap::DtCoordinateSystem myCoordinateSystem;

   static const DtString theParameterName;
   static const DtString theParameterFilename;
   static const DtString theParameterCoordinateSystem;
   static const DtString theParameterAlphaMode;
   static const DtString theParameterTransparencyLevel;
   static const int theNumOfParameters;

};

#endif