makVrv::DtOsgChannelCompass Class Reference

OSG implementation of 2D compass. More...

Inheritance diagram for makVrv::DtOsgChannelCompass:

Public Member Functions
	DtOsgChannelCompass (DtDe &de, DtUniqueID &id)
virtual	~DtOsgChannelCompass ()
Public Member Functions inherited from makVrv::DtChannelCompass
	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

Additional Inherited Members
Public Types inherited from makVrv::DtChannelCompass
enum	Locations {   Top = 0, TopRight, Right, BottomRight,   Bottom, BottomLeft, Left, TopLeft,   Center }
	Enumeration of allowable compass locations. More...
Protected Attributes inherited from makVrv::DtChannelCompass
DtChannelCompassInstance *	myInstance

Detailed Description

OSG implementation of 2D compass.

Constructor & Destructor Documentation

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

virtual makVrv::DtOsgChannelCompass::~DtOsgChannelCompass ( )

virtual

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrvOsg/DtOsgChannelCompass.h