 |
VR-Forces 4.6 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.6 Class Documentation
|
DtHumanJoystickMovementControllerDescriptor. More...
Public Member Functions | |
| DtHumanJoystickMovementControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| constructor | |
| DtHumanJoystickMovementControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| virtual | ~DtHumanJoystickMovementControllerDescriptor () |
| destructor | |
| DtHumanJoystickMovementControllerDescriptor (const DtHumanJoystickMovementControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| DtHumanJoystickMovementControllerDescriptor & | operator= (const DtHumanJoystickMovementControllerDescriptor &orig) |
| assignment operator | |
| virtual DtComponentDescriptor * | clone (DtReaderWriterRegistry *parentRegistry=NULL) const |
| virtual DtString | type () const |
| Returns the type of descriptor. | |
| virtual void | setMaxTurningRate (double rate) |
| Accessor/mutator for myMaxTurningRate. | |
| virtual double | maxTurningRate () const |
 Public Member Functions inherited from DtJoyDeviceControllerDescriptor | |
| DtJoyDeviceControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtJoyDeviceControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtJoyDeviceControllerDescriptor (const DtJoyDeviceControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| virtual | ~DtJoyDeviceControllerDescriptor () |
| destructor | |
| Public Member Functions inherited from DtJoyDeviceControllerDescriptorTemplate< DtComponentDescriptor > | |
| DtJoyDeviceControllerDescriptorTemplate (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| constructor | |
| DtJoyDeviceControllerDescriptorTemplate (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtJoyDeviceControllerDescriptorTemplate (const DtJoyDeviceControllerDescriptorTemplate &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| virtual | ~DtJoyDeviceControllerDescriptorTemplate () |
| destructor | |
| DtJoyDeviceControllerDescriptorTemplate & | operator= (const DtJoyDeviceControllerDescriptorTemplate &orig) |
| assignment operator | |
| virtual void | setJoystickControls (const DtRwJoystickControls &) |
| Set a joystick control list. | |
| virtual const DtRwJoystickControls & | joystickControls () const |
| virtual bool | hasFunctionGroup (const DtString &) const |
| Returns true if contains the particular function group. | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| Overridden to call createFunctionGroupMap() once everything is read. | |
| Public Member Functions inherited from DtComponentDescriptor | |
| DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| DtComponentDescriptor & | operator= (const DtComponentDescriptor &orig) |
| assignment | |
| virtual | ~DtComponentDescriptor () |
| virtual void | putData (std::string &fp, int indentLevel=0) |
| Overrides base class putData to output our type. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| getData is just used to get us past the type in the data stream, since it's not actually stored. | |
| virtual bool | init () |
| Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary. | |
| bool | operator== (const DtComponentDescriptor &) const |
| DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL) | |
| virtual void | setComponentType (const DtString &componentType) |
| Type of DtSimComponent this descriptor is associated with. | |
| virtual const DtString & | componentType () const |
| virtual void | setMinTickPeriod (DtReal minTickPeriod) |
| virtual DtReal | minTickPeriod () const |
| virtual void | setMinTickPeriodVariance (DtReal minTickPeriodVariance) |
| virtual DtReal | minTickPeriodVariance () const |
| virtual void | setTickPeriodUsesRealTime (bool value) |
| Accessor/mutator for myTickPeriodUsesRealTime. | |
| virtual bool | tickPeriodUsesRealTime () const |
| virtual const DtString & | processStateRepositoryName () const |
| Name which this component will assign to its PSR. | |
| virtual void | setProcessStateRepositoryName (const DtString &name) |
| virtual const DtString & | processStateRepositoryType () const |
| Type of PSR this component will create. | |
| virtual void | setProcessStateRepositoryType (const DtString &type) |
| virtual void | setIsEnabled (bool yesNo) |
| Is the component enabled or not. | |
| virtual bool | isEnabled () const |
| virtual void | setDebugActive (bool active) |
| Should detailed debug info be printed for this component. | |
| virtual bool | debugActive () const |
| virtual void | setMinTaskVisualizationTickPeriod (DtReal minTickPeriod) |
| virtual DtReal | minTaskVisualizationTickPeriod () const |
| virtual void | setTaskVisualizationsEnabled (bool enabled) |
| virtual bool | taskVisualizationsEnabled () const |
| virtual void | setCreateComponent (bool yesNo) |
| Should the component be created or not. | |
| virtual bool | createComponent () const |
| virtual void | setCreateOnRemoteObject (bool yesNo) |
| Whether or not this component is created on remote versions of the object. | |
| virtual bool | createOnRemoteObject () const |
| 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 (std::string &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 (std::string &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 void | addAlias (const DtString &alias) |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. | |
| bool | isReadonly () const |
| virtual void | reset () |
| For those reader/writer items that support it, resets the reader/writer value to original 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 bool | changedSinceLastChecked () |
| Returns true if this objects value has changed since the last time this function was called. | |
| virtual bool | peekChangedSinceLastChecked () const |
| Returns the value that changedSinceLastChecked would return but does not reset the internal flag. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. | |
| virtual bool | valueSpecified () const |
| 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) |
| 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 () |
| 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 () |
| 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 &) |
| Restores 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. | |
| Public Member Functions inherited from DtJoyDeviceControllerDescriptorInterface | |
| DtJoyDeviceControllerDescriptorInterface () | |
| CTOR. | |
| virtual | ~DtJoyDeviceControllerDescriptorInterface () |
| DTOR. | |
Static Public Member Functions | |
| static DtComponentDescriptor * | creator () |
| | |
Protected Member Functions | |
| DtHumanJoystickMovementControllerDescriptor () | |
| default constructor; not implemented | |
Protected Attributes | |
parameters | |
These parameters are available for setting in the OPD files. | |
| DtRwReal | myMaxTurningRate |
| Parameter Name: max-turning-rate Parameter Description: Maximum turning rate of the entity. | |
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 Protected Attributes inherited from DtComponentDescriptor | |
| static DtComponentDescriptorFactory * | myFactory |
DtHumanJoystickMovementControllerDescriptor.
class DtHumanJoystickMovementControllerDescriptor:
Instances of DtHumanJoystickMovementControllerDescriptor allow the remapping of the axes used for steering and speed.
| DtHumanJoystickMovementControllerDescriptor::DtHumanJoystickMovementControllerDescriptor | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
constructor
| DtHumanJoystickMovementControllerDescriptor::DtHumanJoystickMovementControllerDescriptor | ( | const DtSymbolString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
|
virtual |
destructor
| DtHumanJoystickMovementControllerDescriptor::DtHumanJoystickMovementControllerDescriptor | ( | const DtHumanJoystickMovementControllerDescriptor & | orig, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
copy constructor
|
protected |
default constructor; not implemented
| DtHumanJoystickMovementControllerDescriptor& DtHumanJoystickMovementControllerDescriptor::operator= | ( | const DtHumanJoystickMovementControllerDescriptor & | orig | ) |
assignment operator
|
virtual |
Reimplemented from DtJoyDeviceControllerDescriptorTemplate< DtComponentDescriptor >.
|
virtual |
Returns the type of descriptor.
This will be used to create the descriptor read from an mtl file.
Reimplemented from DtJoyDeviceControllerDescriptor.
|
virtual |
Accessor/mutator for myMaxTurningRate.
|
virtual |
|
static |
Reimplemented from DtJoyDeviceControllerDescriptorTemplate< DtComponentDescriptor >.
|
protected |
Parameter Name: max-turning-rate
Parameter Description: Maximum turning rate of the entity.
Parameter Default Value: 3.14
Parameter Units: radians/second