DtJoyDeviceManager Class Reference

Inheritance diagram for DtJoyDeviceManager:

Public Member Functions
	DtJoyDeviceManager (const DtString &name, DtSimManager *simManager, DtReaderWriterRegistry *parentRegistry=NULL)
	DtJoyDeviceManager (const DtSymbolString &name, DtSimManager *simManager, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtJoyDeviceManager ()
	destructor
virtual bool	init ()
	init, read in the parameter file "joyParam.dat".
virtual void	tick ()
	Calls joyDeltas() on the joy device to get new joystick events.
virtual DtJoyDevice *	joyDevice ()
	Accessor to the joydevice.
virtual bool	chooseDevice ()
	Create the right device specified in the parameter file.
virtual const DtJoyInit	getDefaults ()
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Protected Member Functions
virtual void	processJoyDeviceRequest (DtIfJoyDeviceRequest *request)
	Process the callback.
	DtJoyDeviceManager ()
	default constructor
virtual void	setDefaults ()
	Set default parameters.
	DtJoyDeviceManager (const DtJoyDeviceManager &orig)
	copy constructor
DtJoyDeviceManager &	operator= (const DtJoyDeviceManager &orig)
	assignment operator
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Static Protected Member Functions
static void	joyDeviceRequestCallback (DtSimMessage *msg, void *usr)
	Interface callback for enable the joy device for specified entity.

Protected Attributes
DtJoyDevice *	myJoyDevice
DtSimManager *	mySimManager
bool	myInitialized
DtString	myEntityUsingJoyDevice
DtRwString	myDeviceType
	Object name of the last entity that.
DtRwReal	myTransSensitivity
DtRwReal	myTransGain
DtRwInt	myTransInvertX
DtRwInt	myTransInvertY
DtRwInt	myTransInvertZ
DtRwReal	myRotSensitivity
DtRwReal	myRotGain
DtRwInt	myRotInvertX
DtRwInt	myRotInvertY
DtRwInt	myRotInvertZ
DtRwInt	myWantPOV
	tripp, no sb
DtRwString	myLinuxDevice
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Static Protected Attributes
static const char	theDeviceTypeName []
static const char	theTransSensitivityName []
static const char	theTransGainName []
static const char	theTransInvertXName []
static const char	theTransInvertYName []
static const char	theTransInvertZName []
static const char	theRotSensitivityName []
static const char	theRotGainName []
static const char	theRotInvertXName []
static const char	theRotInvertYName []
static const char	theRotInvertZName []
static const char	theWantPOVName []
static const char	theLinuxDeviceName []
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.

Constructor & Destructor Documentation

DtJoyDeviceManager::DtJoyDeviceManager	(	const DtString &	name,
		DtSimManager *	simManager,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtJoyDeviceManager::DtJoyDeviceManager	(	const DtSymbolString &	name,
		DtSimManager *	simManager,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtJoyDeviceManager::~DtJoyDeviceManager ( )

virtual

destructor

DtJoyDeviceManager::DtJoyDeviceManager ( )

protected

default constructor

DtJoyDeviceManager::DtJoyDeviceManager ( const DtJoyDeviceManager &  orig )

protected

copy constructor

Member Function Documentation

virtual bool DtJoyDeviceManager::init ( )

virtual

init, read in the parameter file "joyParam.dat".

virtual void DtJoyDeviceManager::tick ( )

virtual

Calls joyDeltas() on the joy device to get new joystick events.

virtual DtJoyDevice* DtJoyDeviceManager::joyDevice ( )

virtual

Accessor to the joydevice.

virtual bool DtJoyDeviceManager::chooseDevice ( )

virtual

Create the right device specified in the parameter file.

virtual const DtJoyInit DtJoyDeviceManager::getDefaults ( )

virtual

static void DtJoyDeviceManager::joyDeviceRequestCallback ( DtSimMessage *  msg, void *  usr  )

staticprotected

Interface callback for enable the joy device for specified entity.

virtual void DtJoyDeviceManager::processJoyDeviceRequest ( DtIfJoyDeviceRequest *  request )

protectedvirtual

Process the callback.

virtual void DtJoyDeviceManager::setDefaults ( )

protectedvirtual

Set default parameters.

DtJoyDeviceManager& DtJoyDeviceManager::operator= ( const DtJoyDeviceManager &  orig )

protected

assignment operator

Member Data Documentation

DtJoyDevice* DtJoyDeviceManager::myJoyDevice

protected

DtSimManager* DtJoyDeviceManager::mySimManager

protected

bool DtJoyDeviceManager::myInitialized

protected

DtString DtJoyDeviceManager::myEntityUsingJoyDevice

protected

DtRwString DtJoyDeviceManager::myDeviceType

protected

Object name of the last entity that.

used the joy device. Joy device parameters.

DtRwReal DtJoyDeviceManager::myTransSensitivity

protected

DtRwReal DtJoyDeviceManager::myTransGain

protected

DtRwInt DtJoyDeviceManager::myTransInvertX

protected

DtRwInt DtJoyDeviceManager::myTransInvertY

protected

DtRwInt DtJoyDeviceManager::myTransInvertZ

protected

DtRwReal DtJoyDeviceManager::myRotSensitivity

protected

DtRwReal DtJoyDeviceManager::myRotGain

protected

DtRwInt DtJoyDeviceManager::myRotInvertX

protected

DtRwInt DtJoyDeviceManager::myRotInvertY

protected

DtRwInt DtJoyDeviceManager::myRotInvertZ

protected

DtRwInt DtJoyDeviceManager::myWantPOV

protected

tripp, no sb

DtRwString DtJoyDeviceManager::myLinuxDevice

protected

const char DtJoyDeviceManager::theDeviceTypeName[]

staticprotected

const char DtJoyDeviceManager::theTransSensitivityName[]

staticprotected

const char DtJoyDeviceManager::theTransGainName[]

staticprotected

const char DtJoyDeviceManager::theTransInvertXName[]

staticprotected

const char DtJoyDeviceManager::theTransInvertYName[]

staticprotected

const char DtJoyDeviceManager::theTransInvertZName[]

staticprotected

const char DtJoyDeviceManager::theRotSensitivityName[]

staticprotected

const char DtJoyDeviceManager::theRotGainName[]

staticprotected

const char DtJoyDeviceManager::theRotInvertXName[]

staticprotected

const char DtJoyDeviceManager::theRotInvertYName[]

staticprotected

const char DtJoyDeviceManager::theRotInvertZName[]

staticprotected

const char DtJoyDeviceManager::theWantPOVName[]

staticprotected

const char DtJoyDeviceManager::theLinuxDeviceName[]

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/joyDeviceManager.h