orxonox::Dialog Class Reference

class containing core of one dialog with one npc More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/modules/dialog/Dialog.h>

Inheritance diagram for orxonox::Dialog:

Public Member Functions
	Dialog (Context *context)
void	addAnswer (Answer *answer)
void	addQuestion (Question *question)
bool	ending (const std::string &givenAnswerId)
	tests if there is a next question for the given answerId More...
bool	execute (bool bTriggered, BaseObject *trigger)
	function called when the trigger object defined in the xml file sets to triggered More...
Answer *	getAnswer (unsigned int index) const
const std::vector< std::string > &	getAnswerIds () const
	returns a pointer to the array of answers belonging to the current question for use in dialogManager More...
const std::string &	getAnswerString (const std::string &answerId)
	returns a sting with the pc answer to the id More...
const std::string &	getCurrentQuestionId () const
const std::string &	getName () const
Question *	getQuestion (unsigned int index) const
const std::string &	getQuestionString ()
	gives the text of the npc in the current state More...
void	setCurrentQuestionId (const std::string &questionId)
void	setName (const std::string &name)
void	update (const std::string &givenAnswerId)
	updates the current Dialog according to the id of a given answer, by setting currentQuestionId to the next one 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::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...
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...

Private Attributes
std::map< std::string, Answer * >	answers_
	a map form the ids of npc textoptions to the objects containing them More...
std::string	currentQuestionId_
	id of the npc question currently active More...
std::string	name_
	name of the npc talking More...
std::map< std::string, Question * >	questions_
	a map form the ids of npc textoptions to the objects containing them 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...
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 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...

Detailed Description

class containing core of one dialog with one npc

this class contains a map of all answerids to answers (player text options) and one of all questionids to questions (npc text options) it realizes a state machine with the question beeing the states and the answers beeing the connections, it has a current state and can be commanded to go to the next state according to a given answer

Constructor & Destructor Documentation

orxonox::Dialog::Dialog

(

Context *

context

)

Member Function Documentation

void orxonox::Dialog::addAnswer

(

Answer *

answer

)

void orxonox::Dialog::addQuestion

(

Question *

question

)

bool orxonox::Dialog::ending

(

const std::string &

givenAnswerId

)

tests if there is a next question for the given answerId

Parameters

givenAnswerId

id of the answer given by player

Returns

true if there is no more Question to the given answerId

bool orxonox::Dialog::execute	(	bool	bTriggered,
		BaseObject *	trigger
	)

function called when the trigger object defined in the xml file sets to triggered

Parameters

bTriggered	needs to be set like this for correctness
trigger	needs to be set like this for correctness

Returns

not really used

Answer * orxonox::Dialog::getAnswer

(

unsigned int

index

)

const

const std::vector< std::string > & orxonox::Dialog::getAnswerIds

(

)

const

returns a pointer to the array of answers belonging to the current question for use in dialogManager

Returns

pointer to answerId array of question

const std::string & orxonox::Dialog::getAnswerString

(

const std::string &

answerId

)

returns a sting with the pc answer to the id

Parameters

answerId

the id of the answer looked for

Returns

sting with answer

const std::string & orxonox::Dialog::getCurrentQuestionId

(

)

const

const std::string & orxonox::Dialog::getName

(

void

)

const

Question * orxonox::Dialog::getQuestion

(

unsigned int

index

)

const

const std::string & orxonox::Dialog::getQuestionString

(

)

gives the text of the npc in the current state

Returns

sting with npc text

void orxonox::Dialog::setCurrentQuestionId

(

const std::string &

questionId

)

void orxonox::Dialog::setName

(

const std::string &

name

)

void orxonox::Dialog::update

(

const std::string &

givenAnswerId

)

updates the current Dialog according to the id of a given answer, by setting currentQuestionId to the next one

Parameters

givenAnswerId

id of the answer given by player

void orxonox::Dialog::XMLEventPort ( Element &  xmlelement, XMLPort::Mode  mode  )

virtual

Defines the possible event states of this object and parses eventsources from an XML file.

Parameters

xmlelement	The XML-element
mode	The mode defines the operation that is being executed: loading or saving the object (from or to XML respectively)

Reimplemented from orxonox::BaseObject.

void orxonox::Dialog::XMLPort ( Element &  xmlelement, XMLPort::Mode  mode  )

virtual

XML loading and saving.

Parameters

xmlelement	The XML-element
mode	The mode defines the operation that is being executed: loading or saving the object (from or to XML respectively)

Reimplemented from orxonox::BaseObject.

Member Data Documentation

std::map<std::string, Answer*> orxonox::Dialog::answers_

private

a map form the ids of npc textoptions to the objects containing them

std::string orxonox::Dialog::currentQuestionId_

private

id of the npc question currently active

std::string orxonox::Dialog::name_

private

name of the npc talking

std::map<std::string, Question*> orxonox::Dialog::questions_

private

a map form the ids of npc textoptions to the objects containing them

---

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

• modules/dialog/Dialog.h
• modules/dialog/Dialog.cc