#include <BoidsLogic.h>

Inheritance diagram for boids::BoidsLogic:

Public Member Functions
	BoidsLogic ()

	~BoidsLogic ()

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

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

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

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

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

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
bool	rule0_in_sight (int other_boid, int boid)

osg::Vec3	rule1_centre_of_mass (int boid)

osg::Vec3	rule2_away_from_others (int boid)

osg::Vec3	rule3_match_velocity (int boid)

osg::Vec3	rule4_bound_position (int boid)

osg::Vec3	rule5_fly_to_waypoint (int boid)

osg::Vec3	rule6_fly_from_danger (int boid)

void	limit_speed (int boid)

bool	rest_on_land (int boid)

	DECLARE_INPUT (Waypoint, MessageVec3)

	DECLARE_INPUT (Danger, MessageVec3)

	DECLARE_OUTPUT (NextWaypoint, MessageBool)

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

Protected Attributes
std::vector< osg::Vec3 >	boids_position

std::vector< osg::Vec3 >	boids_velocity

std::vector< float >	boids_rest_time

std::vector< string >	boids_position_output

std::vector< string >	boids_velocity_output

int	boids_count

osg::Vec3	max_bound

osg::Vec3	min_bound

osg::Vec3	bound_velocity

float	move_factor

float	small_distance

float	velocity_factor

float	max_speed

float	waypoint_speed

float	next_waypoint_dist

bool	next_waypoint

osg::Vec3	waypoint

float	scare_distance

float	danger_factor

osg::Vec3	danger

float	land_level

float	takeoff_time

float	rest_time

float	sight_angle

std::string	mesg

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

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

Constructor & Destructor Documentation

BoidsLogic::BoidsLogic ( )

boids::BoidsLogic::~BoidsLogic ( )

inline

Member Function Documentation

boids::BoidsLogic::DECLARE_INPUT	(	Waypoint	,
		MessageVec3
	)

protected

boids::BoidsLogic::DECLARE_INPUT	(	Danger	,
		MessageVec3
	)

protected

boids::BoidsLogic::DECLARE_OUTPUT	(	NextWaypoint	,
		MessageBool
	)

protected

void BoidsLogic::limit_speed ( int boid )

protected

bool BoidsLogic::loadXMLParameters ( XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * )

virtual

OBSOLETE METHOD, kept for backwards compatibility.

The preInitialize(), loadXMLParameters() and postInitialize() methods were replaced in 2011 by a single method initialize().

Parameters

*	(XERCES_CPP_NAMESPACE_QUALIFIER DOMNode)

Returns: (bool)

Reimplemented from vrecko::BaseClass.

void BoidsLogic::postInitialize ( void )

virtual

OBSOLETE METHOD, kept for backwards compatibility.

The preInitialize(), loadXMLParameters() and postInitialize() methods were replaced in 2011 by a single method initialize().

Reimplemented from vrecko::BaseClass.

void BoidsLogic::preInitialize ( void )

virtual

OBSOLETE METHOD, kept for backwards compatibility.

The preInitialize(), loadXMLParameters() and postInitialize() methods were replaced in 2011 by a single method initialize().

Reimplemented from vrecko::BaseClass.

bool BoidsLogic::rest_on_land ( int boid )

protected

bool BoidsLogic::rule0_in_sight	(	int	other_boid,
		int	boid
	)

protected

osg::Vec3 BoidsLogic::rule1_centre_of_mass ( int boid )

protected

osg::Vec3 BoidsLogic::rule2_away_from_others ( int boid )

protected

osg::Vec3 BoidsLogic::rule3_match_velocity ( int boid )

protected

osg::Vec3 BoidsLogic::rule4_bound_position ( int boid )

protected

osg::Vec3 BoidsLogic::rule5_fly_to_waypoint ( int boid )

protected

osg::Vec3 BoidsLogic::rule6_fly_from_danger ( int boid )

protected

XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * BoidsLogic::saveXMLParameters ( XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument * )

virtual

Save current setting into a XML node.

Warning: Currently not supported. It is safe to leave it without overriding.

Parameters

*	(XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument)

Returns: (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *)

Reimplemented from vrecko::BaseClass.

void BoidsLogic::update ( void )

virtual

This method is called periodically in case this instance is registered in Scheduler.

The method is called periodically at specified frequency or every frame. Use the Scheduler::addEntity() method to register your class and set the frequency.

Reimplemented from vrecko::BaseClass.

Member Data Documentation

int boids::BoidsLogic::boids_count

protected

std::vector<osg::Vec3> boids::BoidsLogic::boids_position

protected

std::vector<string> boids::BoidsLogic::boids_position_output

protected

std::vector<float> boids::BoidsLogic::boids_rest_time

protected

std::vector<osg::Vec3> boids::BoidsLogic::boids_velocity

protected

std::vector<string> boids::BoidsLogic::boids_velocity_output

protected

osg::Vec3 boids::BoidsLogic::bound_velocity

protected

osg::Vec3 boids::BoidsLogic::danger

protected

float boids::BoidsLogic::danger_factor

protected

float boids::BoidsLogic::land_level

protected

osg::Vec3 boids::BoidsLogic::max_bound

protected

float boids::BoidsLogic::max_speed

protected

std::string boids::BoidsLogic::mesg

protected

osg::Vec3 boids::BoidsLogic::min_bound

protected

float boids::BoidsLogic::move_factor

protected

bool boids::BoidsLogic::next_waypoint

protected

float boids::BoidsLogic::next_waypoint_dist

protected

float boids::BoidsLogic::rest_time

protected

float boids::BoidsLogic::scare_distance

protected

float boids::BoidsLogic::sight_angle

protected

float boids::BoidsLogic::small_distance

protected

float boids::BoidsLogic::takeoff_time

protected

float boids::BoidsLogic::velocity_factor

protected

osg::Vec3 boids::BoidsLogic::waypoint

protected

float boids::BoidsLogic::waypoint_speed

protected

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

C:/Documents/School/OSG/VRECKO/include/vreckoAP/Boids/BoidsLogic.h
C:/Documents/School/OSG/VRECKO/src/vreckoAP/Boids/BoidsLogic.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation