makVrv::DtTerrainOverlayOperation Class Reference

A class specifying a single overlay operation. More...

Inheritance diagram for makVrv::DtTerrainOverlayOperation:

List of all members.

Public Types
enum	OverlayType {   InvalidOperation = -1, NoOperation = 0, SourceBase, SourceMatrixReset,   BlankBase, RasterTextureStart = 4, RasterTextureEnd = 104, ElevationOverlay,   ContourOverlay }
Public Member Functions
	DtTerrainOverlayOperation ()
	CTOR.
	DtTerrainOverlayOperation (const DtTerrainOverlayOperation &)
	Copy ctor.
DtTerrainOverlayOperation &	operator= (const DtTerrainOverlayOperation &)
	Assignment.
	DtTerrainOverlayOperation (OverlayType type, std::string definition)
	CTOR.
	DtTerrainOverlayOperation (OverlayType type, std::string definition, std::vector< double > scale, std::vector< double > offset)
	CTOR.
	DtTerrainOverlayOperation (OverlayType type, std::string definition, double xscale, double yscale, double xoffset, double yoffset)
	CTOR.
virtual OverlayType	operation () const
	Return the active operation.
virtual const std::string	definition () const
	Return the model definition.
virtual const std::vector< double >	scale () const
	Return the scale setting.
virtual bool	scale (double &x, double &y) const
	Return the scale setting.
virtual const std::vector< double >	offset () const
	Return the offset setting.
virtual bool	offset (double &x, double &y) const
	Return the offset setting.
virtual void	setScale (const std::vector< double > scale)
	Set the scale.
virtual void	setScale (double x, double y)
	Set the scale.
virtual void	setOffset (const std::vector< double > offset)
	Set the offset.
virtual void	setOffset (double x, double y)
	Set the offset.
virtual bool	nop () const
	Returns true if overlay will never do anything.
virtual bool	base () const
	Returns true if overlay is a base (non-blended) overlay.
Protected Attributes
OverlayType	myOperation
std::string	myDefinition
std::vector< double >	myScale
std::vector< double >	myOffset

---

Detailed Description

A class specifying a single overlay operation.

---

Member Enumeration Documentation

enum makVrv::DtTerrainOverlayOperation::OverlayType

Enumerator:

InvalidOperation
NoOperation
SourceBase
SourceMatrixReset
BlankBase
RasterTextureStart
RasterTextureEnd
ElevationOverlay
ContourOverlay

---

Constructor & Destructor Documentation

makVrv::DtTerrainOverlayOperation::DtTerrainOverlayOperation

(

)

CTOR.

makVrv::DtTerrainOverlayOperation::DtTerrainOverlayOperation

(

const DtTerrainOverlayOperation &

)

Copy ctor.

makVrv::DtTerrainOverlayOperation::DtTerrainOverlayOperation	(	OverlayType	type,
		std::string	definition
	)

CTOR.

makVrv::DtTerrainOverlayOperation::DtTerrainOverlayOperation	(	OverlayType	type,
		std::string	definition,
		std::vector< double >	scale,
		std::vector< double >	offset
	)

CTOR.

makVrv::DtTerrainOverlayOperation::DtTerrainOverlayOperation	(	OverlayType	type,
		std::string	definition,
		double	xscale,
		double	yscale,
		double	xoffset,
		double	yoffset
	)

CTOR.

---

Member Function Documentation

DtTerrainOverlayOperation& makVrv::DtTerrainOverlayOperation::operator=

(

const DtTerrainOverlayOperation &

)

Assignment.

virtual OverlayType makVrv::DtTerrainOverlayOperation::operation

(

)

const [virtual]

Return the active operation.

virtual const std::string makVrv::DtTerrainOverlayOperation::definition

(

)

const [virtual]

Return the model definition.

virtual const std::vector<double> makVrv::DtTerrainOverlayOperation::scale

(

)

const [virtual]

Return the scale setting.

virtual bool makVrv::DtTerrainOverlayOperation::scale	(	double &	x,
		double &	y
	)		const [virtual]

Return the scale setting.

virtual const std::vector<double> makVrv::DtTerrainOverlayOperation::offset

(

)

const [virtual]

Return the offset setting.

virtual bool makVrv::DtTerrainOverlayOperation::offset	(	double &	x,
		double &	y
	)		const [virtual]

Return the offset setting.

virtual void makVrv::DtTerrainOverlayOperation::setScale

(

const std::vector< double >

scale

)

[virtual]

Set the scale.

virtual void makVrv::DtTerrainOverlayOperation::setScale	(	double	x,
		double	y
	)		[virtual]

Set the scale.

virtual void makVrv::DtTerrainOverlayOperation::setOffset

(

const std::vector< double >

offset

)

[virtual]

Set the offset.

virtual void makVrv::DtTerrainOverlayOperation::setOffset	(	double	x,
		double	y
	)		[virtual]

Set the offset.

virtual bool makVrv::DtTerrainOverlayOperation::nop

(

)

const [virtual]

Returns true if overlay will never do anything.

virtual bool makVrv::DtTerrainOverlayOperation::base

(

)

const [virtual]

Returns true if overlay is a base (non-blended) overlay.

---

Member Data Documentation

OverlayType makVrv::DtTerrainOverlayOperation::myOperation [protected]

std::string makVrv::DtTerrainOverlayOperation::myDefinition [protected]

std::vector<double> makVrv::DtTerrainOverlayOperation::myScale [protected]

std::vector<double> makVrv::DtTerrainOverlayOperation::myOffset [protected]

---

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

• include/vrvCore/DtTerrainOverlayOperation.h