dtCore::Compass Class Reference

A special visual Object which constantly aligns with the world axes. More...

#include <compass.h>

Inheritance diagram for dtCore::Compass:

List of all members.

Public Member Functions
	Compass (dtCore::Camera *cam)
void	GetScreenPosition (float &x, float &y) const
	PUBLIC MEMBER FUNCTIONS.
osg::Vec2	GetScreenPosition () const
void	SetScreenPosition (float x, float y)
void	SetScreenPosition (const osg::Vec2 &xy)
dtCore::Camera *	GetCamera ()
	Returns: returns a pointer to the current camera
void	SetCamera (dtCore::Camera *cam)
Protected Member Functions
virtual	~Compass ()

---

Detailed Description

A special visual Object which constantly aligns with the world axes.

The Compass represents visual axes in the Scene. The Compass is positioned by screen space and is set in it's own renderbin to render after everything else. The compass is derived from Transformable so the user could manipulate it's translations, however, this is discouraged.

The Compass must be added to a Scene to be viewed using Scene::AddDrawable().

---

Constructor & Destructor Documentation

Compass::Compass

(

dtCore::Camera *

cam

)

Compass::~Compass

(

)

[protected, virtual]

---

Member Function Documentation

void Compass::GetScreenPosition	(	float &	x,
		float &	y
	)			const

PUBLIC MEMBER FUNCTIONS.

osg::Vec2 Compass::GetScreenPosition

(

)

const

void Compass::SetScreenPosition	(	float	x,
		float	y
	)

void Compass::SetScreenPosition

(

const osg::Vec2 &

xy

)

dtCore::Camera * Compass::GetCamera

(

)

Returns:

returns a pointer to the current camera

void Compass::SetCamera

(

dtCore::Camera *

cam

)

---