Orxonox  0.0.5 Codename: Arcturus
Public Member Functions | List of all members
orxonox::OrxonoxClass Class Reference

This is the class from which all objects of the game-logic (not the engine) are derived from. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/libraries/core/class/OrxonoxClass.h>

Inheritance diagram for orxonox::OrxonoxClass:
orxonox::Configurable orxonox::Destroyable orxonox::Listable orxonox::Identifiable orxonox::BaseObject orxonox::Answer orxonox::AnswerId orxonox::BarColour orxonox::CollisionShape orxonox::Controller orxonox::CreateStars orxonox::DefaultWeaponmodeLink orxonox::Dialog orxonox::DockingAnimation orxonox::DockingEffect orxonox::EffectContainer orxonox::EventDispatcher orxonox::EventFilter orxonox::EventListener orxonox::EventName orxonox::EventTarget orxonox::Gametype orxonox::GlobalShader orxonox::GUISheet orxonox::Info orxonox::Item orxonox::Level orxonox::LevelInfo orxonox::MeshLodInformation orxonox::MultiTriggerContainer orxonox::Munition orxonox::MunitionContainer orxonox::Namespace orxonox::NotificationDispatcher orxonox::NotificationQueue orxonox::OrxonoxOverlay orxonox::OverlayGroup orxonox::Pickup orxonox::PickupCollection orxonox::PickupRepresentation orxonox::PortalLink orxonox::QuestDescription orxonox::QuestEffect orxonox::Question orxonox::QuestItem orxonox::QuestListener orxonox::ResourceCollection orxonox::ResourceLocation orxonox::Scene orxonox::Script orxonox::SpaceRaceManager orxonox::SpicedAsteroidBelt orxonox::SpicedAsteroidField orxonox::Template orxonox::Test orxonox::WeaponMode orxonox::WeaponPack orxonox::WeaponSet orxonox::WeaponSystem orxonox::WorldAmbientSound orxonox::WorldEntity

Public Member Functions

 OrxonoxClass ()
 
OrxonoxClassoperator= (const OrxonoxClass &)=default
 
- 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...
 

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

This is the class from which all objects of the game-logic (not the engine) are derived from.

Constructor & Destructor Documentation

orxonox::OrxonoxClass::OrxonoxClass ( )

Member Function Documentation

OrxonoxClass& orxonox::OrxonoxClass::operator= ( const OrxonoxClass )
default

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