A model-like object that draws a 2D compass on a channel. More...

Inheritance diagram for makVrv::DtChannelCompass:

Public Types
enum	Locations { Top = 0, TopRight, Right, BottomRight, Bottom, BottomLeft, Left, TopLeft, Center }
	Enumeration of allowable compass locations. More...

Public Member Functions
	DtChannelCompass (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtChannelCompass ()
	DTOR.
virtual void	setInstance (DtChannelCompassInstance *instance)
	Set or replace the compass instance for the compass Transfers ownership.
virtual DtChannelCompassInstance *	instance ()
	Get the compass instance for the compass.
virtual void	setVisible (bool isVisible)
	Set the compass' visibility.
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.
void	setCompassHeading (double heading)
	set the compass heading
void	setModelDefinition (const std::string &modelDefinition)
	Set the model definition; note that this (potentially) includes all the other parameters enumeration below.
void	setLocation (unsigned int location)
	Set the compass location.
unsigned int	location () const
	Returns the current location of the compass.
void	setMargins (unsigned int xMargin, unsigned int yMargin)
	Set the margins, in pixels.
void	setNorthLetterFilename (const std::string &filename)
	Set the name of a bitmap / png file that can be used as the North letter image.
void	setSouthLetterFilename (const std::string &filename)
	Set the name of a bitmap / png file that can be used as the South letter image.
void	setEastLetterFilename (const std::string &filename)
	Set the name of a bitmap / png file that can be used as the East letter image.
void	setWestLetterFilename (const std::string &filename)
	Set the name of a bitmap / png file that can be used as the West letter image.
void	setCompassRadius (unsigned int radius)
	Set the size of the compass, in pixels.
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.
void	setEastLetterSize (unsigned int width, unsigned int height)
	Set the size of the East Letter, in pixels.
void	setWestLetterSize (unsigned int width, unsigned int height)
	Set the size of the West Letter, in pixels.
void	showSmallTickMarks (bool show)
	show or hide the smaller (every 15 degrees) tick marks
void	setDarkTickColor (float r, float g, float b, float a)
	set the color to use for the dark side of tick marks
void	setLightTickColor (float r, float g, float b, float a)
	set the color to use for the light side of tick marks

Protected Attributes
DtChannelCompassInstance *	myInstance

Detailed Description

A model-like object that draws a 2D compass on a channel.

Member Enumeration Documentation

enum makVrv::DtChannelCompass::Locations

Enumeration of allowable compass locations.

Enumerator:

Top
TopRight
Right
BottomRight
Bottom
BottomLeft
Left
TopLeft
Center

Constructor & Destructor Documentation

makVrv::DtChannelCompass::DtChannelCompass	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtChannelCompass::~DtChannelCompass ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtChannelCompass::setInstance ( DtChannelCompassInstance * instance )

virtual

Set or replace the compass instance for the compass Transfers ownership.

virtual DtChannelCompassInstance* makVrv::DtChannelCompass::instance ( )

virtual

Get the compass instance for the compass.

virtual void makVrv::DtChannelCompass::setVisible ( bool isVisible )

virtual

Set the compass' visibility.

void makVrv::DtChannelCompass::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.

void makVrv::DtChannelCompass::setCompassHeading ( double heading )

set the compass heading

void makVrv::DtChannelCompass::setModelDefinition ( const std::string & modelDefinition )

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

void makVrv::DtChannelCompass::setLocation ( unsigned int location )

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

unsigned int makVrv::DtChannelCompass::location ( ) const

Returns the current location of the compass.

void makVrv::DtChannelCompass::setMargins	(	unsigned int	xMargin,
		unsigned int	yMargin
	)

Set the margins, in pixels.

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

void makVrv::DtChannelCompass::setNorthLetterFilename ( const std::string & filename )

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

void makVrv::DtChannelCompass::setSouthLetterFilename ( const std::string & filename )

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

void makVrv::DtChannelCompass::setEastLetterFilename ( const std::string & filename )

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

void makVrv::DtChannelCompass::setWestLetterFilename ( const std::string & filename )

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

void makVrv::DtChannelCompass::setCompassRadius ( unsigned int radius )

Set the size of the compass, in pixels.

void makVrv::DtChannelCompass::setNorthLetterSize	(	unsigned int	width,
		unsigned int	height
	)

Set the size of the North Letter, in pixels.

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

Set the size of the South Letter, in pixels.

void makVrv::DtChannelCompass::setEastLetterSize	(	unsigned int	width,
		unsigned int	height
	)

Set the size of the East Letter, in pixels.

void makVrv::DtChannelCompass::setWestLetterSize	(	unsigned int	width,
		unsigned int	height
	)

Set the size of the West Letter, in pixels.

void makVrv::DtChannelCompass::showSmallTickMarks ( bool show )

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

void makVrv::DtChannelCompass::setDarkTickColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

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

void makVrv::DtChannelCompass::setLightTickColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

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

Member Data Documentation

DtChannelCompassInstance* makVrv::DtChannelCompass::myInstance

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrvCore/DtChannelCompass.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation