DtRwJoystickControl Class Reference

File: rwJoystickControlInformation.h.

Class: DtRwJoystickControl and DtRwJoystickControlInformation class DtRwJoystickControl:

Instances of DtRwJoystickControl is information that can be used to specified a particular joystick control

Inheritance diagram for DtRwJoystickControl:

Public Member Functions
	DtRwJoystickControl ()
	DtRwJoystickControl (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwJoystickControl (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwJoystickControl (const DtRwJoystickControl &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtRwJoystickControl &	operator= (const DtRwJoystickControl &orig)
virtual	~DtRwJoystickControl ()
virtual const char *	xmlType () const
virtual void	setFunctionName (const DtString &)
virtual const DtString &	functionName () const
virtual void	setFunctionGroup (const DtString &)
virtual const DtString &	functionGroup () const
virtual void	setDescription (const DtString &)
virtual const DtString &	description () const
virtual void	setMinimumValue (double)
virtual double	minimumValue () const
virtual void	setMaximumValue (double)
virtual double	maximumValue () const
virtual void	setCycle (bool)
virtual bool	cycle () const
bool	operator== (const DtRwJoystickControl &) const
bool	operator!= (const DtRwJoystickControl &rhs)
virtual char *	encode (char *) const
virtual const char *	decode (const char *)
virtual int	getSize () const
virtual const char *	readerWriterType () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	wasUpdatedSince (DtTime t) const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
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())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static const char *	theXmlType ()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwString	myFunctionName
DtRwString	myFunctionGroup
DtRwString	myDescription
DtRwReal	myMinimumValue
DtRwReal	myMaximumValue
DtRwBoolean	myCycle
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
bool	myInvalid
bool	myChangedFlag

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 )()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
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
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtRwJoystickControl::DtRwJoystickControl

(

)

default constructor

DtRwJoystickControl::DtRwJoystickControl	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

DtRwJoystickControl::DtRwJoystickControl	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtRwJoystickControl::DtRwJoystickControl	(	const DtRwJoystickControl &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtRwJoystickControl::~DtRwJoystickControl ( )

virtual

destructor

Member Function Documentation

DtRwJoystickControl& DtRwJoystickControl::operator=

(

const DtRwJoystickControl &

orig

)

Assignment operator; removes and deletes all entries on the left hand side - then clones all entries on the right side list, adding them to the left side list.

static const char* DtRwJoystickControl::theXmlType ( )

static

The type that is used when archiving to an XML stream.

virtual const char* DtRwJoystickControl::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

virtual void DtRwJoystickControl::setFunctionName ( const DtString &  )

virtual

virtual const DtString& DtRwJoystickControl::functionName ( ) const

virtual

virtual void DtRwJoystickControl::setFunctionGroup ( const DtString &  )

virtual

virtual const DtString& DtRwJoystickControl::functionGroup ( ) const

virtual

virtual void DtRwJoystickControl::setDescription ( const DtString &  )

virtual

virtual const DtString& DtRwJoystickControl::description ( ) const

virtual

virtual void DtRwJoystickControl::setMinimumValue ( double  )

virtual

virtual double DtRwJoystickControl::minimumValue ( ) const

virtual

virtual void DtRwJoystickControl::setMaximumValue ( double  )

virtual

virtual double DtRwJoystickControl::maximumValue ( ) const

virtual

virtual void DtRwJoystickControl::setCycle ( bool  )

virtual

virtual bool DtRwJoystickControl::cycle ( ) const

virtual

bool DtRwJoystickControl::operator==

(

const DtRwJoystickControl &

)

const

bool DtRwJoystickControl::operator!= ( const DtRwJoystickControl &  rhs )

inline

virtual char* DtRwJoystickControl::encode ( char *  ) const

virtual

virtual const char* DtRwJoystickControl::decode ( const char *  )

virtual

virtual int DtRwJoystickControl::getSize ( ) const

virtual

virtual const char* DtRwJoystickControl::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is. This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtRwString DtRwJoystickControl::myFunctionName

protected

Parameter Name: function-name
Parameter Description: As part of a funtion group, within a controller that implements the calcAndSetPortValues method, this is the function that the user wants to fire off in response to a joystick or keyboard function.
Parameter Default Value:
.

DtRwString DtRwJoystickControl::myFunctionGroup

protected

Parameter Name: function-group
Parameter Description: A collection of functions that can be implemented by a joystick controller.
Parameter Default Value:
.

DtRwString DtRwJoystickControl::myDescription

protected

Parameter Name: description
Parameter Description: A user friendly description of this joystick function.
Parameter Default Value:
.

DtRwReal DtRwJoystickControl::myMinimumValue

protected

Parameter Name: min-value
Parameter Description: The minimum value of this joystick control. If the minimum and maximum values are the same, this is considered to be a push button (on/off) where the value is either 0 or the value specified in minimum or maximum value. If this value is lower than the maximum value it is considered to be a ranged value that can be set wither via a keyboard control or by a joystick.
Parameter Default Value: 0
.

DtRwReal DtRwJoystickControl::myMaximumValue

protected

Parameter Name: max-value
Parameter Description: The maximum value of this joystick control. If the minimum and maximum values are the same, this is considered to be a push button (on/off) where the value is either 0 or the value specified in minimum or maximum value. If this value is higher than the minimum value it is considered to be a ranged value that can be set wither via a keyboard control or by a joystick.
Parameter Default Value: 0
.

DtRwBoolean DtRwJoystickControl::myCycle

protected

Parameter Name: cycle
Parameter Description: Whether or not the values between min and max are cycled through one at a time (i.e. for a gear shift). If this value is true then this value cannot be set by a joystick axis. Cycling will increase the value by 1 for each button/keyboard press, so, if your min value is -0.5 and your max value is 1.5 the cycle will be -0.5, .5, 1.5, -0.5, etc.
Parameter Default Value: false
.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfutil/rwJoystickControls.h