makVrv::DtChannelCompassInstance Class Reference

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

Inheritance diagram for makVrv::DtChannelCompassInstance:

Public Member Functions
	DtChannelCompassInstance (DtDe &de)
virtual	~DtChannelCompassInstance ()
	DtChannelCompassInstance (const DtChannelCompassInstance &other)=delete
DtChannelCompassInstance &	operator= (const DtChannelCompassInstance &other)=delete
virtual void	setChannelName (const std::string &deName, const std::string &winName, const std::string &channelName)
virtual void	setCompassHeading (double heading)
virtual void	setModelDefinition (const std::string &modelDefinition)
virtual void	setLocation (DtChannelCompass::Locations location)
DtChannelCompass::Locations	location () const
virtual void	setMargins (unsigned int xMargin, unsigned int yMargin)
virtual void	setNorthLetterFilename (const std::string &filename)
virtual void	setSouthLetterFilename (const std::string &filename)
virtual void	setEastLetterFilename (const std::string &filename)
virtual void	setWestLetterFilename (const std::string &filename)
virtual void	setStarFilename (const std::string &filename)
virtual void	setCompassRadius (unsigned int radius)
virtual void	setNorthLetterSize (unsigned int width, unsigned int height)
void	setSouthLetterSize (unsigned int width, unsigned int height)
virtual void	setEastLetterSize (unsigned int width, unsigned int height)
virtual void	setWestLetterSize (unsigned int width, unsigned int height)
virtual void	setStarSize (unsigned int width, unsigned int height)
virtual void	showSmallTickMarks (bool show)
virtual void	setDarkTickColor (float r, float g, float b, float a)
virtual void	setLightTickColor (float r, float g, float b, float a)
virtual void	updateCompass (bool force=false)=0
Public Member Functions inherited from makVrv::DtSetVisibilityInterface
virtual	~DtSetVisibilityInterface ()
virtual void	setVisible (bool visible)=0

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
std::string	myStarFilename
unsigned int	myCompassRadius
double	myCompassHeading
double	myCompassDeclination
unsigned int	myNorthLetterSize [2]
unsigned int	mySouthLetterSize [2]
unsigned int	myEastLetterSize [2]
unsigned int	myWestLetterSize [2]
unsigned int	myStarSize [2]
float	myDarkTickColor [4]
float	myLightTickColor [4]
bool	myShowSmallTickMarks
DtDe &	myDe

Constructor & Destructor Documentation

makVrv::DtChannelCompassInstance::DtChannelCompassInstance

(

DtDe &

de

)

CTOR.

virtual makVrv::DtChannelCompassInstance::~DtChannelCompassInstance ( )

virtual

DTOR.

makVrv::DtChannelCompassInstance::DtChannelCompassInstance ( const DtChannelCompassInstance &  other )

delete

Copy Constructor not implemented - Copy not allowed.

Member Function Documentation

DtChannelCompassInstance& makVrv::DtChannelCompassInstance::operator= ( const DtChannelCompassInstance &  other )

delete

Assignment Operator not implemented - Assignment not allowed.

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::setStarFilename ( const std::string &  filename )

virtual

Set the name of a bitmap / png file that can be used as the Star 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::setStarSize ( unsigned int  width, unsigned int  height  )

virtual

Set the size of the Star, 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

std::string makVrv::DtChannelCompassInstance::myStarFilename

protected

unsigned int makVrv::DtChannelCompassInstance::myCompassRadius

protected

double makVrv::DtChannelCompassInstance::myCompassHeading

protected

double makVrv::DtChannelCompassInstance::myCompassDeclination

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

unsigned int makVrv::DtChannelCompassInstance::myStarSize[2]

protected

float makVrv::DtChannelCompassInstance::myDarkTickColor[4]

protected

float makVrv::DtChannelCompassInstance::myLightTickColor[4]

protected

bool makVrv::DtChannelCompassInstance::myShowSmallTickMarks

protected

DtDe& makVrv::DtChannelCompassInstance::myDe

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtChannelCompassInstance.h