Interface for a DtChannel3dViewCompassInstance A model-like object that draws a 3d view first person shooter style compass on a channel.

The fps style compass is a pseudo 3d view where directions rotate into a popout center. The compass is located at the top center of the display.

Inheritance diagram for makVrv::DtChannel3dViewCompassInstance:

[legend]

Public Member Functions
	DtChannel3dViewCompassInstance (DtDe &de)

virtual	~DtChannel3dViewCompassInstance ()

	DtChannel3dViewCompassInstance (const DtChannel3dViewCompassInstance &other)=delete

DtChannel3dViewCompassInstance &	operator= (const DtChannel3dViewCompassInstance &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	setMargins (int xMargin, int yMargin)

virtual void	setDarkTickColor (float r, float g, float b, float a)

virtual void	setLightTickColor (float r, float g, float b, float a)

virtual void	setSymbolColor (float r, float g, float b, float a)

virtual void	setPopoutSymbolColor (float r, float g, float b, float a)

virtual void	setSymbolsFilename (const std::string &filename)

virtual void	setWidth (unsigned int width)

virtual void	setSymbolSize (unsigned int size)

virtual void	setPopoutSymbolSize (unsigned int size)

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

int	myMargins [2]

double	myCompassHeading

double	myCompassDeclination

float	myDarkTickColor [4]

float	myLightTickColor [4]

unsigned int	myCompassWidth

unsigned int	myCompassSymbolSize

unsigned int	myCompassPopoutSymbolSize

std::string	myCompassSymbolsFilename

float	mySymbolColor [4]

float	myPopoutSymbolColor [4]

DtDe &	myDe

Constructor & Destructor Documentation

makVrv::DtChannel3dViewCompassInstance::DtChannel3dViewCompassInstance ( DtDe & de )

CTOR.

virtual makVrv::DtChannel3dViewCompassInstance::~DtChannel3dViewCompassInstance ( )

virtual

DTOR.

makVrv::DtChannel3dViewCompassInstance::DtChannel3dViewCompassInstance ( const DtChannel3dViewCompassInstance & other )

delete

Copy Constructor not implemented - Copy not allowed.

Member Function Documentation

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

delete

Assignment Operator not implemented - Assignment not allowed.

virtual void makVrv::DtChannel3dViewCompassInstance::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::DtOsgChannel3dViewCompassInstance.

virtual void makVrv::DtChannel3dViewCompassInstance::setCompassHeading ( double heading )

virtual

set the compass heading

virtual void makVrv::DtChannel3dViewCompassInstance::setModelDefinition ( const std::string & modelDefinition )

virtual

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

Reimplemented in makVrv::DtOsgChannel3dViewCompassInstance.

virtual void makVrv::DtChannel3dViewCompassInstance::setMargins	(	int	xMargin,
		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::DtChannel3dViewCompassInstance::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::DtOsgChannel3dViewCompassInstance.

virtual void makVrv::DtChannel3dViewCompassInstance::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::DtOsgChannel3dViewCompassInstance.

virtual void makVrv::DtChannel3dViewCompassInstance::setSymbolColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

set the color to use for the symbols

virtual void makVrv::DtChannel3dViewCompassInstance::setPopoutSymbolColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

set the color to use for the popout (center) symbols

virtual void makVrv::DtChannel3dViewCompassInstance::setSymbolsFilename ( const std::string & filename )

virtual

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

Reimplemented in makVrv::DtOsgChannel3dViewCompassInstance.

virtual void makVrv::DtChannel3dViewCompassInstance::setWidth ( unsigned int width )

virtual

Set the compass width.

virtual void makVrv::DtChannel3dViewCompassInstance::setSymbolSize ( unsigned int size )

virtual

Set the size in pixels for the symbols.

virtual void makVrv::DtChannel3dViewCompassInstance::setPopoutSymbolSize ( unsigned int size )

virtual

Set the size in pixels for the popout (center) symbols.

virtual void makVrv::DtChannel3dViewCompassInstance::updateCompass ( bool force = false )

pure virtual

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

Implemented in makVrv::DtOsgChannel3dViewCompassInstance.

Member Data Documentation

std::string makVrv::DtChannel3dViewCompassInstance::myModelDefinitionName

protected

std::string makVrv::DtChannel3dViewCompassInstance::myDisplayEngineName

protected

std::string makVrv::DtChannel3dViewCompassInstance::myWindowName

protected

std::string makVrv::DtChannel3dViewCompassInstance::myChannelName

protected

int makVrv::DtChannel3dViewCompassInstance::myMargins[2]

protected

double makVrv::DtChannel3dViewCompassInstance::myCompassHeading

protected

double makVrv::DtChannel3dViewCompassInstance::myCompassDeclination

protected

float makVrv::DtChannel3dViewCompassInstance::myDarkTickColor[4]

protected

float makVrv::DtChannel3dViewCompassInstance::myLightTickColor[4]

protected

unsigned int makVrv::DtChannel3dViewCompassInstance::myCompassWidth

protected

unsigned int makVrv::DtChannel3dViewCompassInstance::myCompassSymbolSize

protected

unsigned int makVrv::DtChannel3dViewCompassInstance::myCompassPopoutSymbolSize

protected

std::string makVrv::DtChannel3dViewCompassInstance::myCompassSymbolsFilename

protected

float makVrv::DtChannel3dViewCompassInstance::mySymbolColor[4]

protected

float makVrv::DtChannel3dViewCompassInstance::myPopoutSymbolColor[4]

protected

DtDe& makVrv::DtChannel3dViewCompassInstance::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/DtChannel3dViewCompassInstance.h

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation