makVrv::DtChannel3dViewCompass Class Reference

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

Inheritance diagram for makVrv::DtChannel3dViewCompass:

Public Member Functions
	DtChannel3dViewCompass (DtDe &de, DtUniqueID id)
	CTOR. More...
virtual	~DtChannel3dViewCompass ()
	DTOR. More...
	DtChannel3dViewCompass ()=delete
	Default Constructor not implemented. More...
	DtChannel3dViewCompass (const DtChannel3dViewCompass &other)=delete
	Copy Constructor not implemented - Copy not allowed. More...
DtChannel3dViewCompass &	operator= (const DtChannel3dViewCompass &other)=delete
	Assignment Operator not implemented - Assignment not allowed. More...
virtual void	setInstance (DtChannel3dViewCompassInstance *instance)
	Set or replace the compass instance for the compass Transfers ownership. More...
virtual DtChannel3dViewCompassInstance *	instance ()
	Get the compass instance for the compass. More...
virtual void	setVisible (bool isVisible)
	Set the compass' visibility. More...
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. More...
void	setCompassHeading (double heading)
	Set the compass heading. More...
void	setModelDefinition (const std::string &modelDefinition)
	Set the model definition; note that this (potentially) includes all the other parameters enumeration below. More...
void	setMargins (int xMargin, int yMargin)
	Set the margins, in pixels. More...
void	setDarkTickColor (float r, float g, float b, float a)
	set the color to use for the dark side of tick marks More...
void	setLightTickColor (float r, float g, float b, float a)
	set the color to use for the light side of tick marks More...
void	setSymbolColor (float r, float g, float b, float a)
	set the color to use for the symbols More...
void	setPopoutSymbolColor (float r, float g, float b, float a)
	set the color to use for the popout (center) symbols More...
void	setSymbolsFilename (const std::string &filename)
	Set the name of a bitmap / png file that can be used as the symbols image. More...
void	setWidth (unsigned int width)
	Set the compass width. More...
void	setSymbolSize (unsigned int size)
	Set the size in pixels for the symbols. More...
void	setPopoutSymbolSize (unsigned int size)
	Set the size in pixels for the popout (center) symbols. More...

Protected Attributes
DtChannel3dViewCompassInstance *	myInstance

Detailed Description

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.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtChannel3dViewCompass::~DtChannel3dViewCompass ( )

virtual

DTOR.

makVrv::DtChannel3dViewCompass::DtChannel3dViewCompass ( )

delete

Default Constructor not implemented.

makVrv::DtChannel3dViewCompass::DtChannel3dViewCompass ( const DtChannel3dViewCompass &  other )

delete

Copy Constructor not implemented - Copy not allowed.

Member Function Documentation

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

delete

Assignment Operator not implemented - Assignment not allowed.

virtual void makVrv::DtChannel3dViewCompass::setInstance ( DtChannel3dViewCompassInstance *  instance )

virtual

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

virtual DtChannel3dViewCompassInstance* makVrv::DtChannel3dViewCompass::instance ( )

virtual

Get the compass instance for the compass.

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

virtual

Set the compass' visibility.

void makVrv::DtChannel3dViewCompass::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::DtChannel3dViewCompass::setCompassHeading

(

double

heading

)

Set the compass heading.

void makVrv::DtChannel3dViewCompass::setModelDefinition

(

const std::string &

modelDefinition

)

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

void makVrv::DtChannel3dViewCompass::setMargins	(	int	xMargin,
		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::DtChannel3dViewCompass::setDarkTickColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

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

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

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

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

set the color to use for the symbols

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

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

void makVrv::DtChannel3dViewCompass::setSymbolsFilename

(

const std::string &

filename

)

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

void makVrv::DtChannel3dViewCompass::setWidth

(

unsigned int

width

)

Set the compass width.

void makVrv::DtChannel3dViewCompass::setSymbolSize

(

unsigned int

size

)

Set the size in pixels for the symbols.

void makVrv::DtChannel3dViewCompass::setPopoutSymbolSize

(

unsigned int

size

)

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

Member Data Documentation

DtChannel3dViewCompassInstance* makVrv::DtChannel3dViewCompass::myInstance

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtChannel3dViewCompass.h