DtBallisticGunJoyController Class Reference

DtBallisticGunJoyController extends the DtBallisticGunController class with the ability to be controlled from a joystick. More...

Inheritance diagram for DtBallisticGunJoyController:

List of all members.

Public Member Functions
	DtBallisticGunJoyController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc, DtReaderWriterRegistry *const parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtBallisticGunJoyController ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	setComponentDescriptor (DtComponentDescriptor *descriptor)
	Sets myBalGunJoyDescriptor.
virtual void	tick ()
	Calculate new control values.
virtual void	calcAndSetPortValues ()
virtual bool	createActiveJoystickPort ()
	These are called in init to create the ports used to communicate with the actuator.
virtual DtBooleanOutputPort *	activeJoystickPort () const
virtual bool	createElevationPort ()
virtual DtConstrainedAnalogOutputPort *	elevationPort () const
virtual bool	chooseAmmo (DtString name=DtString::nullString())
virtual bool	canFire ()
virtual void	processSetJoyDeviceSwitch (DtSimMessage *msg)
virtual void	setFire ()
virtual void	setChangeAmmo ()
virtual void	setElevation (DtReal elevation)
Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
static void	setJoyDeviceSwitchCallbacks (DtSimMessage *msg, void *usrData)
Protected Member Functions
virtual bool	createPorts ()
	Overridden to create output ports.
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.
Protected Attributes
DtBallisticGunJoyControllerDescriptor *	myBalGunJoyDescriptor
DtJoyDevice *	myJoyDevice
bool	myInitialized
bool	myFiring
bool	myChangeAmmo
DtReal	myElevation
Ports and Port Groups
DtConstrainedAnalogOutputPort *	myElevationPort
	Output Port Name: elevation Output Port Description: Output Port Range: -1.
DtBooleanOutputPort *	myActiveJoystickPort
	Output Port Name: joystick-active Output Port Description: Indicates whether controller behavior is being executed through a joystick.
Private Member Functions
	DtBallisticGunJoyController ()
	Default constructor; not implemented.
	DtBallisticGunJoyController (const DtBallisticGunJoyController &orig)
	copy constructor; not implemented
const DtBallisticGunJoyController &	operator= (const DtBallisticGunJoyController &orig)
	assignment operator; not implemented

---

Detailed Description

DtBallisticGunJoyController extends the DtBallisticGunController class with the ability to be controlled from a joystick.

Uses Descriptor Type: DtBallisticGunJoyControllerDescriptor

---

Constructor & Destructor Documentation

DtBallisticGunJoyController::DtBallisticGunJoyController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc,
		DtReaderWriterRegistry *const	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 DtBallisticGunJoyController::~DtBallisticGunJoyController

(

)

[virtual]

destructor

DtBallisticGunJoyController::DtBallisticGunJoyController

(

)

[private]

Default constructor; not implemented.

DtBallisticGunJoyController::DtBallisticGunJoyController

(

const DtBallisticGunJoyController &

orig

)

[private]

copy constructor; not implemented

---

Member Function Documentation

virtual DtString DtBallisticGunJoyController::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:

DtBallisticGunJoyControllerType

Reimplemented from DtBallisticGunController.

virtual void DtBallisticGunJoyController::setComponentDescriptor

(

DtComponentDescriptor *

descriptor

)

[virtual]

Sets myBalGunJoyDescriptor.

Reimplemented from DtSimComponent.

virtual void DtBallisticGunJoyController::tick

(

)

[virtual]

Calculate new control values.

Reimplemented from DtBallisticGunController.

virtual void DtBallisticGunJoyController::calcAndSetPortValues

(

)

[virtual]

virtual bool DtBallisticGunJoyController::createActiveJoystickPort

(

)

[virtual]

These are called in init to create the ports used to communicate with the actuator.

virtual DtBooleanOutputPort* DtBallisticGunJoyController::activeJoystickPort

(

)

const [virtual]

virtual bool DtBallisticGunJoyController::createElevationPort

(

)

[virtual]

virtual DtConstrainedAnalogOutputPort* DtBallisticGunJoyController::elevationPort

(

)

const [virtual]

virtual bool DtBallisticGunJoyController::chooseAmmo

(

DtString

name = DtString::nullString()

)

[virtual]

virtual bool DtBallisticGunJoyController::canFire

(

)

[virtual]

static DtSimComponent* DtBallisticGunJoyController::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.

Reimplemented from DtBallisticGunController.

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

virtual void DtBallisticGunJoyController::processSetJoyDeviceSwitch

(

DtSimMessage *

msg

)

[virtual]

virtual void DtBallisticGunJoyController::setFire

(

)

[virtual]

virtual void DtBallisticGunJoyController::setChangeAmmo

(

)

[virtual]

virtual void DtBallisticGunJoyController::setElevation

(

DtReal

elevation

)

[virtual]

virtual bool DtBallisticGunJoyController::createPorts

(

)

[protected, virtual]

Overridden to create output ports.

Reimplemented from DtBallisticGunController.

const DtBallisticGunJoyController& DtBallisticGunJoyController::operator=

(

const DtBallisticGunJoyController &

orig

)

[private]

assignment operator; not implemented

virtual void DtBallisticGunJoyController::initializeJoyDevice

(

)

[protected, virtual]

Obtain the joyDevice and initialize it.

virtual void DtBallisticGunJoyController::setRadio

(

DtSimRadio *

radio

)

[protected, virtual]

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

Reimplemented from DtControllerComponent.

---

Member Data Documentation

DtBallisticGunJoyControllerDescriptor* DtBallisticGunJoyController::myBalGunJoyDescriptor [protected]

DtConstrainedAnalogOutputPort* DtBallisticGunJoyController::myElevationPort [protected]

Output Port Name: elevation
Output Port Description:
Output Port Range: -1.

to 1.
Output Port Default Value:
Output Group Parent:

DtBooleanOutputPort* DtBallisticGunJoyController::myActiveJoystickPort [protected]

Output Port Name: joystick-active
Output Port Description: Indicates whether controller behavior is being executed through a joystick.

Output Port Range:
Output Port Default Value: false
Output Group Parent:

DtJoyDevice* DtBallisticGunJoyController::myJoyDevice [protected]

bool DtBallisticGunJoyController::myInitialized [protected]

bool DtBallisticGunJoyController::myFiring [protected]

bool DtBallisticGunJoyController::myChangeAmmo [protected]

DtReal DtBallisticGunJoyController::myElevation [protected]

---

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

• include/vrfmodel/balGunJoyCtlr.h