makVrv::DtChannelCompassInstance Class Reference

Interface for a DtChannelCompassInstance An object that draws a 2D compass. More...

Inheritance diagram for makVrv::DtChannelCompassInstance:

List of all members.

Public Member Functions
	DtChannelCompassInstance ()
	CTOR.
virtual	~DtChannelCompassInstance ()
	DTOR.
virtual void	setChannelName (const std::string &deName, const std::string &winName, const std::string &channelName)
	Set the name of the channel that this compass should be drawn on.
virtual void	setCompassHeading (double heading)
	set the compass heading
virtual void	setModelDefinition (const std::string &modelDefinition)
	Set the model definition; note that this (potentially) includes all the other parameters enumeration below.
virtual void	setLocation (DtChannelCompass::Locations location)
	Set the compass location.
DtChannelCompass::Locations	location () const
	Returns the current location of the compass.
virtual void	setMargins (unsigned int xMargin, unsigned int yMargin)
	Set the margins, in pixels.
virtual void	setNorthLetterFilename (const std::string &filename)
	Set the name of a bitmap / png file that can be used as the North letter image.
virtual void	setSouthLetterFilename (const std::string &filename)
	Set the name of a bitmap / png file that can be used as the South letter image.
virtual void	setEastLetterFilename (const std::string &filename)
	Set the name of a bitmap / png file that can be used as the East letter image.
virtual void	setWestLetterFilename (const std::string &filename)
	Set the name of a bitmap / png file that can be used as the West letter image.
virtual void	setCompassRadius (unsigned int radius)
	Set the size of the compass, in pixels.
virtual void	setNorthLetterSize (unsigned int width, unsigned int height)
	Set the size of the North Letter, in pixels.
void	setSouthLetterSize (unsigned int width, unsigned int height)
	Set the size of the South Letter, in pixels.
virtual void	setEastLetterSize (unsigned int width, unsigned int height)
	Set the size of the East Letter, in pixels.
virtual void	setWestLetterSize (unsigned int width, unsigned int height)
	Set the size of the West Letter, in pixels.
virtual void	showSmallTickMarks (bool show)
	show or hide the smaller (every 15 degrees) tick marks
virtual void	setDarkTickColor (float r, float g, float b, float a)
	set the color to use for the dark side of tick marks
virtual void	setLightTickColor (float r, float g, float b, float a)
	set the color to use for the light side of tick marks
virtual void	updateCompass (bool force=false)=0
	Called anytime any of the compass parameters change, and when the observer heading changes.
Protected Attributes
std::string	myModelDefinitionName
std::string	myDisplayEngineName
std::string	myWindowName
std::string	myChannelName
DtChannelCompass::Locations	myLocation
unsigned int	myMargins [2]
std::string	myNorthLetterFilename
std::string	mySouthLetterFilename
std::string	myEastLetterFilename
std::string	myWestLetterFilename
unsigned int	myCompassRadius
double	myCompassHeading
unsigned int	myNorthLetterSize [2]
unsigned int	mySouthLetterSize [2]
unsigned int	myEastLetterSize [2]
unsigned int	myWestLetterSize [2]
float	myDarkTickColor [4]
float	myLightTickColor [4]
bool	myShowSmallTickMarks

---

Detailed Description

Interface for a DtChannelCompassInstance An object that draws a 2D compass.

---

Constructor & Destructor Documentation

makVrv::DtChannelCompassInstance::DtChannelCompassInstance

(

)

CTOR.

virtual makVrv::DtChannelCompassInstance::~DtChannelCompassInstance

(

)

[virtual]

DTOR.

---

Member Function Documentation

virtual void makVrv::DtChannelCompassInstance::setChannelName	(	const std::string &	deName,
		const std::string &	winName,
		const std::string &	channelName
	)		[virtual]

Set the name of the channel that this compass should be drawn on.

Reimplemented in makVrv::DtOsgChannelCompassInstance.

virtual void makVrv::DtChannelCompassInstance::setCompassHeading

(

double

heading

)

[virtual]

set the compass heading

virtual void makVrv::DtChannelCompassInstance::setModelDefinition

(

const std::string &

modelDefinition

)

[virtual]

Set the model definition; note that this (potentially) includes all the other parameters enumeration below.

Reimplemented in makVrv::DtOsgChannelCompassInstance.

virtual void makVrv::DtChannelCompassInstance::setLocation

(

DtChannelCompass::Locations

location

)

[virtual]

Set the compass location.

This is actually an enumeration, but the distributed object interface can't handle those. This will be cast to type DtChannelCompass::Location before being passed on to the instance

DtChannelCompass::Locations makVrv::DtChannelCompassInstance::location

(

)

const

Returns the current location of the compass.

virtual void makVrv::DtChannelCompassInstance::setMargins	(	unsigned int	xMargin,
		unsigned int	yMargin
	)		[virtual]

Set the margins, in pixels.

These define the space between the compass and the closest channel edges, depending on where the compass is located

virtual void makVrv::DtChannelCompassInstance::setNorthLetterFilename

(

const std::string &

filename

)

[virtual]

Set the name of a bitmap / png file that can be used as the North letter image.

Reimplemented in makVrv::DtOsgChannelCompassInstance.

virtual void makVrv::DtChannelCompassInstance::setSouthLetterFilename

(

const std::string &

filename

)

[virtual]

Set the name of a bitmap / png file that can be used as the South letter image.

Reimplemented in makVrv::DtOsgChannelCompassInstance.

virtual void makVrv::DtChannelCompassInstance::setEastLetterFilename

(

const std::string &

filename

)

[virtual]

Set the name of a bitmap / png file that can be used as the East letter image.

Reimplemented in makVrv::DtOsgChannelCompassInstance.

virtual void makVrv::DtChannelCompassInstance::setWestLetterFilename

(

const std::string &

filename

)

[virtual]

Set the name of a bitmap / png file that can be used as the West letter image.

Reimplemented in makVrv::DtOsgChannelCompassInstance.

virtual void makVrv::DtChannelCompassInstance::setCompassRadius

(

unsigned int

radius

)

[virtual]

Set the size of the compass, in pixels.

virtual void makVrv::DtChannelCompassInstance::setNorthLetterSize	(	unsigned int	width,
		unsigned int	height
	)		[virtual]

Set the size of the North Letter, in pixels.

void makVrv::DtChannelCompassInstance::setSouthLetterSize	(	unsigned int	width,
		unsigned int	height
	)

Set the size of the South Letter, in pixels.

virtual void makVrv::DtChannelCompassInstance::setEastLetterSize	(	unsigned int	width,
		unsigned int	height
	)		[virtual]

Set the size of the East Letter, in pixels.

virtual void makVrv::DtChannelCompassInstance::setWestLetterSize	(	unsigned int	width,
		unsigned int	height
	)		[virtual]

Set the size of the West Letter, in pixels.

virtual void makVrv::DtChannelCompassInstance::showSmallTickMarks

(

bool

show

)

[virtual]

show or hide the smaller (every 15 degrees) tick marks

virtual void makVrv::DtChannelCompassInstance::setDarkTickColor	(	float	r,
		float	g,
		float	b,
		float	a
	)		[virtual]

set the color to use for the dark side of tick marks

Reimplemented in makVrv::DtOsgChannelCompassInstance.

virtual void makVrv::DtChannelCompassInstance::setLightTickColor	(	float	r,
		float	g,
		float	b,
		float	a
	)		[virtual]

set the color to use for the light side of tick marks

Reimplemented in makVrv::DtOsgChannelCompassInstance.

virtual void makVrv::DtChannelCompassInstance::updateCompass

(

bool

force = false

)

[pure virtual]

Called anytime any of the compass parameters change, and when the observer heading changes.

Implemented in makVrv::DtOsgChannelCompassInstance.

---

Member Data Documentation

std::string makVrv::DtChannelCompassInstance::myModelDefinitionName [protected]

std::string makVrv::DtChannelCompassInstance::myDisplayEngineName [protected]

std::string makVrv::DtChannelCompassInstance::myWindowName [protected]

std::string makVrv::DtChannelCompassInstance::myChannelName [protected]

DtChannelCompass::Locations makVrv::DtChannelCompassInstance::myLocation [protected]

unsigned int makVrv::DtChannelCompassInstance::myMargins[2] [protected]

std::string makVrv::DtChannelCompassInstance::myNorthLetterFilename [protected]

std::string makVrv::DtChannelCompassInstance::mySouthLetterFilename [protected]

std::string makVrv::DtChannelCompassInstance::myEastLetterFilename [protected]

std::string makVrv::DtChannelCompassInstance::myWestLetterFilename [protected]

unsigned int makVrv::DtChannelCompassInstance::myCompassRadius [protected]

double makVrv::DtChannelCompassInstance::myCompassHeading [protected]

unsigned int makVrv::DtChannelCompassInstance::myNorthLetterSize[2] [protected]

unsigned int makVrv::DtChannelCompassInstance::mySouthLetterSize[2] [protected]

unsigned int makVrv::DtChannelCompassInstance::myEastLetterSize[2] [protected]

unsigned int makVrv::DtChannelCompassInstance::myWestLetterSize[2] [protected]

float makVrv::DtChannelCompassInstance::myDarkTickColor[4] [protected]

float makVrv::DtChannelCompassInstance::myLightTickColor[4] [protected]

bool makVrv::DtChannelCompassInstance::myShowSmallTickMarks [protected]

---

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

• include/vrvCore/DtChannelCompassInstance.h