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

The Tickable interface provides a tick(dt) function, that gets called every frame. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/libraries/tools/interfaces/Tickable.h>

Inheritance diagram for orxonox::Tickable:
orxonox::OrxonoxInterface orxonox::Configurable orxonox::Destroyable orxonox::Listable orxonox::Identifiable orxonox::ActionpointController orxonox::AIController orxonox::AnimatedModel orxonox::ArrowController orxonox::Asteroids2DHUDinfo orxonox::AutonomousDroneController orxonox::BlinkingBillboard orxonox::Camera orxonox::CountDown orxonox::DamageBoostPickup orxonox::DebugFPSText orxonox::DebugPositionText orxonox::DebugRTRText orxonox::DockingController orxonox::DodgeRaceHUDinfo orxonox::DroneController orxonox::DronePickup orxonox::FadeoutText orxonox::FadingBillboard orxonox::FlagHUD orxonox::FlappyOrxHUDinfo orxonox::ForceField orxonox::Gametype orxonox::HealthPickup orxonox::HUDBoostBar orxonox::HUDHealthBar orxonox::HUDNavigation orxonox::HUDPickupSystem orxonox::HUDRocketFuelBar orxonox::HUDShieldBar orxonox::HUDSpeedBar orxonox::HUDTimer orxonox::HUDWeapon orxonox::HUDWeaponMode orxonox::HumanController orxonox::InvaderHUDinfo orxonox::JumpScore orxonox::LastManStandingInfos orxonox::LastTeamStandingInfos orxonox::LensFlare orxonox::MasterController orxonox::MobileEntity orxonox::NotificationQueue orxonox::OrxyRoadHUDinfo orxonox::PacmanHUDinfo orxonox::PickupSpawner orxonox::Planet orxonox::PongAI orxonox::PongScore orxonox::Radar orxonox::RocketController orxonox::Scene orxonox::Scoreboard orxonox::ScriptController orxonox::ShrinkPickup orxonox::ShroomHUD orxonox::SkyboxGenerator orxonox::SOBHUDInfo orxonox::SpaceBoundaries orxonox::SpaceRaceController orxonox::SpaceRaceManager orxonox::SpicedAsteroidBelt orxonox::SpicedAsteroidField orxonox::Stats orxonox::StoryModeHUD orxonox::TeamBaseMatchScore orxonox::TeamTargetProxy orxonox::Test orxonox::TetrisScore orxonox::TimeHUD orxonox::TimeHUD orxonox::TowerDefenseHUDController orxonox::TriggerBase orxonox::TurretController orxonox::WagnisHUD orxonox::WagnisHUDinfo orxonox::WagnisPlayer orxonox::WaypointController orxonox::WorldSound

Public Member Functions

virtual void tick (float dt)
 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...
 

Protected Member Functions

 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...
 

Detailed Description

The Tickable interface provides a tick(dt) function, that gets called every frame.

Constructor & Destructor Documentation

orxonox::Tickable::Tickable ( )
protected

Constructor: Registers the object in the Tickable-list.

Member Function Documentation

virtual void orxonox::Tickable::tick ( float  dt)
inlinevirtual

Gets called every frame.

Parameters
dtThe time since the last frame in seconds

Reimplemented in orxonox::LensFlare, orxonox::MultiTrigger, orxonox::Dynamicmatch, orxonox::NotificationQueue, orxonox::Scene, orxonox::SpaceBoundaries, orxonox::SpaceShip, orxonox::ForceField, orxonox::HealthPickup, orxonox::AsteroidMinable, orxonox::ActionpointController, orxonox::Trigger, orxonox::PickupSpawner, orxonox::LastManStanding, orxonox::LastTeamStanding, orxonox::ShrinkPickup, orxonox::Gametype, orxonox::DodgeRace, orxonox::OrxyRoad, orxonox::ScriptController, orxonox::SpaceRaceManager, orxonox::Turret, orxonox::Pacman, orxonox::PongAI, orxonox::SkyboxGenerator, orxonox::Pawn, orxonox::SpicedAsteroidBelt, orxonox::Wagnis, orxonox::Projectile, orxonox::MasterController, orxonox::SpaceRace, orxonox::PongBall, orxonox::Rocket, orxonox::RocketOld, orxonox::SimpleRocket, orxonox::Tetris, orxonox::PongBat, orxonox::PongScore, orxonox::TetrisScore, orxonox::SpicedAsteroidField, orxonox::Asteroids2D, orxonox::MobileEntity, orxonox::RocketController, orxonox::ControllableEntity, orxonox::HUDWeaponMode, orxonox::TowerDefense, orxonox::Radar, orxonox::HUDWeapon, orxonox::WagnisProjectile, orxonox::DroneController, orxonox::Test, orxonox::AutonomousDrone, orxonox::ScriptableControllerDrone, orxonox::DodgeRaceShip, orxonox::Planet, orxonox::OrxyRoadShip, orxonox::HUDNavigation, orxonox::TowerDefenseHUDController, orxonox::FlappyOrxShip, orxonox::TeamTargetProxy, orxonox::SOBFireball, orxonox::SOBTube, orxonox::ArrowController, orxonox::AnimatedModel, orxonox::WorldSound, orxonox::Drone, orxonox::Asteroids2DStone, orxonox::SpaceRaceController, orxonox::Hover, orxonox::OrxoKart, orxonox::PacmanGelb, orxonox::WagnisHUD, orxonox::Camera, orxonox::ShroomHUD, orxonox::HUDRocketFuelBar, orxonox::HUDShieldBar, orxonox::AutonomousDroneController, orxonox::Asteroids2DShip, orxonox::HUDPickupSystem, orxonox::StoryModeHUD, orxonox::SOBGumba, orxonox::SOBGumbaBoss, orxonox::SOBMushroom, orxonox::FlagHUD, orxonox::InvaderEnemyShooter, orxonox::InvaderShip, orxonox::JumpItem, orxonox::TurretController, orxonox::TimeHUD, orxonox::SOB, orxonox::SOBCoin, orxonox::HumanController, orxonox::FadingBillboard, orxonox::FpsPlayer, orxonox::InvaderEnemy, orxonox::JumpEnemy, orxonox::JumpPlatform, orxonox::JumpPlatformTimer, orxonox::OrxyRoadHUDinfo, orxonox::CountDown, orxonox::HUDHealthBar, orxonox::Stats, orxonox::Backlight, orxonox::BlinkingBillboard, orxonox::DockingController, orxonox::TimeHUD, orxonox::FadeoutText, orxonox::HUDEnemyShieldBar, orxonox::PacmanGhost, orxonox::PacmanPointAfraid, orxonox::PacmanPointSphere, orxonox::NewHumanController, orxonox::DodgeRaceHUDinfo, orxonox::JumpScore, orxonox::HUDSpeedBar, orxonox::Scoreboard, orxonox::AIController, orxonox::WaypointController, orxonox::WaypointPatrolController, orxonox::Spectator, orxonox::Asteroids2DHUDinfo, orxonox::JumpProjectile, orxonox::DebugFPSText, orxonox::DebugPositionText, orxonox::DebugRTRText, orxonox::HUDBoostBar, orxonox::HUDTimer, orxonox::LastManStandingInfos, orxonox::LastTeamStandingInfos, orxonox::TeamBaseMatchScore, orxonox::UnderAttack, orxonox::ExplosionChunk, orxonox::PacmanHUDinfo, orxonox::SOBFigure, orxonox::Mission, orxonox::FlappyOrxHUDinfo, orxonox::JumpFigure, orxonox::JumpPlatformHMove, orxonox::HUDEnemyHealthBar, orxonox::TowerDefenseSelecter, orxonox::GravityBomb, orxonox::Asteroids, orxonox::InvaderHUDinfo, orxonox::Jump, orxonox::JumpBoots, orxonox::JumpPlatformVMove, orxonox::JumpPropeller, orxonox::JumpRocket, orxonox::JumpShield, orxonox::JumpSpring, orxonox::SOBHUDInfo, orxonox::WagnisHUDinfo, orxonox::GravityBombField, and orxonox::WagnisPlayer.


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