#include <Ability.h>

Inheritance diagram for vrecko::Ability:

Classes
struct	ParameterStruct

Public Types
typedef std::vector < ParameterStruct >	ParameterVector
	Vector of the description of parameters. More...

Public Types inherited from vrecko::BaseClass
enum	NotificationTypes { NOTIFICATION_DELETE_CLASS = 1, NOTIFICATION_EO_REGISTERING = 2, NOTIFICATION_EO_UNREGISTERING = 4, NOTIFICATION_PROGRAM_TERMINATION = 8, NOTIFICATION_ALL = 0xFFFFFFFF }

Public Member Functions
virtual	~Ability ()
	copy constructor More...

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

void	setPluginName (const char *pName)
	Sets the plugin name. More...

const std::string &	getPluginName (void) const
	Returns the plugin name. More...

const std::string &	getID (void) const
	Returns ability the identification string. More...

void	setID (const char *pID)
	(Internal usage, most people should not need to use it.) Sets the ability ID. More...

virtual void	clean (void)

void	setOwner (BaseClass *owner)
	(Internal usage, most people should not need to use it.) Sets ability owner. *l This method is called automatically in World::createAbility(), so one would (almost?) never want to use it directly. More...

BaseClass *	getOwner (void)
	Returns the ability owner. More...

virtual ParameterVector *	getParameterVector (void)
	Return vector of the parameter description. More...

bool	isUpdated (void)
	Set update flag. More...

virtual const std::string &	getSenderString (void)
	Returns the identification string of sender. More...

Public Member Functions inherited from vrecko::BaseClass
	BaseClass (const char *startingSenderString)
	The main constructor. More...

	BaseClass (BaseClass &bc)
	Copy constructor. Probably not really used. More...

virtual	~BaseClass ()
	Destructor. More...

virtual bool	initialize (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *parameters=NULL)
	Core initialization. More...

virtual bool	initializeFromString (const char *xmlString)
	Helper method that allows to initialize ability from a XML-formatted string. More...

virtual void	update (void)
	This method is called periodically in case this instance is registered in Scheduler. More...

virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *	saveXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *)
	Save current setting into a XML node. More...

bool	inputPresent (const std::string &name)
	Returns true if input pin (not request inputpin ) with given name is present. More...

bool	outputPresent (const std::string &name)
	Returns true if output pin (not request output pin) with given name is present. More...

void	addInputPin (InputPinBase *pin)
	Adds an input pin. More...

void	removeInputPin (InputPinBase *pin)
	Removes an input pin. More...

void	addOutputPin (OutputPinBase *pin)
	Adds an output pin. More...

void	removeOutputPin (OutputPinBase *pin)
	Removes and output pin. More...

void	addRequestInputPin (RequestInputPinBase *pin)
	Adds a request input pin. More...

void	removeRequestInputPin (RequestInputPinBase *pin)
	Removes a request input pin. More...

void	addRequestOutputPin (RequestOutputPinBase *pin)
	Adds a request output pin. More...

void	removeRequestOutputPin (RequestOutputPinBase *pin)
	Removes a request output pin. More...

bool	addNotification (BaseClass *receiver, unsigned long notificationTypes)
	Registers an observer that will be notified if a specific change occurs. More...

bool	removeNotification (BaseClass *receiver, unsigned long notificationTypes=NOTIFICATION_ALL)
	Unregisters a previously registered observer. More...

virtual void	processEvent (const std::string &input_name, VreckoMessage *pMessage)
	Internal method for processing the events. More...

virtual VreckoMessage *	processRequest (const std::string &request_input_name, VreckoMessage *pMessage)
	Internal method for processing the requests. More...

void	reportError (const std::string &error)
	Print error message. More...

void	setPriority (long int pr)
	Sets the priority. (Possible problems - read the full description for more info) More...

long int	getPriority (void) const
	Returns current object priority. More...

void	setAttribute (const std::string &attr_name, int attr_value)
	Sets an attribute value. More...

int	getAttribute (const std::string &attr_name)
	Returns attribute value. More...

int	getAttribute (const char *attr_name)
	Returns attribute value. More...

void	deleteAttribute (const std::string &attr_name)
	Delete an attribute. More...

void	setSceneFile (const std::string &sceneFileName)
	Set the name of the file this component was in (and possibly will be saved to). More...

const std::string &	getSceneFile () const
	Get the name of the file this component was in. More...

virtual void	preInitialize (void)
	OBSOLETE METHOD, kept for backwards compatibility. More...

virtual void	postInitialize (void)
	OBSOLETE METHOD, kept for backwards compatibility. More...

virtual bool	loadXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *)
	OBSOLETE METHOD, kept for backwards compatibility. More...

virtual bool	loadXMLParameters (const char *xmlString)
	OBSOLETE METHOD, kept for backwards compatibility. More...

InputPinBase *	getInputPin (const char *strName)
	Returns pointer to an input pin with specified name. More...

OutputPinBase *	getOutputPin (const char *strName)
	Returns pointer to an output pin with specified name. More...

RequestInputPinBase *	getRequestInputPin (const char *strName)
	Returns pointer to an request input pin with specified name. More...

RequestOutputPinBase *	getRequestOutputPin (const char *strName)
	Returns pointer to an input pin with specified name. More...

Protected Member Functions
	Ability (const char *theAbilityName)

Protected Member Functions inherited from vrecko::BaseClass
bool	sendNotifications (unsigned long notificationType, void *notificationData)

virtual int	processNotification (BaseClass sender, unsigned long notificationType, void notificationData)
	Process an incoming notification. More...

IOPinBase *	findPinInList (const char strName, PinList pinList)
	Internal method to find a given pin in a given list. More...

Protected Attributes
BaseClass *	pOwner
	Pointer to the owner of this ability. (Almost?) always an EnvironmentObject class. More...

std::vector< std::string >	parameterString

bool	updated
	Update flag. It is used for save. More...

Protected Attributes inherited from vrecko::BaseClass
AttributeMap	attribute

MTReadWriteLock	attributeLock

std::string	senderString

MTLock	notificationsLock

std::vector < NOTIFICATION_DESCRIPTION >	notifications

long int	priority

const std::string *	sceneFile

PinList	inputPinsList

PinList	outputPinsList

PinList	requestInputPinsList

PinList	requestOutputPinsList

Additional Inherited Members
Protected Types inherited from vrecko::BaseClass
typedef std::map< std::string, int >	AttributeMap
	Attributes. More...

typedef std::vector < osg::ref_ptr< IOPinBase > >	PinList

Detailed Description

Ability class represents ability of any entity in VRECKO.

Member Typedef Documentation

typedef std::vector<ParameterStruct> vrecko::Ability::ParameterVector

Vector of the description of parameters.

Constructor & Destructor Documentation

Ability::Ability ( const char * theAbilityName )

protected

Main ability constructor.

The constructor should contain only the very basic initialization (setting variables to zero etc.) AND setting the priority AND adding the ability to the scheduler/setting the update frequency. (The reason for setting these two things is that the user can also specify them in the XML file to overwrite default setting. This will be processed after the constructor, but before the initialize().)

The main initialization should be made in the initialize() method. The reason is that in the constructor, the Ability doesn't know who will be its owner and what will be its ID.

Note that there is no default constructor, so the programmer is forced to use this one and name their ability. Also note that this constructor is protected, so the Ability class cannot be constructed directly, only its descendants can (and in their constructors they can use this constructor without problems).

Parameters

theAbilityName is usually the name of your class, e.g. "ObjectEffect".

Ability::~Ability ( )

virtual

copy constructor

Member Function Documentation

virtual void vrecko::Ability::clean ( void )

inlinevirtual

Reimplemented in APObjectUtils::ObjectEffect, APObjectUtils::KeepOnScreen, APObjectUtils::Animator, APObjectUtils::ObjectEffectMan, and APObjectUtils::ConnectionViz.

const std::string& vrecko::Ability::getID ( void ) const

inline

Returns ability the identification string.

This is either:

plugin name + "::" + ability name or
user specified ID set by the setID() function (through World::createAbility())

Returns: (const std::string &) Reference to the stored ability string.

const std::string& vrecko::Ability::getName ( ) const

inline

Returns the ability name.

Returns: (const std::string &) Reference to the ability name-string.

BaseClass* vrecko::Ability::getOwner ( void )

inline

Returns the ability owner.

The owner is in almost all cases an EnvironmetObject class, so you can safely cast it to EO, i.e. ((EnvironmentObject*)getOwner())

Returns: (BaseClass *)

virtual ParameterVector* vrecko::Ability::getParameterVector ( void )

inlinevirtual

Return vector of the parameter description.

Reimplemented in base::ShowFDH, and base::Rotate.

const std::string& vrecko::Ability::getPluginName ( void ) const

inline

Returns the plugin name.

const std::string & Ability::getSenderString ( void )

virtual

Returns the identification string of sender.

The sender string might be for example something like "EO|2073#Ab|Modeller::ModellingTool#Grab", which means Environment object #2073, Ability with ID "Modeller::ModellingTool" with "Grab" input or output (depending on the usage).

Reimplemented from vrecko::BaseClass.

bool Ability::isUpdated ( void )

Set update flag.

Return true if ability is updated else false Is the ability periodically updated?

Returns true if the ability is scheduled to be updated automatically at a given time interval (might be X Hz or simply every frame)

void Ability::setID ( const char * pID )

(Internal usage, most people should not need to use it.) Sets the ability ID.

Called automatically by the World::createAbility().

Warning: !!! WARNING !!! This function can be called only immediately after creating the ability (before adding ability to owner/world and before calling Ability::initialize()), because the mentioned function store the ID in their internal structures.

If the parameter is NULL or an empty string the standard ability ID will be used (plugin name + "::" + ability name). Note that calling the setPluginName() causes the ID to be set back to the default value.

Parameters

pID	(const char *)

Returns: (void)

void vrecko::Ability::setOwner ( BaseClass * owner )

inline

(Internal usage, most people should not need to use it.) Sets ability owner. *l This method is called automatically in World::createAbility(), so one would (almost?) never want to use it directly.

Parameters

owner (BaseClass *) The owner object, in most usual cases it is an EnvironmentObject class.

Returns: (void)

void Ability::setPluginName ( const char * pName )

Sets the plugin name.

Should be only used by plugins when constructing the ability (in their getAbilityInstance() method).

Parameters

pName (const char *)

Returns: (void)

Member Data Documentation

std::vector<std::string> vrecko::Ability::parameterString

protected

VYHODIT --------------------------------— Vector of parameterString

BaseClass* vrecko::Ability::pOwner

protected

Pointer to the owner of this ability. (Almost?) always an EnvironmentObject class.

bool vrecko::Ability::updated

protected

Update flag. It is used for save.

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

C:/Documents/School/OSG/VRECKO/include/vrecko/Ability.h
C:/Documents/School/OSG/VRECKO/src/vrecko/Ability.cpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation