multiResPaperMapRecord.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: mResPprMapRec.h,v $ $Revision: 1.12 $ $State: Exp $
*******************************************************************************/

#ifndef DtMultiResPaperMapRecord_H_
#define DtMultiResPaperMapRecord_H_

#include "terrainDbFactory/terrainDbFactoryDefines.h"
#include "terrainDbFactory/paperMapRecord.h"

#include "geometry/point.h"

#include <iosfwd>

// class DtMultiResPaperMapRecord:
//
// Instances of this class are accessors to Mak terrain database metafiles.
// This record points to a mtl file which contains the information for 
// form a paper map out of a set of pageable raster images.

class DT_DLL_terrainDbFactory DtMultiResPaperMapRecord : public DtPaperMapRecord
{

public:

   // default constructor.
   DtMultiResPaperMapRecord();

   // destructor
   virtual ~DtMultiResPaperMapRecord() override;

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

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

   virtual DtPaperMapRecord *clone() override;

   // Returns the record type.
   virtual DtString recordTypeName() const override;

   // 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();

   void setCacheImages(bool);

   bool cacheImages() 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:
   // If true (default is false) images, when loaded, will not be unloaded
   // but rather cached in the system.  Set this flag to true when performance
   // is more of an issue than memory usage.
   bool  myCacheImages;
   static const DtString theParameterCacheImages;
};

inline void DtMultiResPaperMapRecord::setCacheImages(bool b)
{
   myCacheImages = b;
}

inline bool DtMultiResPaperMapRecord::cacheImages() const
{
   return myCacheImages;
}

#endif