#include <ConstraintDescription.h>

Inheritance diagram for APConstrainedMovement::ConstraintDescription:

Public Member Functions
	ConstraintDescription ()

virtual	~ConstraintDescription ()

bool	loadXMLFile (const char *xmlFile)

virtual bool	loadXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *pParametersNode)

ConstraintAreas	getOfferAreas ()

ConstraintAreas	getBindingAreas ()

ConstraintAreas	getDualAreas ()

bool	getJustMoving ()

void	setJustMoving (bool justMoving)

bool	getWasTested ()

void	setWasTested (bool wasTested)

int	getConstraintParentID ()

EnvironmentObjectIDs	getConstrainedChildrenIDs ()

EnvironmentObjectIDs	getConstrainedDualPartnerIDs ()

EnvironmentObjectIDs	getFreshDualPartnerIDs ()

void	clearFreshDualPartnerIDs ()

void	addConstrainedChildID (int id)

void	removeConstrainedChildID (int id)

void	addConstrainedDualPartnerID (int id, bool addAsFresh)

void	removeConstrainedDualPartnerID (int id)

void	freeFromConstraintParent ()

void	shiftAllConstrainedObjects (EnvironmentObject *eo, const osg::Matrix &transformationMatrix)

void	processDualSplitting (EnvironmentObject *eo, osg::Vec3 splittingDirection)

bool	isConstraintParentOf (EnvironmentObject *eo)

int	getBoundAreaCount ()

osg::Vec3	getBoundAreaNormal ()

void	setBoundAreaCount (int boundAreaCount)

void	setBoundAreaNormal (osg::Vec3 boundAreaNormal)

void	writeInfo ()

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

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

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 Member Functions inherited from vrecko::Ability
	Ability (const char *theAbilityName)

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

Class representing constraint description of an object

Constructor & Destructor Documentation

APConstrainedMovement::ConstraintDescription::ConstraintDescription ( )

Creates an empty constraint description

APConstrainedMovement::ConstraintDescription::~ConstraintDescription ( )

virtual

Frees a constraint description

Member Function Documentation

void APConstrainedMovement::ConstraintDescription::addConstrainedChildID ( int id )

Environment object identified by id will become a child of this object

void APConstrainedMovement::ConstraintDescription::addConstrainedDualPartnerID	(	int	id,
		bool	addAsFresh
	)

Adding a dual partner

void APConstrainedMovement::ConstraintDescription::clearFreshDualPartnerIDs ( )

inline

void APConstrainedMovement::ConstraintDescription::freeFromConstraintParent ( )

Remove the parent-child relationship between the owner of this constraint description and its constraint parent

ConstraintAreas APConstrainedMovement::ConstraintDescription::getBindingAreas ( )

inline

int APConstrainedMovement::ConstraintDescription::getBoundAreaCount ( )

inline

osg::Vec3 APConstrainedMovement::ConstraintDescription::getBoundAreaNormal ( )

inline

EnvironmentObjectIDs APConstrainedMovement::ConstraintDescription::getConstrainedChildrenIDs ( )

inline

EnvironmentObjectIDs APConstrainedMovement::ConstraintDescription::getConstrainedDualPartnerIDs ( )

inline

int APConstrainedMovement::ConstraintDescription::getConstraintParentID ( )

inline

ConstraintAreas APConstrainedMovement::ConstraintDescription::getDualAreas ( )

inline

EnvironmentObjectIDs APConstrainedMovement::ConstraintDescription::getFreshDualPartnerIDs ( )

inline

bool APConstrainedMovement::ConstraintDescription::getJustMoving ( )

inline

ConstraintAreas APConstrainedMovement::ConstraintDescription::getOfferAreas ( )

inline

bool APConstrainedMovement::ConstraintDescription::getWasTested ( )

inline

bool APConstrainedMovement::ConstraintDescription::isConstraintParentOf ( EnvironmentObject * eo )

Returns whether this object is a constraint parent or partner of the given object

bool APConstrainedMovement::ConstraintDescription::loadXMLFile ( const char * xmlFile )

Loading the description from the specified file

bool APConstrainedMovement::ConstraintDescription::loadXMLParameters ( XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * pParametersNode )

virtual

Loading the constraint description itself (either recursively from a file specified by <ConstraintDescriptionFileName>, or using inline XML data)

Reimplemented from vrecko::BaseClass.

void APConstrainedMovement::ConstraintDescription::processDualSplitting	(	EnvironmentObject *	eo,
		osg::Vec3	splittingDirection
	)

Split eo from dual partners that lie in a wrong direction

void APConstrainedMovement::ConstraintDescription::removeConstrainedChildID ( int id )

Environment object identified by id will no longer be a child of this object

void APConstrainedMovement::ConstraintDescription::removeConstrainedDualPartnerID ( int id )

Removing a dual partner

void APConstrainedMovement::ConstraintDescription::setBoundAreaCount ( int boundAreaCount )

inline

void APConstrainedMovement::ConstraintDescription::setBoundAreaNormal ( osg::Vec3 boundAreaNormal )

inline

void APConstrainedMovement::ConstraintDescription::setJustMoving ( bool justMoving )

inline

void APConstrainedMovement::ConstraintDescription::setWasTested ( bool wasTested )

inline

void APConstrainedMovement::ConstraintDescription::shiftAllConstrainedObjects	(	EnvironmentObject *	eo,
		const osg::Matrix &	transformationMatrix
	)

Shift all objects constrained to this object

void APConstrainedMovement::ConstraintDescription::writeInfo ( )

Writes the description information to standard output

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

C:/Documents/School/OSG/VRECKO/include/vreckoAP/ConstrainedMovement/ConstraintDescription.h
C:/Documents/School/OSG/VRECKO/src/vreckoAP/ConstrainedMovement/ConstraintDescription.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation