Implements a Pong minigame (Wikipedia::Pong). More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/modules/pong/Pong.h>

Inheritance diagram for orxonox::Pong:

Public Member Functions
	Pong (Context *context)
	Constructor. Registers and initializes the object. More...

virtual	~Pong ()
	Destructor. Cleans up, if initialized. More...

virtual void	end () override
	Ends the Pong minigame. More...

PlayerInfo *	getLeftPlayer () const
	Get the left player. More...

PlayerInfo *	getRightPlayer () const
	Get the right player. More...

virtual void	playerScored (PlayerInfo *player, int score=1) override
	Is called when the player scored. More...

void	setCenterpoint (PongCenterpoint *center)
	Set the PongCenterpoint (the playing field). More...

void	setConfigValues ()
	Makes scoreLimit configurable. More...

virtual void	spawnPlayer (PlayerInfo *player) override
	!< Ends the Pong minigame. More...

virtual void	start () override
	Starts the Pong minigame. More...

Public Member Functions inherited from orxonox::Deathmatch
	Deathmatch (Context *context)

virtual	~Deathmatch ()

virtual void	pawnKilled (Pawn victim, Pawn killer=nullptr) override

virtual bool	playerChangedName (PlayerInfo *player) override

virtual void	playerEntered (PlayerInfo *player) override

virtual bool	playerLeft (PlayerInfo *player) override

Public Member Functions inherited from orxonox::Gametype
	Gametype (Context *context)

virtual	~Gametype ()

virtual void	addBots (unsigned int amount)

virtual void	addTime (float t)

virtual bool	allowPawnDamage (Pawn victim, Pawn originator=nullptr)

virtual bool	allowPawnDeath (Pawn victim, Pawn originator=nullptr)

virtual bool	allowPawnHit (Pawn victim, Pawn originator=nullptr)

const GametypeInfo *	getGametypeInfo () const

const std::string &	getHUDTemplate () const

unsigned int	getNumberOfPlayers () const
	Get number of Players in game. More...

const std::map< PlayerInfo *, Player > &	getPlayers () const

int	getScore (PlayerInfo *player) const

float	getStartCountdown () const

float	getTime ()

bool	getTimerIsActive ()

bool	hasEnded () const

bool	hasStarted () const

virtual void	init ()
	Initializes sub-objects of the Gametype. More...

bool	isStartCountdownRunning () const

void	killBots (unsigned int amount=0)

virtual void	pawnPostSpawn (Pawn *pawn)

virtual void	pawnPreSpawn (Pawn *pawn)

virtual void	playerPostSpawn (PlayerInfo *player)

virtual void	playerPreSpawn (PlayerInfo *player)

virtual void	playerStartsControllingPawn (PlayerInfo player, Pawn pawn)

virtual void	playerStopsControllingPawn (PlayerInfo player, Pawn pawn)

virtual void	playerSwitched (PlayerInfo player, Gametype newgametype)

virtual void	playerSwitchedBack (PlayerInfo player, Gametype oldgametype)

void	registerSpawnPoint (SpawnPoint *spawnpoint)

virtual void	removeTime (float t)

virtual void	resetTimer ()

virtual void	resetTimer (float t)

void	setConfigValues ()

void	setHUDTemplate (const std::string &name)

void	setTimeLimit (float t)

void	showMenu ()

void	startTimer ()

void	stopTimer ()

virtual void	tick (float dt) override
	Gets called every frame. More...

Public Member Functions inherited from orxonox::BaseObject
	BaseObject (Context *context)
	Constructor: Registers the object in the BaseObject-list. More...

virtual	~BaseObject ()
	Destructor. More...

void	addEventListener (BaseObject *listener)
	Adds an object which listens to the events of this object. More...

void	addEventSource (BaseObject *source, const std::string &state)
	Adds a new event source for a specific state. More...

void	addTemplate (const std::string &name)
	Adds a Template to the object. More...

void	addTemplate (Template *temp)
	Adds a Template to the object. More...

virtual void	changedActivity ()
	This function gets called if the activity of the object changes. More...

virtual void	changedMainStateName ()
	This function gets called if the main state name of the object changes. More...

virtual void	changedName ()
	This function gets called if the name of the object changes. More...

virtual void	changedVisibility ()
	This function gets called if the visibility of the object changes. More...

void	fireEvent (const std::string &name="")
	Fires an event (without a state). More...

void	fireEvent (bool activate, const std::string &name="")
	Fires an event which activates or deactivates a state. More...

void	fireEvent (bool activate, BaseObject *originator, const std::string &name="")
	Fires an event which activates or deactivates a state with agiven originator (the object which triggered the event). More...

void	fireEvent (Event &event)
	Fires an event, using the Event struct. More...

BaseObject *	getCreator () const

BaseObject *	getEventListener (unsigned int index) const
	Returns an event listener with a given index. More...

BaseObject *	getEventSource (unsigned int index, const std::string &state) const
	Returns an eventsource with a given index. More...

const XMLFile *	getFile () const
	Returns a pointer to the XMLFile that loaded this object. More...

const std::string &	getFilename () const
	Returns the levelfile that loaded this object. More...

Gametype *	getGametype () const

Level *	getLevel () const

const std::string &	getLoaderIndentation () const
	Returns the indentation of the debug output in the Loader. More...

const std::string &	getMainStateName () const
	Returns the name of the main state. More...

const std::string &	getName () const
	Returns the name of the object. More...

Namespace *	getNamespace () const

const std::string &	getOldName () const
	Returns the old name of the object. More...

Scene *	getScene () const

virtual uint32_t	getSceneID () const

const std::set< Template * > &	getTemplates () const
	Returns the set of all aplied templates. More...

const mbool &	isActive () const
	Returns the state of the objects activity. More...

bool	isInitialized () const
	Returns if the object was initialized (passed the object registration). More...

const mbool &	isVisible () const
	Returns the state of the objects visibility. More...

virtual void	processEvent (Event &event)
	Processing an event by calling the right main state. More...

void	removeEventSource (BaseObject *source)
	Removes an eventsource (but doesn't unregister itself at the source). More...

void	setActive (bool bActive)
	Sets the state of the objects activity. More...

void	setCreator (BaseObject *creator)

void	setFile (const XMLFile *file)
	Sets a pointer to the xml file that loaded this object. More...

void	setGametype (const StrongOrWeakPtr< Gametype > &gametype)

void	setLevel (const StrongOrWeakPtr< Level > &level)

void	setLoaderIndentation (const std::string &indentation)
	Sets the indentation of the debug output in the Loader. More...

void	setMainState (bool state)
	Sets the main state of the object to a given boolean value. More...

void	setMainStateName (const std::string &name)
	Sets the name of the main state (used for event reactions). More...

void	setName (const std::string &name)
	Sets the name of the object. More...

void	setNamespace (const StrongOrWeakPtr< Namespace > &ns)

void	setScene (const StrongOrWeakPtr< Scene > &scene, uint32_t sceneID)

void	setVisible (bool bVisible)
	Sets the state of the objects visibility. More...

virtual void	XMLEventPort (Element &xmlelement, XMLPort::Mode mode)
	Defines the possible event states of this object and parses eventsources from an XML file. More...

virtual void	XMLPort (Element &xmlelement, XMLPort::Mode mode)
	XML loading and saving. More...

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

OrxonoxClass &	operator= (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...

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 Member Functions inherited from orxonox::OrxonoxInterface
	OrxonoxInterface ()

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

Protected Member Functions
void	cleanup ()
	Cleans up the Gametype by destroying the ball and the bats. More...

virtual void	spawnPlayersIfRequested () override
	Spawns players, and fills the rest up with bots. More...

void	startBall ()
	Starts the ball with some default speed. More...

Protected Member Functions inherited from orxonox::Gametype
virtual void	assignDefaultPawnsIfNeeded ()

virtual void	checkStart ()

virtual GSLevelMementoState *	exportMementoState () override
	Returns the state of this memento. More...

virtual SpawnPoint *	getBestSpawnPoint (PlayerInfo *player) const

virtual void	importMementoState (const std::vector< GSLevelMementoState * > &states) override
	A list of the states of all mementos. More...

virtual void	spawnDeadPlayersIfRequested ()

virtual void	spawnPlayerAsDefaultPawn (PlayerInfo *player)

Protected Member Functions inherited from orxonox::BaseObject
void	addEventState (const std::string &name, EventState *container)
	Adds a new event-state to the object. More...

EventState *	getEventState (const std::string &name) const
	Returns the event-state with the given name. 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...

Protected Member Functions inherited from orxonox::Tickable
	Tickable ()
	Constructor: Registers the object in the Tickable-list. More...

Protected Attributes
WeakPtr< PongBall >	ball_
	The Pong ball. More...

WeakPtr< PongBat >	bat_ [2]
	The two bats. More...

WeakPtr< PongCenterpoint >	center_
	The playing field. More...

int	scoreLimit_
	If a player scored that much points, the game is ended. More...

Timer	starttimer_
	A timer to delay the start of the game. More...

Protected Attributes inherited from orxonox::Gametype
bool	bAutoEnd_

bool	bAutoStart_

bool	bForceSpawn_

SubclassIdentifier< Bot >	botclass_

SubclassIdentifier< ControllableEntity >	defaultControllableEntity_

WeakPtr< GametypeInfo >	gtinfo_

float	initialStartCountdown_

unsigned int	numberOfBots_

std::map< PlayerInfo *, Player >	players_

OverlayGroup *	scoreboard_

std::string	scoreboardTemplate_

Timer	showMenuTimer_

std::set< SpawnPoint * >	spawnpoints_

float	time_

float	timeLimit_

bool	timerIsActive_

Protected Attributes inherited from orxonox::BaseObject
mbool	bActive_
	True = the object is active. More...

mbool	bVisible_
	True = the object is visible. More...

FunctorPtr	mainStateFunctor_

std::string	mainStateName_

std::string	name_
	The name of the object. More...

std::set< std::string >	networkTemplateNames_

std::string	oldName_
	The old name of the object. More...

Additional Inherited Members
Static Public Member Functions inherited from orxonox::BaseObject
static void	loadAllEventStates (Element &xmlelement, XMLPort::Mode mode, BaseObject object, Identifier identifier)
	Manually loads all event states, even if the class doesn't officially support them. More...

Detailed Description

Implements a Pong minigame (Wikipedia::Pong).

It connects the different entities present in a game of Pong.

The PongCenterpoint is the playing field for the Pong minigame, it allows for configuration of the minigame, e.g. by setting the size of the playing field, or the length of the PongBats. The playing field is always in the x,y-plane, the x-axis being the horizontal and the z-axis being the vertical axis.
The Pong class redistributes the important parameters defined in PongCenterpoint to the other entities, that need to know them, e.g. the PongBall and the PongBats.
The PongCenterpoint needs to exist in a level with the Gametype Pong.
The PongBall is the ball both players play with. The PongBall both implements the movement of the ball, as well as the influence of the boundaries and consequently, also the bouncing (off the upper and lower delimiters, and as off the PongBats) of the ball and the effects of the failure of a player to catch the ball (i.e. the scoring of the other player).
The two PongBats are the entities through which the players can actively participate in the game, by controlling them. The PongBat class manages the movement (and restrictions thereof) and the influence of the players on the bats.

Author: Fabian 'x3n' Landau

Constructor & Destructor Documentation

orxonox::Pong::Pong ( Context * context )

Constructor. Registers and initializes the object.

Constructor.

Registers and initializes the object.

orxonox::Pong::~Pong ( )

virtual

Destructor. Cleans up, if initialized.

Destructor.

Cleans up, if initialized.

Member Function Documentation

void orxonox::Pong::cleanup ( void )

protected

Cleans up the Gametype by destroying the ball and the bats.

void orxonox::Pong::end ( void )

overridevirtual

Ends the Pong minigame.

Reimplemented from orxonox::Deathmatch.

PlayerInfo * orxonox::Pong::getLeftPlayer ( ) const

Get the left player.

Returns: Returns a pointer to the player playing on the left. If there is no left player, nullptr is returned.

PlayerInfo * orxonox::Pong::getRightPlayer ( ) const

Get the right player.

Returns: Returns a pointer to the player playing on the right. If there is no right player, nullptr is returned.

void orxonox::Pong::playerScored	(	PlayerInfo *	player,
		int	score = `1`
	)

overridevirtual

Is called when the player scored.

Reimplemented from orxonox::Deathmatch.

void orxonox::Pong::setCenterpoint ( PongCenterpoint * center )

inline

Set the PongCenterpoint (the playing field).

Parameters

center A pointer to the PongCenterpoint to be set.

void orxonox::Pong::setConfigValues ( void )

Makes scoreLimit configurable.

void orxonox::Pong::spawnPlayer ( PlayerInfo * player )

overridevirtual

!< Ends the Pong minigame.

Spawns the input player.

Parameters

player The player to be spawned.

Reimplemented from orxonox::Gametype.

void orxonox::Pong::spawnPlayersIfRequested ( )

overrideprotectedvirtual

Spawns players, and fills the rest up with bots.

Reimplemented from orxonox::Gametype.

void orxonox::Pong::start ( void )

overridevirtual

Starts the Pong minigame.

Reimplemented from orxonox::Deathmatch.

void orxonox::Pong::startBall ( )

protected

Starts the ball with some default speed.

Member Data Documentation

WeakPtr<PongBall> orxonox::Pong::ball_

protected

The Pong ball.

WeakPtr<PongBat> orxonox::Pong::bat_[2]

protected

The two bats.

WeakPtr<PongCenterpoint> orxonox::Pong::center_

protected

The playing field.

int orxonox::Pong::scoreLimit_

protected

If a player scored that much points, the game is ended.

Timer orxonox::Pong::starttimer_

protected

A timer to delay the start of the game.

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

modules/pong/Pong.h
modules/pong/Pong.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation