VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtMultiResPaperMapRecord Class Reference
Inheritance diagram for DtMultiResPaperMapRecord:
Inheritance graph
[legend]

Public Member Functions

 DtMultiResPaperMapRecord ()
virtual ~DtMultiResPaperMapRecord ()
 DtMultiResPaperMapRecord (const DtMultiResPaperMapRecord &orig)
DtMultiResPaperMapRecordoperator= (const DtMultiResPaperMapRecord &rhs)
virtual DtPaperMapRecordclone ()
virtual DtString recordTypeName () const
 Returns the type name for the particular record.
virtual bool get (std::istream &stream)
 Read self from stream.
virtual bool processToken (std::istream &stream, DtString &token)
 identifies a token or passes token the parent class.
void setCacheImages (bool)
bool cacheImages () const
- Public Member Functions inherited from DtPaperMapRecord
 DtPaperMapRecord ()
virtual ~DtPaperMapRecord ()
 DtPaperMapRecord (const DtPaperMapRecord &orig)
DtPaperMapRecordoperator= (const DtPaperMapRecord &rhs)
virtual DtConfigCategoryType recordCategory () const
 Each record should have a category of configuration they represent.
virtual const DtStringname () const
virtual void setName (const DtString &name)
virtual void setFilename (const DtFilename &filename)
virtual const DtFilename & filename () const
virtual void setTransparencyLevel (int i)
virtual int transparencyLevel () const
virtual void setCoordinateSystem (DtPaperMap::DtCoordinateSystem cs)
virtual
DtPaperMap::DtCoordinateSystem 
coordinateSystem () const
virtual DtPaperMap::AlphaMode alphaMode () const
virtual void setAlphaMode (DtPaperMap::AlphaMode mode)
virtual DtString coordSysEnumToString (const DtPaperMap::DtCoordinateSystem coordsys) const
virtual
DtPaperMap::DtCoordinateSystem 
stringToCoordSysEnum (const DtString &string) const
virtual DtString alphaEnumToString (const DtPaperMap::AlphaMode alphaMode) const
virtual DtPaperMap::AlphaMode stringToAlphaEnum (const DtString &string) const
- Public Member Functions inherited from DtMetafileRecord
 DtMetafileRecord ()
 default constructor.
virtual ~DtMetafileRecord ()
 destructor
 DtMetafileRecord (const DtMetafileRecord &orig)
 copy constructor
DtMetafileRecordoperator= (const DtMetafileRecord &orig)
 assignment operator
virtual bool init ()
 Initialize the metafile.
virtual bool canImport ()
 Tells whether the record can be included in the import process or not.
virtual bool put (std::ostream &stream) const
 Write self to stream.
virtual bool getAttribute (const DtString attrName, DtString &value, DtString &type, unsigned index=0)
 Given the name of a record's attribute, returns True if the record has the attribute (the value is returned in value and the type in type).
virtual bool setAttribute (DtString attrName, DtString value)
 Sets the value of the attribute attrName to value.
virtual const
DtTerrainInitializer
initializer () const
 Get the initializer.
virtual DtTerrainInitializerinitializer ()
virtual void setInitializer (DtTerrainInitializer *init)
 Sets the initializer.
virtual const int recordKey ()
virtual void setRecordKey (const int key)
virtual const DtPropertyNamesMap properties () const
 Get the std::map with all the properties available for this record.
virtual const DtStringrecordString () const
 Get the record string.
virtual void resetFileLists ()
 Clears any file lists this record holds onto.
virtual void setPath (const DtFilename &)
 Parent path (if relevant)
virtual const DtFilename & path () const
bool isInt (const DtString &valueIn)
bool isDouble (const DtString &valueIn)
bool isColor (const DtString &valueIn)
bool isPoint (const DtString &valueIn)
bool isBool (const DtString &valueIn)
bool toInt (const DtString &valueIn, int &valueOut)
bool toDouble (const DtString &valueIn, double &valueOut)
bool toColor (const DtString &valueIn, DtColor &valueOut)
bool toPoint (const DtString &valueIn, DtPoint &valueOut)
bool toBool (const DtString &valueIn, bool &valueOut)

Static Public Member Functions

static DtMetafileRecordcreate ()

Protected Member Functions

virtual bool writeAttributes (std::ostream &stream) const
 Write attributes to stream. This is called by put(stream)
virtual bool getAttribute (const DtString attrName, DtString &value, unsigned index=0)
 Given the name of a record's attribute, returns its value in the 'value' parameter.
virtual bool setToken (const DtString &token, const DtString value)
 identifies a token and returns true if the value can be set to it, false otherwise

Protected Attributes

bool myCacheImages
- Protected Attributes inherited from DtPaperMapRecord
DtString myName
DtFilename myFilename
DtPaperMap::AlphaMode myAlphaMode
int myTransparencyLevel
DtPaperMap::DtCoordinateSystem myCoordinateSystem
- Protected Attributes inherited from DtMetafileRecord
DtTerrainInitializermypInitializer
DtString myRecordString
int myRecordKey
DtPropertyNamesMap myAttributeNames
bool myCanImport
DtFilename myPath

Static Protected Attributes

static const DtString theParameterCacheImages
- Static Protected Attributes inherited from DtPaperMapRecord
static const DtString theParameterName
static const DtString theParameterFilename
static const DtString theParameterCoordinateSystem
static const DtString theParameterAlphaMode
static const DtString theParameterTransparencyLevel
static const int theNumOfParameters
- Static Protected Attributes inherited from DtMetafileRecord
static const DtString theImport

Constructor & Destructor Documentation

DtMultiResPaperMapRecord::DtMultiResPaperMapRecord ( )
virtual DtMultiResPaperMapRecord::~DtMultiResPaperMapRecord ( )
virtual
DtMultiResPaperMapRecord::DtMultiResPaperMapRecord ( const DtMultiResPaperMapRecord orig)

Member Function Documentation

DtMultiResPaperMapRecord& DtMultiResPaperMapRecord::operator= ( const DtMultiResPaperMapRecord rhs)
virtual DtPaperMapRecord* DtMultiResPaperMapRecord::clone ( )
virtual

Reimplemented from DtPaperMapRecord.

virtual DtString DtMultiResPaperMapRecord::recordTypeName ( ) const
virtual

Returns the type name for the particular record.

Descendants should have this method return some string which uniquely identifies the kind of database it represents.

Reimplemented from DtPaperMapRecord.

virtual bool DtMultiResPaperMapRecord::get ( std::istream &  stream)
virtual

Read self from stream.

Reimplemented from DtPaperMapRecord.

virtual bool DtMultiResPaperMapRecord::processToken ( std::istream &  stream,
DtString token 
)
virtual

identifies a token or passes token the parent class.

Reimplemented from DtPaperMapRecord.

static DtMetafileRecord* DtMultiResPaperMapRecord::create ( )
static

Reimplemented from DtPaperMapRecord.

void DtMultiResPaperMapRecord::setCacheImages ( bool  b)
inline

References myCacheImages.

bool DtMultiResPaperMapRecord::cacheImages ( ) const
inline

References myCacheImages.

virtual bool DtMultiResPaperMapRecord::writeAttributes ( std::ostream &  stream) const
protectedvirtual

Write attributes to stream. This is called by put(stream)

Reimplemented from DtPaperMapRecord.

virtual bool DtMultiResPaperMapRecord::getAttribute ( const DtString  attrName,
DtString value,
unsigned  index = 0 
)
protectedvirtual

Given the name of a record's attribute, returns its value in the 'value' parameter.

Returns True if successful; false otherwise

Reimplemented from DtPaperMapRecord.

virtual bool DtMultiResPaperMapRecord::setToken ( const DtString token,
const DtString  value 
)
protectedvirtual

identifies a token and returns true if the value can be set to it, false otherwise

Reimplemented from DtPaperMapRecord.

Member Data Documentation

bool DtMultiResPaperMapRecord::myCacheImages
protected

Referenced by cacheImages(), and setCacheImages().

const DtString DtMultiResPaperMapRecord::theParameterCacheImages
staticprotected

The documentation for this class was generated from the following file:

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)