Orxonox  0.0.5 Codename: Arcturus
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
orxonox::Radar Class Reference

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

Inheritance diagram for orxonox::Radar:
orxonox::Tickable orxonox::OrxonoxInterface orxonox::Configurable orxonox::Destroyable orxonox::Listable orxonox::Identifiable

Public Member Functions

 Radar ()
 
virtual ~Radar ()
 
RadarViewable::Shape addObjectDescription (const std::string &name)
 
void cycleFocus ()
 
const RadarViewablegetFocus ()
 
const std::set< RadarViewable * > & getRadarObjects () const
 
void listObjects () const
 
void releaseFocus ()
 
virtual void tick (float dt) override
 Gets called every frame. More...
 
- 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...
 
ContextgetContext () 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 voidgetDerivedPointer (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...
 
IdentifiergetIdentifier () 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...
 

Private Member Functions

 Radar (Radar &instance)
 
void addRadarObject (RadarViewable *rv)
 
void radarObjectChanged (RadarViewable *rv)
 
void removeRadarObject (RadarViewable *rv)
 
void updateFocus ()
 

Private Attributes

RadarViewablefocus_
 
ObjectList< RadarViewable >::iterator itFocus_
 
int objectTypeCounter_
 
std::map< std::string, RadarViewable::ShapeobjectTypes_
 
std::set< RadarViewable * > radarObjects_
 

Friends

class RadarViewable
 

Additional Inherited Members

- Protected Member Functions inherited from orxonox::Tickable
 Tickable ()
 Constructor: Registers the object in the Tickable-list. More...
 
- 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...
 

Constructor & Destructor Documentation

orxonox::Radar::Radar ( )
orxonox::Radar::~Radar ( )
virtual
orxonox::Radar::Radar ( Radar instance)
private

Member Function Documentation

RadarViewable::Shape orxonox::Radar::addObjectDescription ( const std::string &  name)
void orxonox::Radar::addRadarObject ( RadarViewable rv)
private
void orxonox::Radar::cycleFocus ( )
const RadarViewable * orxonox::Radar::getFocus ( )
const std::set<RadarViewable*>& orxonox::Radar::getRadarObjects ( ) const
inline
void orxonox::Radar::listObjects ( ) const
void orxonox::Radar::radarObjectChanged ( RadarViewable rv)
private
void orxonox::Radar::releaseFocus ( )
void orxonox::Radar::removeRadarObject ( RadarViewable rv)
private
void orxonox::Radar::tick ( float  dt)
overridevirtual

Gets called every frame.

Parameters
dtThe time since the last frame in seconds

Reimplemented from orxonox::Tickable.

void orxonox::Radar::updateFocus ( )
private

Friends And Related Function Documentation

friend class RadarViewable
friend

Member Data Documentation

RadarViewable* orxonox::Radar::focus_
private
ObjectList<RadarViewable>::iterator orxonox::Radar::itFocus_
private
int orxonox::Radar::objectTypeCounter_
private
std::map<std::string, RadarViewable::Shape> orxonox::Radar::objectTypes_
private
std::set<RadarViewable*> orxonox::Radar::radarObjects_
private

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