VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtPaperMapRecord Class Reference
Inheritance diagram for DtPaperMapRecord:
Inheritance graph
[legend]

Public Member Functions

 DtPaperMapRecord ()
 
virtual ~DtPaperMapRecord () override
 
 DtPaperMapRecord (const DtPaperMapRecord &orig)
 
DtPaperMapRecordoperator= (const DtPaperMapRecord &rhs)
 
virtual DtPaperMapRecordclone ()
 
virtual DtString recordTypeName () const override
 
virtual DtConfigCategoryType recordCategory () const override
 
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 bool get (std::istream &stream) override
 
virtual bool processToken (std::istream &stream, DtString &token) override
 
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 ()
 
virtual ~DtMetafileRecord ()
 
 DtMetafileRecord (const DtMetafileRecord &orig)
 
DtMetafileRecordoperator= (const DtMetafileRecord &orig)
 
virtual bool init ()
 
virtual bool canImport ()
 
virtual bool put (std::ostream &stream) const
 
virtual bool getAttribute (const DtString attrName, DtString &value, DtString &type, unsigned index=0)
 
virtual bool setAttribute (DtString attrName, DtString value)
 
virtual const
DtTerrainInitializer
initializer () const
 
virtual DtTerrainInitializerinitializer ()
 
virtual void setInitializer (DtTerrainInitializer *init)
 
virtual const int recordKey ()
 
virtual void setRecordKey (const int key)
 
virtual const DtPropertyNamesMap properties () const
 
virtual const DtStringrecordString () const
 
virtual void resetFileLists ()
 
virtual void setPath (const DtFilename &)
 
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 override
 
virtual bool getAttribute (const DtString attrName, DtString &value, unsigned index=0) override
 
virtual bool setToken (const DtString &token, const DtString value) override
 

Protected Attributes

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 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

DtPaperMapRecord::DtPaperMapRecord ( )
virtual DtPaperMapRecord::~DtPaperMapRecord ( )
overridevirtual
DtPaperMapRecord::DtPaperMapRecord ( const DtPaperMapRecord orig)

Member Function Documentation

DtPaperMapRecord& DtPaperMapRecord::operator= ( const DtPaperMapRecord rhs)
virtual DtPaperMapRecord* DtPaperMapRecord::clone ( )
virtual
virtual DtString DtPaperMapRecord::recordTypeName ( ) const
overridevirtual

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.

Implements DtMetafileRecord.

Reimplemented in DtMultiResPaperMapRecord, DtPixmapPaperMapRecord, and DtRpfPaperMapRecord.

virtual DtConfigCategoryType DtPaperMapRecord::recordCategory ( ) const
overridevirtual

Each record should have a category of configuration they represent. I.e does this record configure terrain source files, or vector source files, papermap files....

Implements DtMetafileRecord.

virtual const DtString& DtPaperMapRecord::name ( ) const
virtual
virtual void DtPaperMapRecord::setName ( const DtString name)
virtual
virtual void DtPaperMapRecord::setFilename ( const DtFilename &  filename)
virtual
virtual const DtFilename& DtPaperMapRecord::filename ( ) const
virtual
virtual void DtPaperMapRecord::setTransparencyLevel ( int  i)
virtual
virtual int DtPaperMapRecord::transparencyLevel ( ) const
virtual
virtual void DtPaperMapRecord::setCoordinateSystem ( DtPaperMap::DtCoordinateSystem  cs)
virtual
virtual DtPaperMap::DtCoordinateSystem DtPaperMapRecord::coordinateSystem ( ) const
virtual
virtual DtPaperMap::AlphaMode DtPaperMapRecord::alphaMode ( ) const
virtual
virtual void DtPaperMapRecord::setAlphaMode ( DtPaperMap::AlphaMode  mode)
virtual
virtual bool DtPaperMapRecord::get ( std::istream &  stream)
overridevirtual

Read self from stream.

Reimplemented from DtMetafileRecord.

Reimplemented in DtPixmapPaperMapRecord, DtRpfPaperMapRecord, and DtMultiResPaperMapRecord.

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

identifies a token or passes token the parent class.

Reimplemented from DtMetafileRecord.

Reimplemented in DtPixmapPaperMapRecord, DtRpfPaperMapRecord, and DtMultiResPaperMapRecord.

static DtMetafileRecord* DtPaperMapRecord::create ( )
static
virtual DtString DtPaperMapRecord::coordSysEnumToString ( const DtPaperMap::DtCoordinateSystem  coordsys) const
virtual
virtual DtPaperMap::DtCoordinateSystem DtPaperMapRecord::stringToCoordSysEnum ( const DtString string) const
virtual
virtual DtString DtPaperMapRecord::alphaEnumToString ( const DtPaperMap::AlphaMode  alphaMode) const
virtual
virtual DtPaperMap::AlphaMode DtPaperMapRecord::stringToAlphaEnum ( const DtString string) const
virtual
virtual bool DtPaperMapRecord::writeAttributes ( std::ostream &  stream) const
overrideprotectedvirtual

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

Reimplemented from DtMetafileRecord.

Reimplemented in DtPixmapPaperMapRecord, DtRpfPaperMapRecord, and DtMultiResPaperMapRecord.

virtual bool DtPaperMapRecord::getAttribute ( const DtString  attrName,
DtString value,
unsigned  index = 0 
)
overrideprotectedvirtual

Given the name of a record's attribute, returns its value in the 'value' parameter. Returns True if successful; false otherwise.

Reimplemented from DtMetafileRecord.

Reimplemented in DtPixmapPaperMapRecord, DtRpfPaperMapRecord, and DtMultiResPaperMapRecord.

virtual bool DtPaperMapRecord::setToken ( const DtString token,
const DtString  value 
)
overrideprotectedvirtual

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

Reimplemented from DtMetafileRecord.

Reimplemented in DtPixmapPaperMapRecord, DtRpfPaperMapRecord, and DtMultiResPaperMapRecord.

Member Data Documentation

DtString DtPaperMapRecord::myName
protected
DtFilename DtPaperMapRecord::myFilename
protected
DtPaperMap::AlphaMode DtPaperMapRecord::myAlphaMode
protected
int DtPaperMapRecord::myTransparencyLevel
protected
DtPaperMap::DtCoordinateSystem DtPaperMapRecord::myCoordinateSystem
protected
const DtString DtPaperMapRecord::theParameterName
staticprotected
const DtString DtPaperMapRecord::theParameterFilename
staticprotected
const DtString DtPaperMapRecord::theParameterCoordinateSystem
staticprotected
const DtString DtPaperMapRecord::theParameterAlphaMode
staticprotected
const DtString DtPaperMapRecord::theParameterTransparencyLevel
staticprotected
const int DtPaperMapRecord::theNumOfParameters
staticprotected

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

Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)