Clouds ability - revised Atmospheric ability. More...

#include <Clouds.h>

Inheritance diagram for APClouds::Clouds:

Public Member Functions
	Clouds ()

virtual	~Clouds ()

virtual void	preInitialize (void)

virtual void	postInitialize (void)

virtual void	processEvent (const std::string &input_name, void *value)

virtual void	update ()

virtual bool	loadXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *pParametersNode)

virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *	saveXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *)

Public Member Functions inherited from vrecko::Ability
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...

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 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
void	AddSkybox ()

void	AddGround ()

void	AddSun ()

Protected Member Functions inherited from vrecko::Ability
	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...

Additional Inherited Members
Public Types inherited from vrecko::Ability
typedef std::vector < ParameterStruct >	ParameterVector
	Vector of the description of parameters. More...

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

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

Protected Attributes inherited from vrecko::Ability
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...

Detailed Description

Clouds ability - revised Atmospheric ability.

Constructor & Destructor Documentation

Clouds::Clouds ( )

Initializes the Clouds ability.

Clouds::~Clouds ( )

virtual

Virtual destructor.

Member Function Documentation

void Clouds::AddGround ( )

protected

Adds the ground to the scene graph if it's allowed in the input XML file.

void Clouds::AddSkybox ( )

protected

Adds the skybox to the scene graph if it's allowed in the input XML file.

void Clouds::AddSun ( )

protected

Adds the sun to the scene graph if it's allowed in the input XML file.

bool Clouds::loadXMLParameters ( XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * pParametersNode )

virtual

Loads the ability-related parameters from the XML file to the appropriate structure

Parameters

pParametersNode Path to the file

Returns: TRUE if everything went well, FALSE otherwise

Reimplemented from vrecko::BaseClass.

void Clouds::postInitialize ( void )

virtual

Initializes the whole Clouds ability - clouds, skybox, ground, sun, lighting of clouds.

Reimplemented from vrecko::BaseClass.

void Clouds::preInitialize ( void )

virtual

Preinitializes the whole Clouds ability, sets it priority and frequency of update

Reimplemented from vrecko::BaseClass.

void Clouds::processEvent	(	const std::string &	input_name,
		void *	value
	)

virtual

Should process all the required events. However, it does nothing since no events are required at the moment.

Parameters

input_name	Name of the event.
value	Value of the event.

XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * Clouds::saveXMLParameters ( XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument * pDocNode )

virtual

Should create an XML with the scene. However, it does nothing since no XML creation is required at the moment.

Parameters

pDocNode Path to file, where the XML document should be saved.

Returns: NULL

Reimplemented from vrecko::BaseClass.

void Clouds::update ( void )

virtual

Update method, which is being called on a regular basis as set in preInitialize() method. Gets information about the camera from the world and passes it to the instance of CloudDataType.

Reimplemented from vrecko::BaseClass.

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

C:/Documents/School/OSG/VRECKO/include/vreckoAP/Nature/Clouds/Clouds.h
C:/Documents/School/OSG/VRECKO/src/vreckoAP/Nature/Clouds/Clouds.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation