CarSim::CarExecutionUnit Class Reference

#include <CarExecutionUnit.h>

Inheritance diagram for CarSim::CarExecutionUnit:

Public Member Functions
	CarExecutionUnit ()
	CarExecutionUnit (const CarSize &carSize, const float maxSpeed, const float minSpeed, const float maxAcc, const float minAcc, const float maxDispWheelAngle, std::vector< osg::MatrixTransform * > *const pWheelsVec, const float wheelR, Lights *const pLights, const osg::Vec3 &carDirection, const osg::Vec3 &carNormal, const osg::Vec3 &carPositionOnRoad, vrecko::EnvironmentObject *const pFutureCarEOownerToSet)
	~CarExecutionUnit ()
void	preInitialize (void)
	OBSOLETE METHOD, kept for backwards compatibility. More...
void	update (void)
	This method is called periodically in case this instance is registered in Scheduler. More...
bool	loadXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *pParametersNode)
	OBSOLETE METHOD, kept for backwards compatibility. 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...
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	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...

Protected Member Functions
void	checkXMLparameters ()
void	initDirection (const osg::Vec3 &dir)
void	initNormal (const osg::Vec3 &normal)
void	computeCarState (const float lastFrameLength)
void	switchLight (const unsigned int lightType, const unsigned int lightState)
void	blink (const float lastFrameLength)
void	loadGeometryParts ()
	DECLARE_INPUT (InAcc, vrecko::MessageFloat)
	DECLARE_INPUT (InWheelAngle, vrecko::MessageFloat)
	DECLARE_INPUT (InStop, vrecko::MessageVoid)
	DECLARE_INPUT (InUpdate, vrecko::MessageFloat)
	DECLARE_INPUT (InInitNormal, vrecko::MessageVec3)
	DECLARE_INPUT (InInitDirection, vrecko::MessageVec3)
	DECLARE_INPUT (InInitPosition, vrecko::MessageVec3)
	DECLARE_INPUT (InSetCarNormal, vrecko::MessageVec3)
	DECLARE_INPUT (InPushCarInNormalDir, vrecko::MessageFloat)
	DECLARE_INPUT (InPushCarInDirectionCrossNormalDir, vrecko::MessageFloat)
	DECLARE_INPUT (InSetBlinker, vrecko::MessageUnsignedInt)
	DECLARE_INPUT (InShow, vrecko::MessageVoid)
	DECLARE_INPUT (InHide, vrecko::MessageVoid)
	DECLARE_REQUEST_INPUT (InGetCarState, vrecko::MessageVoid, MessageCarStatePtr)
	DECLARE_REQUEST_INPUT (InGetCarLength, vrecko::MessageVoid, vrecko::MessageFloat)
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
CarState	carState
float	vPrevious
float	maxSpeed
float	minSpeed
float	maxDispWheelAngle
float	wheelDisplayAngleAroundNormal
float	wheelRotateAngle
float	wheelR
std::vector < osg::MatrixTransform * > *const	pWheelsVec
std::vector< osg::Matrix >	wheelsInitMatrixVec
Lights *const	pLights
unsigned int	frontLightState
unsigned int	brakeLightState
float	timeFromLastBlinkStart
const bool	isGenCar
GeometryPartsPath *const	pGeometryPartsPath
std::vector< osg::Vec3 > *const	pLeftWheelsPosVec
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

CarExecutionUnit::CarExecutionUnit

(

)

CarSim::CarExecutionUnit::CarExecutionUnit	(	const CarSize &	carSize,
		const float	maxSpeed,
		const float	minSpeed,
		const float	maxAcc,
		const float	minAcc,
		const float	maxDispWheelAngle,
		std::vector< osg::MatrixTransform * > *const	pWheelsVec,
		const float	wheelR,
		Lights *const	pLights,
		const osg::Vec3 &	carDirection,
		const osg::Vec3 &	carNormal,
		const osg::Vec3 &	carPositionOnRoad,
		vrecko::EnvironmentObject *const	pFutureCarEOownerToSet
	)

CarExecutionUnit::~CarExecutionUnit

(

)

Member Function Documentation

void CarExecutionUnit::blink ( const float  lastFrameLength )

protected

void CarExecutionUnit::checkXMLparameters ( )

protected

void CarExecutionUnit::computeCarState ( const float  lastFrameLength )

protected

CarSim::CarExecutionUnit::DECLARE_INPUT ( InAcc  , vrecko::MessageFloat    )

protected

CarSim::CarExecutionUnit::DECLARE_INPUT ( InWheelAngle  , vrecko::MessageFloat    )

protected

CarSim::CarExecutionUnit::DECLARE_INPUT ( InStop  , vrecko::MessageVoid    )

protected

CarSim::CarExecutionUnit::DECLARE_INPUT ( InUpdate  , vrecko::MessageFloat    )

protected

CarSim::CarExecutionUnit::DECLARE_INPUT ( InInitNormal  , vrecko::MessageVec3    )

protected

CarSim::CarExecutionUnit::DECLARE_INPUT ( InInitDirection  , vrecko::MessageVec3    )

protected

CarSim::CarExecutionUnit::DECLARE_INPUT ( InInitPosition  , vrecko::MessageVec3    )

protected

CarSim::CarExecutionUnit::DECLARE_INPUT ( InSetCarNormal  , vrecko::MessageVec3    )

protected

CarSim::CarExecutionUnit::DECLARE_INPUT ( InPushCarInNormalDir  , vrecko::MessageFloat    )

protected

CarSim::CarExecutionUnit::DECLARE_INPUT ( InPushCarInDirectionCrossNormalDir  , vrecko::MessageFloat    )

protected

CarSim::CarExecutionUnit::DECLARE_INPUT ( InSetBlinker  , vrecko::MessageUnsignedInt    )

protected

CarSim::CarExecutionUnit::DECLARE_INPUT ( InShow  , vrecko::MessageVoid    )

protected

CarSim::CarExecutionUnit::DECLARE_INPUT ( InHide  , vrecko::MessageVoid    )

protected

CarSim::CarExecutionUnit::DECLARE_REQUEST_INPUT ( InGetCarState  , vrecko::MessageVoid  , MessageCarStatePtr    )

protected

CarSim::CarExecutionUnit::DECLARE_REQUEST_INPUT ( InGetCarLength  , vrecko::MessageVoid  , vrecko::MessageFloat    )

protected

void CarExecutionUnit::initDirection ( const osg::Vec3 &  dir )

protected

void CarExecutionUnit::initNormal ( const osg::Vec3 &  normal )

protected

void CarExecutionUnit::loadGeometryParts ( )

protected

bool CarExecutionUnit::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 CarExecutionUnit::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.

void CarExecutionUnit::switchLight ( const unsigned int  lightType, const unsigned int  lightState  )

protected

void CarExecutionUnit::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

unsigned int CarSim::CarExecutionUnit::brakeLightState

protected

CarState CarSim::CarExecutionUnit::carState

protected

unsigned int CarSim::CarExecutionUnit::frontLightState

protected

const bool CarSim::CarExecutionUnit::isGenCar

protected

float CarSim::CarExecutionUnit::maxDispWheelAngle

protected

float CarSim::CarExecutionUnit::maxSpeed

protected

float CarSim::CarExecutionUnit::minSpeed

protected

GeometryPartsPath* const CarSim::CarExecutionUnit::pGeometryPartsPath

protected

std::vector<osg::Vec3>* const CarSim::CarExecutionUnit::pLeftWheelsPosVec

protected

Lights* const CarSim::CarExecutionUnit::pLights

protected

std::vector<osg::MatrixTransform*>* const CarSim::CarExecutionUnit::pWheelsVec

protected

float CarSim::CarExecutionUnit::timeFromLastBlinkStart

protected

float CarSim::CarExecutionUnit::vPrevious

protected

float CarSim::CarExecutionUnit::wheelDisplayAngleAroundNormal

protected

float CarSim::CarExecutionUnit::wheelR

protected

float CarSim::CarExecutionUnit::wheelRotateAngle

protected

std::vector<osg::Matrix> CarSim::CarExecutionUnit::wheelsInitMatrixVec

protected

---

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

• C:/Documents/School/OSG/VRECKO/include/vreckoAP/CarSim/CarExecutionUnit.h
• C:/Documents/School/OSG/VRECKO/src/vreckoAP/CarSim/CarExecutionUnit.cpp