DtPixmapPaperMapRecord Class Reference

class DtPixmapPaperMapRecord: Instances of this class are accessors to Mak terrain database metafiles. More...

Inheritance diagram for DtPixmapPaperMapRecord:

Public Member Functions
	DtPixmapPaperMapRecord ()
	default constructor.
virtual	~DtPixmapPaperMapRecord ()
	destructor
	DtPixmapPaperMapRecord (const DtPixmapPaperMapRecord &orig)
	copy constructor
DtPixmapPaperMapRecord &	operator= (const DtPixmapPaperMapRecord &rhs)
	assignment operator
virtual DtPaperMapRecord *	clone ()
virtual DtString	recordTypeName () const
	Returns the record type.
virtual void	setSwCorner (const DtPoint &pnt)
	Returns the southwest point of the bitmap.
virtual const DtPoint &	swCorner () const
virtual void	setNeCorner (const DtPoint &pnt)
	Returns the northeast point of the bitmap.
virtual const DtPoint &	neCorner () const
virtual void	setCornersInDatabase (bool db)
	If a papermap gets loaded with out extents, it's extents are set to a default of whatever the terrain's extent is.
virtual bool	cornersInDatabase ()
virtual bool	get (std::istream &stream)
	Read self from stream.
virtual bool	processToken (std::istream &stream, DtString &token)
	identifies a token or passes it to the parent class
Public Member Functions inherited from DtPaperMapRecord
	DtPaperMapRecord ()
virtual	~DtPaperMapRecord ()
	DtPaperMapRecord (const DtPaperMapRecord &orig)
DtPaperMapRecord &	operator= (const DtPaperMapRecord &rhs)
virtual DtConfigCategoryType	recordCategory () const
	Each record should have a category of configuration they represent.
virtual const DtString &	name () 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
DtMetafileRecord &	operator= (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 DtTerrainInitializer *	initializer ()
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 DtString &	recordString () 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 DtMetafileRecord *	create ()

Protected Member Functions
virtual bool	writeAttributes (std::ostream &stream) const
	Write self to 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
DtPoint	mySwCorner
DtPoint	myNeCorner
bool	myCornersInDBCoords
Protected Attributes inherited from DtPaperMapRecord
DtString	myName
DtFilename	myFilename
DtPaperMap::AlphaMode	myAlphaMode
int	myTransparencyLevel
DtPaperMap::DtCoordinateSystem	myCoordinateSystem
Protected Attributes inherited from DtMetafileRecord
DtTerrainInitializer *	mypInitializer
DtString	myRecordString
int	myRecordKey
DtPropertyNamesMap	myAttributeNames
bool	myCanImport
DtFilename	myPath

Static Protected Attributes
static const DtString	theParameterSwCorner
static const DtString	theParameterNeCorner
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

Detailed Description

class DtPixmapPaperMapRecord: 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

Constructor & Destructor Documentation

DtPixmapPaperMapRecord::DtPixmapPaperMapRecord

(

)

default constructor.

virtual DtPixmapPaperMapRecord::~DtPixmapPaperMapRecord ( )

virtual

destructor

DtPixmapPaperMapRecord::DtPixmapPaperMapRecord

(

const DtPixmapPaperMapRecord &

orig

)

copy constructor

Member Function Documentation

DtPixmapPaperMapRecord& DtPixmapPaperMapRecord::operator=

(

const DtPixmapPaperMapRecord &

rhs

)

assignment operator

virtual DtPaperMapRecord* DtPixmapPaperMapRecord::clone ( )

virtual

Reimplemented from DtPaperMapRecord.

virtual DtString DtPixmapPaperMapRecord::recordTypeName ( ) const

virtual

Returns the record type.

Reimplemented from DtPaperMapRecord.

virtual void DtPixmapPaperMapRecord::setSwCorner ( const DtPoint &  pnt )

virtual

Returns the southwest point of the bitmap.

virtual const DtPoint& DtPixmapPaperMapRecord::swCorner ( ) const

virtual

virtual void DtPixmapPaperMapRecord::setNeCorner ( const DtPoint &  pnt )

virtual

Returns the northeast point of the bitmap.

virtual const DtPoint& DtPixmapPaperMapRecord::neCorner ( ) const

virtual

virtual void DtPixmapPaperMapRecord::setCornersInDatabase ( bool  db )

virtual

If a papermap gets loaded with out extents, it's extents are set to a default of whatever the terrain's extent is.

However when this happens the corners are set in database coords not the pixmap's current coordinate system. This flag indicates this case.

virtual bool DtPixmapPaperMapRecord::cornersInDatabase ( )

virtual

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

virtual

Read self from stream.

Reimplemented from DtPaperMapRecord.

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

virtual

identifies a token or passes it to the parent class

Reimplemented from DtPaperMapRecord.

static DtMetafileRecord* DtPixmapPaperMapRecord::create ( )

static

Reimplemented from DtPaperMapRecord.

virtual bool DtPixmapPaperMapRecord::writeAttributes ( std::ostream &  stream ) const

protectedvirtual

Write self to stream.

Reimplemented from DtPaperMapRecord.

virtual bool DtPixmapPaperMapRecord::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 DtPixmapPaperMapRecord::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

DtPoint DtPixmapPaperMapRecord::mySwCorner

protected

DtPoint DtPixmapPaperMapRecord::myNeCorner

protected

bool DtPixmapPaperMapRecord::myCornersInDBCoords

protected

const DtString DtPixmapPaperMapRecord::theParameterSwCorner

staticprotected

const DtString DtPixmapPaperMapRecord::theParameterNeCorner

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/terrainDbFactory/pixmapPaperMapRecord.h