Record of terrain raster layers, color by elevation settings, and contour line settings. More...

Public Types
typedef std::vector < DtGradientControlPoint >	ControlPointList

Public Member Functions
	DtOverlaySettingsRecord ()
	CTOR.
	DtOverlaySettingsRecord (const DtOverlaySettingsRecord &orig)
	Copy CTOR.
DtOverlaySettingsRecord &	operator= (const DtOverlaySettingsRecord &orig)
	Assignment OP.
	~DtOverlaySettingsRecord ()
	DTOR.
Source Texture
bool	baseSourceEnabled () const
	Returns whether source texture is enabled.
void	setBaseSourceEnabled (bool enabled)
	Returns whether source texture is enabled.
Raster Layers
void	addRasterLayer (const DtRasterLayerRecord &rec)
	Add an the DtRasterLayerRecord.
std::string	addRasterLayer (const std::string &name="")
	Add a new default DtRasterLayerRecord with specified name.
bool	removeRasterLayer (const std::string &name)
	Remove an the DtRasterLayerRecord by name.
void	insertRasterLayerRecord (const DtRasterLayerRecord &, int iIndex)
	Inserts the raster layer record at the specified index.
int	moveRasterLayer (const std::string &raster, int iBy)
	Moves raster layer up or down by the specified amount.
virtual bool	renameRasterLayer (const std::string &oldName, const std::string &newName)
	Renames raster layer to new name.
bool	hasRasterLayer (const std::string &name) const
	Returns true if there is a raster layer record with the specified name.
DtRasterLayerRecord	rasterLayerRecord (const std::string &name) const
	Returns a raster layer record.
int	rasterLayerIndex (const std::string &name) const
	Returns the index of the record that has the given name.
const DtRasterLayerRecord &	rasterLayerRecord (int) const
	Returns the raster layer at the specified index.
DtRasterLayerRecord &	rasterLayerRecord (int)
	Add an the DtRasterLayerRecord.
int	numRasterLayers () const
	Returns the number of raster layers.
void	setEnabled (const std::string &raster, bool)
	Add an the DtRasterLayerRecord.
bool	enabled (const std::string &raster) const
	Add an the DtRasterLayerRecord.
void	setName (const std::string &raster, const std::string &)
	Add an the DtRasterLayerRecord.
std::string	name (const std::string &raster) const
	Add an the DtRasterLayerRecord.
void	setFilename (const std::string &raster, const std::string &)
	Add an the DtRasterLayerRecord.
std::string	filename (const std::string &raster) const
	Add an the DtRasterLayerRecord.
void	setRasterOperation (const std::string &raster, int)
	Add an the DtRasterLayerRecord.
int	rasterOperation (const std::string &) const
	Add an the DtRasterLayerRecord.
void	setWrapMode (const std::string &raster, char)
	Add an the DtRasterLayerRecord.
char	wrapMode (const std::string &raster) const
	Add an the DtRasterLayerRecord.
void	setBlendMode (const std::string &raster, char)
	Add an the DtRasterLayerRecord.
char	blendMode (const std::string &raster) const
	Add an the DtRasterLayerRecord.
void	setTransformIsSet (const std::string &raster, bool)
	Add an the DtRasterLayerRecord.
bool	transformIsSet (const std::string &raster) const
	Add an the DtRasterLayerRecord.
void	setScale (const std::string &raster, double x, double y)
	Add an the DtRasterLayerRecord.
void	scale (const std::string &raster, double &x, double &y) const
	Add an the DtRasterLayerRecord.
void	setOffset (const std::string &raster, double x, double y)
	Add an the DtRasterLayerRecord.
void	offset (const std::string &raster, double &x, double &y) const
	Add an the DtRasterLayerRecord.
Contour Lines
bool	contourEnabled () const
	Returns whether contour lines are enabled.
bool	contourIntermediateLinesEnabled () const
	Returns whether intermediate contour lines are enabled.
double	contourInterval () const
	Returns current contour line interval.
double	contourThickness () const
	Returns current contour line thickness.
void	setContourEnabled (bool enabled)
	Sets whether contour lines are enabled.
void	setContourIntermediateLinesEnabled (bool enabled)
	Sets whether intermediate contour lines are enabled.
void	setContourInterval (double interval)
	Sets interval between contour lines.
void	setContourThickness (double thickness)
	Sets thickness of contour lines.
Elevation Color
bool	elevationEnabled () const
	Returns whether elevation color is enabled.
const DtOverlaySettingsRecord::ControlPointList &	elevationGradient () const
	Returns current elevation color gradient.
void	setElevationEnabled (bool enabled)
	Sets whether elevation color is enabled.
void	setElevationGradient (const DtOverlaySettingsRecord::ControlPointList &gradient)
	Sets elevation color gradient.

Protected Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Protected Attributes
bool	myBaseSourceEnabled
bool	myContourEnabled
bool	myContourIntermediateLinesEnabled
double	myContourInterval
double	myContourThickness
bool	myElevationEnabled
ControlPointList	myElevationGradient
std::vector< DtRasterLayerRecord >	myRasterLayerRecords

Friends
class	boost::serialization::access

Detailed Description

Record of terrain raster layers, color by elevation settings, and contour line settings.

Member Typedef Documentation

typedef std::vector<DtGradientControlPoint> makArchives::DtOverlaySettingsRecord::ControlPointList

Constructor & Destructor Documentation

makArchives::DtOverlaySettingsRecord::DtOverlaySettingsRecord ( )

CTOR.

makArchives::DtOverlaySettingsRecord::DtOverlaySettingsRecord ( const DtOverlaySettingsRecord & orig )

Copy CTOR.

makArchives::DtOverlaySettingsRecord::~DtOverlaySettingsRecord ( )

DTOR.

Member Function Documentation

DtOverlaySettingsRecord& makArchives::DtOverlaySettingsRecord::operator= ( const DtOverlaySettingsRecord & orig )

Assignment OP.

bool makArchives::DtOverlaySettingsRecord::baseSourceEnabled ( ) const

Returns whether source texture is enabled.

void makArchives::DtOverlaySettingsRecord::setBaseSourceEnabled ( bool enabled )

Returns whether source texture is enabled.

void makArchives::DtOverlaySettingsRecord::addRasterLayer ( const DtRasterLayerRecord & rec )

Add an the DtRasterLayerRecord.

std::string makArchives::DtOverlaySettingsRecord::addRasterLayer ( const std::string & name = "" )

Add a new default DtRasterLayerRecord with specified name.

If no name specified, returns a name based on the pattern "Image <next unique id>"

bool makArchives::DtOverlaySettingsRecord::removeRasterLayer ( const std::string & name )

Remove an the DtRasterLayerRecord by name.

Returns true if record was removed. Only removes first instance of named record

void makArchives::DtOverlaySettingsRecord::insertRasterLayerRecord	(	const DtRasterLayerRecord &	,
		int	iIndex
	)

Inserts the raster layer record at the specified index.

int makArchives::DtOverlaySettingsRecord::moveRasterLayer	(	const std::string &	raster,
		int	iBy
	)

Moves raster layer up or down by the specified amount.

Returns new position in list

virtual bool makArchives::DtOverlaySettingsRecord::renameRasterLayer	(	const std::string &	oldName,
		const std::string &	newName
	)

virtual

Renames raster layer to new name.

If new name is a duplicate, will return false

bool makArchives::DtOverlaySettingsRecord::hasRasterLayer ( const std::string & name ) const

Returns true if there is a raster layer record with the specified name.

DtRasterLayerRecord makArchives::DtOverlaySettingsRecord::rasterLayerRecord ( const std::string & name ) const

Returns a raster layer record.

int makArchives::DtOverlaySettingsRecord::rasterLayerIndex ( const std::string & name ) const

Returns the index of the record that has the given name.

-1 if record does not exist

const DtRasterLayerRecord& makArchives::DtOverlaySettingsRecord::rasterLayerRecord ( int ) const

Returns the raster layer at the specified index.

DtRasterLayerRecord& makArchives::DtOverlaySettingsRecord::rasterLayerRecord ( int )

Add an the DtRasterLayerRecord.

int makArchives::DtOverlaySettingsRecord::numRasterLayers ( ) const

Returns the number of raster layers.

void makArchives::DtOverlaySettingsRecord::setEnabled	(	const std::string &	raster,
		bool
	)

Add an the DtRasterLayerRecord.

bool makArchives::DtOverlaySettingsRecord::enabled ( const std::string & raster ) const

Add an the DtRasterLayerRecord.

void makArchives::DtOverlaySettingsRecord::setName	(	const std::string &	raster,
		const std::string &
	)

Add an the DtRasterLayerRecord.

std::string makArchives::DtOverlaySettingsRecord::name ( const std::string & raster ) const

Add an the DtRasterLayerRecord.

void makArchives::DtOverlaySettingsRecord::setFilename	(	const std::string &	raster,
		const std::string &
	)

Add an the DtRasterLayerRecord.

std::string makArchives::DtOverlaySettingsRecord::filename ( const std::string & raster ) const

Add an the DtRasterLayerRecord.

void makArchives::DtOverlaySettingsRecord::setRasterOperation	(	const std::string &	raster,
		int
	)

Add an the DtRasterLayerRecord.

int makArchives::DtOverlaySettingsRecord::rasterOperation ( const std::string & ) const

Add an the DtRasterLayerRecord.

void makArchives::DtOverlaySettingsRecord::setWrapMode	(	const std::string &	raster,
		char
	)

Add an the DtRasterLayerRecord.

char makArchives::DtOverlaySettingsRecord::wrapMode ( const std::string & raster ) const

Add an the DtRasterLayerRecord.

void makArchives::DtOverlaySettingsRecord::setBlendMode	(	const std::string &	raster,
		char
	)

Add an the DtRasterLayerRecord.

char makArchives::DtOverlaySettingsRecord::blendMode ( const std::string & raster ) const

Add an the DtRasterLayerRecord.

void makArchives::DtOverlaySettingsRecord::setTransformIsSet	(	const std::string &	raster,
		bool
	)

Add an the DtRasterLayerRecord.

bool makArchives::DtOverlaySettingsRecord::transformIsSet ( const std::string & raster ) const

Add an the DtRasterLayerRecord.

void makArchives::DtOverlaySettingsRecord::setScale	(	const std::string &	raster,
		double	x,
		double	y
	)

Add an the DtRasterLayerRecord.

void makArchives::DtOverlaySettingsRecord::scale	(	const std::string &	raster,
		double &	x,
		double &	y
	)		const

Add an the DtRasterLayerRecord.

void makArchives::DtOverlaySettingsRecord::setOffset	(	const std::string &	raster,
		double	x,
		double	y
	)

Add an the DtRasterLayerRecord.

void makArchives::DtOverlaySettingsRecord::offset	(	const std::string &	raster,
		double &	x,
		double &	y
	)		const

Add an the DtRasterLayerRecord.

bool makArchives::DtOverlaySettingsRecord::contourEnabled ( ) const

Returns whether contour lines are enabled.

bool makArchives::DtOverlaySettingsRecord::contourIntermediateLinesEnabled ( ) const

Returns whether intermediate contour lines are enabled.

double makArchives::DtOverlaySettingsRecord::contourInterval ( ) const

Returns current contour line interval.

double makArchives::DtOverlaySettingsRecord::contourThickness ( ) const

Returns current contour line thickness.

void makArchives::DtOverlaySettingsRecord::setContourEnabled ( bool enabled )

Sets whether contour lines are enabled.

void makArchives::DtOverlaySettingsRecord::setContourIntermediateLinesEnabled ( bool enabled )

Sets whether intermediate contour lines are enabled.

void makArchives::DtOverlaySettingsRecord::setContourInterval ( double interval )

Sets interval between contour lines.

void makArchives::DtOverlaySettingsRecord::setContourThickness ( double thickness )

Sets thickness of contour lines.

bool makArchives::DtOverlaySettingsRecord::elevationEnabled ( ) const

Returns whether elevation color is enabled.

const DtOverlaySettingsRecord::ControlPointList& makArchives::DtOverlaySettingsRecord::elevationGradient ( ) const

Returns current elevation color gradient.

void makArchives::DtOverlaySettingsRecord::setElevationEnabled ( bool enabled )

Sets whether elevation color is enabled.

void makArchives::DtOverlaySettingsRecord::setElevationGradient ( const DtOverlaySettingsRecord::ControlPointList & gradient )

Sets elevation color gradient.

template<class Archive >

void makArchives::DtOverlaySettingsRecord::serialize	(	Archive &	ar,
		const unsigned int	version
	)

inlineprotected

When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Member Data Documentation

bool makArchives::DtOverlaySettingsRecord::myBaseSourceEnabled

protected

bool makArchives::DtOverlaySettingsRecord::myContourEnabled

protected

bool makArchives::DtOverlaySettingsRecord::myContourIntermediateLinesEnabled

protected

double makArchives::DtOverlaySettingsRecord::myContourInterval

protected

double makArchives::DtOverlaySettingsRecord::myContourThickness

protected

bool makArchives::DtOverlaySettingsRecord::myElevationEnabled

protected

ControlPointList makArchives::DtOverlaySettingsRecord::myElevationGradient

protected

std::vector<DtRasterLayerRecord> makArchives::DtOverlaySettingsRecord::myRasterLayerRecords

protected

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

include/makArchives/DtOverlaySettingsRecord.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation