DtGroundJoyMoveController Class Reference

DtGroundJoyMoveController is a controller that enables joystick control of a ground vehicle. More...

Inheritance diagram for DtGroundJoyMoveController:

List of all members.

Public Member Functions
	DtGroundJoyMoveController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtGroundJoyMoveController ()
	destructor
virtual void	tick ()
	Calculate new control values.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	setComponentDescriptor (DtComponentDescriptor *descriptor)
	Attempts to cast the descriptor to a DtGroundJoyDeviceControllerDescriptor and store it in myJoyDeviceControllerDescriptor.
virtual void	processSetJoyDeviceSwitch (DtSimMessage *msg)
virtual void	calcAndSetPortValues ()
virtual bool	joystickEnabled () const
virtual bool	collisionDetected ()
Static Public Member Functions
static void	setJoyDeviceSwitchCallbacks (DtSimMessage *msg, void *usrData)
	Forwards a DtSetJoyDeviceSwitchRequest message to the joy controller pointed to by usrData.
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Protected Member Functions
virtual void	initializeJoyDevice ()
	Obtain the joyDevice and initialize it.
virtual void	setRadio (DtSimRadio *radio)
	Overrides this so it can register its interest in the set commands.
virtual bool	detectCollision ()
virtual void	collideWithLifeform (DtVrfObject *)
Protected Attributes
DtJoyDevice *	myJoyDevice
bool	myInitialized
int	myCurrentGear
bool	myCollisionDetected
bool	myInternalCollisionDetected
const DtGroundJoyDeviceControllerDescriptor *	myJoyDeviceControllerDescriptor
bool	myJoystickEnabled
Private Member Functions
	DtGroundJoyMoveController ()
	default constructor; not implemented.
	DtGroundJoyMoveController (const DtGroundJoyMoveController &orig)
	copy constructor; not implemented.
DtGroundJoyMoveController &	operator= (const DtGroundJoyMoveController &orig)
	assignment operator; not implemented.

---

Detailed Description

DtGroundJoyMoveController is a controller that enables joystick control of a ground vehicle.

Uses Descriptor Type: DtGroundJoyDeviceControllerDescriptor

---

Constructor & Destructor Documentation

DtGroundJoyMoveController::DtGroundJoyMoveController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtGroundJoyMoveController::~DtGroundJoyMoveController

(

)

[virtual]

destructor

DtGroundJoyMoveController::DtGroundJoyMoveController

(

)

[private]

default constructor; not implemented.

DtGroundJoyMoveController::DtGroundJoyMoveController

(

const DtGroundJoyMoveController &

orig

)

[private]

copy constructor; not implemented.

---

Member Function Documentation

virtual void DtGroundJoyMoveController::tick

(

)

[virtual]

Calculate new control values.

Reimplemented from DtSimComponent.

virtual DtString DtGroundJoyMoveController::type

(

)

const [virtual]

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns:

DtGroundJoyMoveControllerType

Reimplemented from DtGroundAutoControllerComponent.

virtual void DtGroundJoyMoveController::setComponentDescriptor

(

DtComponentDescriptor *

descriptor

)

[virtual]

Attempts to cast the descriptor to a DtGroundJoyDeviceControllerDescriptor and store it in myJoyDeviceControllerDescriptor.

Reimplemented from DtSimComponent.

static void DtGroundJoyMoveController::setJoyDeviceSwitchCallbacks	(	DtSimMessage *	msg,
		void *	usrData
	)		[static]

Forwards a DtSetJoyDeviceSwitchRequest message to the joy controller pointed to by usrData.

virtual void DtGroundJoyMoveController::processSetJoyDeviceSwitch

(

DtSimMessage *

msg

)

[virtual]

virtual void DtGroundJoyMoveController::calcAndSetPortValues

(

)

[virtual]

virtual bool DtGroundJoyMoveController::joystickEnabled

(

)

const [virtual]

static DtSimComponent* DtGroundJoyMoveController::creator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[static]

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns:

New instance of this class.

virtual bool DtGroundJoyMoveController::collisionDetected

(

)

[virtual]

DtGroundJoyMoveController& DtGroundJoyMoveController::operator=

(

const DtGroundJoyMoveController &

orig

)

[private]

assignment operator; not implemented.

virtual void DtGroundJoyMoveController::initializeJoyDevice

(

)

[protected, virtual]

Obtain the joyDevice and initialize it.

virtual void DtGroundJoyMoveController::setRadio

(

DtSimRadio *

radio

)

[protected, virtual]

Overrides this so it can register its interest in the set commands.

Reimplemented from DtTaskControllerComponent.

virtual bool DtGroundJoyMoveController::detectCollision

(

)

[protected, virtual]

virtual void DtGroundJoyMoveController::collideWithLifeform

(

DtVrfObject *

)

[protected, virtual]

---

Member Data Documentation

DtJoyDevice* DtGroundJoyMoveController::myJoyDevice [protected]

bool DtGroundJoyMoveController::myInitialized [protected]

int DtGroundJoyMoveController::myCurrentGear [protected]

bool DtGroundJoyMoveController::myCollisionDetected [protected]

bool DtGroundJoyMoveController::myInternalCollisionDetected [protected]

const DtGroundJoyDeviceControllerDescriptor* DtGroundJoyMoveController::myJoyDeviceControllerDescriptor [protected]

bool DtGroundJoyMoveController::myJoystickEnabled [protected]

---

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

• include/vrfmodel/gndJoyCtl.h