Interface for receiving window events. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/orxonox/interfaces/RadarViewable.h>

Inheritance diagram for orxonox::RadarViewable:

Public Types
enum	Shape { Shape::Square, Shape::Dot, Shape::Triangle }

Public Member Functions
	RadarViewable (BaseObject creator, const WorldEntity wePtr)
	Constructor. More...

virtual	~RadarViewable ()

const std::string &	getRadarName () const

float	getRadarObjectCamouflage () const

const ColourValue &	getRadarObjectColour () const

float	getRadarObjectScale () const

Shape	getRadarObjectShape () const

bool	getRadarVisibility () const

Vector3	getRVOrientedVelocity () const

Vector3	getRVVelocity () const

const Vector3 &	getRVWorldPosition () const

const std::string &	getUniqueId ()

virtual const WorldEntity *	getWorldEntity () const

virtual void	setRadarName (const std::string &name)

void	setRadarObjectCamouflage (float camouflage)

void	setRadarObjectColour (const ColourValue &colour)

void	setRadarObjectScale (float scale)

void	setRadarObjectShape (Shape shape)

void	setRadarVisibility (bool b)

void	settingsChanged ()

Public Member Functions inherited from orxonox::OrxonoxInterface
	OrxonoxInterface ()

Public Member Functions inherited from orxonox::Configurable
	Configurable ()

void	setConfigValues ()
	Function to collect the SetConfigValue-macro calls. More...

Public Member Functions inherited from orxonox::Listable
	Listable ()
	Constructor: Allocates space in the element list. More...

	Listable (Context *context)
	Constructor: Allocates space in the element list and assigns the context. More...

virtual	~Listable ()
	Destructor: Removes the object from the object-lists. More...

Context *	getContext () const

void	setContext (Context *context)
	Changes the context. More...

void	unregisterObject ()
	Removes this object from the object-lists. More...

Public Member Functions inherited from orxonox::Identifiable
	Identifiable ()
	Constructor: Sets the default values. More...

virtual	~Identifiable ()

ORX_FORCEINLINE void *	getDerivedPointer (unsigned int classID)
	Returns a valid pointer of any derived type that is registered in the class hierarchy. More...

template<class T >
ORX_FORCEINLINE T *	getDerivedPointer (unsigned int classID)
	Version of getDerivedPointer with template. More...

template<class T >
ORX_FORCEINLINE const T *	getDerivedPointer (unsigned int classID) const
	Const version of getDerivedPointer with template. More...

Identifier *	getIdentifier () const
	Returns the Identifier of the object. More...

bool	isA (const Identifier *identifier)
	Returns true if the object's class is of the given type or a derivative. More...

template<class B >
bool	isA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is of the given type or a derivative. More...

bool	isA (const Identifiable *object)
	Returns true if the object's class is of the given type or a derivative. More...

bool	isChildOf (const Identifier *identifier)
	Returns true if the object's class is a child of the given type. More...

template<class B >
bool	isChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a child of the given type. More...

bool	isChildOf (const Identifiable *object)
	Returns true if the object's class is a child of the given type. More...

bool	isDirectChildOf (const Identifier *identifier)
	Returns true if the object's class is a direct child of the given type. More...

template<class B >
bool	isDirectChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct child of the given type. More...

bool	isDirectChildOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...

bool	isDirectParentOf (const Identifier *identifier)
	Returns true if the object's class is a direct parent of the given type. More...

template<class B >
bool	isDirectParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct parent of the given type. More...

bool	isDirectParentOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...

bool	isExactlyA (const Identifier *identifier)
	Returns true if the object's class is exactly of the given type. More...

template<class B >
bool	isExactlyA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is exactly of the given type. More...

bool	isExactlyA (const Identifiable *object)
	Returns true if the object's class is exactly of the given type. More...

bool	isParentOf (const Identifier *identifier)
	Returns true if the object's class is a parent of the given type. More...

template<class B >
bool	isParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a parent of the given type. More...

bool	isParentOf (const Identifiable *object)
	Returns true if the object's class is a parent of the given type. More...

Public Member Functions inherited from orxonox::Destroyable
	Destroyable ()
	Constructor: Sets the default values. More...

virtual	~Destroyable ()
	Destructor: Notifies all DestructionListener (for example weak pointers) that this object is being deleted. More...

void	destroy ()
	Deletes the object if no strong pointers point to this object. More...

void	destroyLater ()
	Works like destroy() but doesn't destroy the object until the current tick has ended. More...

unsigned int	getReferenceCount () const
	Returns the number of strong pointers that point to this object. More...

Public Attributes
bool	isHumanShip_

Private Member Functions
void	validate (const WorldEntity *object) const

Private Attributes
bool	bInitialized_

bool	bVisibility_

StrongPtr< Radar >	radar_

std::string	radarName_

float	radarObjectCamouflage_

ColourValue	radarObjectColour_

std::string	radarObjectDescription_

Shape	radarObjectShape_

float	scale_

std::string	uniqueId_

const WorldEntity *	wePtr_

Additional Inherited Members
Protected Member Functions inherited from orxonox::Destroyable
virtual void	preDestroy ()
	This virtual function is called if destroy() is called and no StrongPtr points to this object. More...

Detailed Description

Interface for receiving window events.

Member Enumeration Documentation

enum orxonox::RadarViewable::Shape

strong

Enumerator
Square
Dot
Triangle

Constructor & Destructor Documentation

orxonox::RadarViewable::RadarViewable	(	BaseObject *	creator,
		const WorldEntity *	wePtr
	)

Constructor.

orxonox::RadarViewable::~RadarViewable ( )

virtual

Member Function Documentation

const std::string& orxonox::RadarViewable::getRadarName ( ) const

inline

float orxonox::RadarViewable::getRadarObjectCamouflage ( ) const

inline

const ColourValue& orxonox::RadarViewable::getRadarObjectColour ( ) const

inline

float orxonox::RadarViewable::getRadarObjectScale ( ) const

inline

Shape orxonox::RadarViewable::getRadarObjectShape ( ) const

inline

bool orxonox::RadarViewable::getRadarVisibility ( ) const

inline

Vector3 orxonox::RadarViewable::getRVOrientedVelocity ( ) const

Vector3 orxonox::RadarViewable::getRVVelocity ( ) const

const Vector3 & orxonox::RadarViewable::getRVWorldPosition ( ) const

const std::string& orxonox::RadarViewable::getUniqueId ( )

inline

virtual const WorldEntity* orxonox::RadarViewable::getWorldEntity ( ) const

inlinevirtual

Reimplemented in orxonox::RaceCheckPoint, and orxonox::CheckPoint.

virtual void orxonox::RadarViewable::setRadarName ( const std::string & name )

inlinevirtual

void orxonox::RadarViewable::setRadarObjectCamouflage ( float camouflage )

inline

void orxonox::RadarViewable::setRadarObjectColour ( const ColourValue & colour )

inline

void orxonox::RadarViewable::setRadarObjectScale ( float scale )

inline

void orxonox::RadarViewable::setRadarObjectShape ( Shape shape )

inline

void orxonox::RadarViewable::setRadarVisibility ( bool b )

inline

void orxonox::RadarViewable::settingsChanged ( )

void orxonox::RadarViewable::validate ( const WorldEntity * object ) const

private

Member Data Documentation

bool orxonox::RadarViewable::bInitialized_

private

bool orxonox::RadarViewable::bVisibility_

private

bool orxonox::RadarViewable::isHumanShip_

StrongPtr<Radar> orxonox::RadarViewable::radar_

private

std::string orxonox::RadarViewable::radarName_

private

float orxonox::RadarViewable::radarObjectCamouflage_

private

ColourValue orxonox::RadarViewable::radarObjectColour_

private

std::string orxonox::RadarViewable::radarObjectDescription_

private

Shape orxonox::RadarViewable::radarObjectShape_

private

float orxonox::RadarViewable::scale_

private

std::string orxonox::RadarViewable::uniqueId_

private

const WorldEntity* orxonox::RadarViewable::wePtr_

private

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

orxonox/interfaces/RadarViewable.h
orxonox/interfaces/RadarViewable.cc

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation