VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtTerrainMetafileRecord Class Reference

This is the abstract base class for all terrain records in a metafile. More...

Inheritance diagram for DtTerrainMetafileRecord:
Inheritance graph
[legend]

Public Member Functions

 DtTerrainMetafileRecord ()
 default constructor. More...
 
virtual ~DtTerrainMetafileRecord ()
 destructor More...
 
 DtTerrainMetafileRecord (const DtTerrainMetafileRecord &orig)
 copy constructor More...
 
DtTerrainMetafileRecordoperator= (const DtTerrainMetafileRecord &orig)
 assignment operator More...
 
virtual const DtFilename & filename () const
 Returns filename of database. More...
 
virtual void setFilename (const DtFilename &name)
 
virtual DtConfigCategoryType recordCategory () const
 Returns DtConfigTerrainType;. More...
 
virtual const unsigned int terrainType () const
 Specfic kind of terrain source. More...
 
virtual void resetFileLists ()
 Clears the terrain file initializer list. More...
 
virtual bool get (std::istream &stream)
 Read self from stream. More...
 
virtual bool processToken (std::istream &stream, DtString &token)
 Identifies a token or passes it to the parent class. More...
 
- Public Member Functions inherited from DtMetafileRecord
 DtMetafileRecord ()
 default constructor. More...
 
virtual ~DtMetafileRecord ()
 destructor More...
 
 DtMetafileRecord (const DtMetafileRecord &orig)
 copy constructor More...
 
DtMetafileRecordoperator= (const DtMetafileRecord &orig)
 assignment operator More...
 
virtual bool init ()
 Initialize the metafile. More...
 
virtual DtString recordTypeName () const =0
 Returns the type name for the particular record. More...
 
virtual bool canImport ()
 Tells whether the record can be included in the import process or not. More...
 
virtual bool put (std::ostream &stream) const
 Write self to stream. More...
 
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). More...
 
virtual bool setAttribute (DtString attrName, DtString value)
 Sets the value of the attribute attrName to value. More...
 
virtual const
DtTerrainInitializer
initializer () const
 Get the initializer. More...
 
virtual DtTerrainInitializerinitializer ()
 
virtual void setInitializer (DtTerrainInitializer *init)
 Sets the initializer. More...
 
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. More...
 
virtual const DtStringrecordString () const
 Get the record string. More...
 
virtual void setPath (const DtFilename &)
 Parent path (if relevant) More...
 
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)
 

Protected Member Functions

virtual bool writeAttributes (std::ostream &stream) const
 Write attributes to stream. This is called by put(stream) More...
 
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. More...
 
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 More...
 

Protected Attributes

long myZone
 
DtPoint myDatabaseOrigin
 
bool myOriginSet
 
DtFilename myFile
 
unsigned int myTerrainType
 
- Protected Attributes inherited from DtMetafileRecord
DtTerrainInitializermypInitializer
 
DtString myRecordString
 
int myRecordKey
 
DtPropertyNamesMap myAttributeNames
 
bool myCanImport
 
DtFilename myPath
 

Static Protected Attributes

static const DtString theZone
 These variables will be used to override any latitude/longitude or zone information found in header files. More...
 
static const DtString theOrigin
 Note that latitude and longitude origin will be defined as latitude, longitude, 0.0 (the z value must be 0.0) More...
 
static const DtString theNumVertices
 
static const DtString theNumSurfaces
 
static const DtString theIsLargeTerrain
 
- Static Protected Attributes inherited from DtMetafileRecord
static const DtString theImport
 

Detailed Description

This is the abstract base class for all terrain records in a metafile.

Constructor & Destructor Documentation

DtTerrainMetafileRecord::DtTerrainMetafileRecord ( )

default constructor.

virtual DtTerrainMetafileRecord::~DtTerrainMetafileRecord ( )
virtual

destructor

DtTerrainMetafileRecord::DtTerrainMetafileRecord ( const DtTerrainMetafileRecord orig)

copy constructor

Member Function Documentation

DtTerrainMetafileRecord& DtTerrainMetafileRecord::operator= ( const DtTerrainMetafileRecord orig)

assignment operator

virtual const DtFilename& DtTerrainMetafileRecord::filename ( ) const
virtual

Returns filename of database.

virtual void DtTerrainMetafileRecord::setFilename ( const DtFilename &  name)
virtual

Reimplemented in DtC7bMetafileRecord.

virtual DtConfigCategoryType DtTerrainMetafileRecord::recordCategory ( ) const
virtual

Returns DtConfigTerrainType;.

Implements DtMetafileRecord.

virtual const unsigned int DtTerrainMetafileRecord::terrainType ( ) const
virtual

Specfic kind of terrain source.

virtual void DtTerrainMetafileRecord::resetFileLists ( )
virtual

Clears the terrain file initializer list.

Reimplemented from DtMetafileRecord.

Reimplemented in DtShapeMetafileRecord.

virtual bool DtTerrainMetafileRecord::get ( std::istream &  stream)
virtual
virtual bool DtTerrainMetafileRecord::processToken ( std::istream &  stream,
DtString token 
)
virtual
virtual bool DtTerrainMetafileRecord::writeAttributes ( std::ostream &  stream) const
protectedvirtual
virtual bool DtTerrainMetafileRecord::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 DtMetafileRecord.

Reimplemented in DtShapeMetafileRecord, DtFltMetafileRecord, DtAsciiMetafileRecord, DtC4bMetafileRecord, DtC7bMetafileRecord, DtDtedMetafileRecord, DtGdbMetafileRecord, and DtMetaFlightMetafileRecord.

virtual bool DtTerrainMetafileRecord::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 DtMetafileRecord.

Reimplemented in DtShapeMetafileRecord, DtC4bMetafileRecord, DtFltMetafileRecord, DtAsciiMetafileRecord, DtC7bMetafileRecord, DtDtedMetafileRecord, DtGdbMetafileRecord, and DtMetaFlightMetafileRecord.

Member Data Documentation

const DtString DtTerrainMetafileRecord::theZone
staticprotected

These variables will be used to override any latitude/longitude or zone information found in header files.

const DtString DtTerrainMetafileRecord::theOrigin
staticprotected

Note that latitude and longitude origin will be defined as latitude, longitude, 0.0 (the z value must be 0.0)

const DtString DtTerrainMetafileRecord::theNumVertices
staticprotected
const DtString DtTerrainMetafileRecord::theNumSurfaces
staticprotected
const DtString DtTerrainMetafileRecord::theIsLargeTerrain
staticprotected
long DtTerrainMetafileRecord::myZone
protected
DtPoint DtTerrainMetafileRecord::myDatabaseOrigin
protected
bool DtTerrainMetafileRecord::myOriginSet
protected
DtFilename DtTerrainMetafileRecord::myFile
protected
unsigned int DtTerrainMetafileRecord::myTerrainType
protected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)