![]() |
VR-Forces 4.1 Class Documentation
|
DtWeaponActuator is a simple model of a ballistic gun. More...

Public Member Functions | |
| DtWeaponActuator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| (const DtString&,DtVrfObject*,DtSimManager*, | |
| virtual | ~DtWeaponActuator () |
| destructor | |
| virtual bool | init () |
| to get access to the entity's localStateRepository, which this component will update, and then connect to the controller's ports. | |
| virtual DtString | type () const |
| Returns a string identifies the class type of component. | |
| virtual void | tick () |
| Fire if requested. | |
| virtual bool | postAddComponentsInit () |
| Overridden to initialize the value on myArtPartTypePort. | |
| virtual void | fireTheWeapon () |
| Calls createFireInteraction() and sends the resulting DtFireInteraction through the exercise connection. | |
| virtual DtFireInteraction * | createFireInteraction () |
| Creates and fills out a DtFireInteraction. Returns a DtFireInteraction. | |
| virtual void | setProjectileStartSpeed (DtReal startSpeed) |
| virtual DtReal | projectileStartSpeed () |
| virtual void | setMuzzleOffset (const DtVector &muzzleOffset) |
| virtual const DtVector & | muzzleOffset () |
| virtual const DtVector & | muzzleLocalPosition () |
| Returns the weapon muzzle’s position in local coordinates. | |
| virtual const DtDcm & | weaponOrientation () |
| Returns the rotation matrix needed to rotate a vector from body coordinates of the weapon to local coordinates. | |
| virtual DtArticulatedPartStateRepository * | getWeaponSimBody () |
| Looks up the DtSimBody* for the weapon in the entity’s state repository. | |
Public Member Functions inherited from DtActuatorComponent | |
| virtual | ~DtActuatorComponent () |
| destructor | |
| virtual DtSimBaseRadio * | radio () |
| virtual bool | tickWhileDestroyed () const |
| By default, all actuators tick when the entity is destroyed. | |
Public Member Functions inherited from DtSimComponent | |
| DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| virtual | ~DtSimComponent () |
| destructor | |
| void | setParentSystem (DtComponentSystem *system) |
| Sets the parent system of this component. | |
| virtual void | preFirstTickInit () |
| This function can be overridden to initialize a component before it is ticked for the first time. | |
| virtual void | postTick () |
| This function is called immediately after tick() is called. | |
| virtual void | timedTick () |
| This version of tick checks to see if the time to tick has arrived. | |
| virtual void | setMinTickPeriod (double minTickPeriod) |
| specifies a minimum tick period (which can also be thought of as | |
| virtual double | minTickPeriod () const |
| access the minimum tick period | |
| virtual void | setMinTickPeriodVariance (double minTickPeriodVariance) |
| set the variance in the minimum tick time | |
| virtual double | minTickPeriodVariance () const |
| access the variance in the minimum tick period | |
| virtual void | setNextTickTime (double nextTickTime) |
| The next tick time is normally calculated internally. | |
| virtual double | nextTickTime () const |
| access the next tick time | |
| virtual double | calculateNextTickTime () const |
| The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. | |
| virtual double | calculateFirstTickTime () const |
| Returns the first time value that the component should tick at. | |
| virtual void | setEntity (DtVrfObject *entity) |
| The entity's state repository is the place that actuator components make updates and other components look to see our current state. | |
| virtual DtSimComponent * | nextComponent () |
| List management functions. | |
| virtual DtSimComponent * | prevComponent () |
| virtual void | setListItem (DtListItem *item) |
| Used by DtComponentList. | |
| virtual DtListItem * | listItem () |
| virtual void | putData (FILE *fp, int indentLevel=0) |
| putData writes our type, which is provided by the virtual type accessor of the deriving class. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| getData is just used to get us past the type in the data stream, since it's not actual stored. | |
| virtual void | addInputPort (DtInputPort *port) |
| Adds this input port to the components input port list so that other components can look it up and attach to it. | |
| virtual void | removeInputPort (DtInputPort *port) |
| virtual DtInputPort * | lookupInputPort (const DtString &portName) |
| Returns a pointer to the input port registered on this component with the specified name. | |
| virtual DtList | inputPortList () const |
| Returns the list of DtInputPorts registered on this component. | |
| virtual void | addOutputPort (DtOutputPort *port) |
| Adds this output port to the components output port list so that other components can look it up and attach to it. | |
| virtual void | removeOutputPort (DtOutputPort *port) |
| virtual DtOutputPort * | lookupOutputPort (const DtString &portName) |
| Returns a pointer to the output port registered on this component with the specified name. | |
| virtual DtList | outputPortList () const |
| Returns the list of DtOutputPorts registered on this component. | |
| virtual void | addInputPortGroup (DtInputPortGroup *group) |
| Adds this input port to the components input port list so that other components can look it up and attach to it. | |
| virtual void | removeInputPortGroup (DtInputPortGroup *group) |
| virtual DtInputPortGroup * | lookupInputPortGroup (const DtString &groupName) |
| Returns a pointer the input port group registered on this component with the specified name. | |
| virtual DtList | inputPortGroupList () const |
| Returns the list of DtInputPortGroups registered on this component. | |
| virtual void | addOutputPortGroup (DtOutputPortGroup *group) |
| Adds this output port group to the components output port group list so that other components can look it up and attach to it. | |
| virtual void | removeOutputPortGroup (DtOutputPortGroup *group) |
| virtual DtOutputPortGroup * | lookupOutputPortGroup (const DtString &groupName) |
| Returns a pointer the output port group registered on this component with the specified name. | |
| virtual DtList | outputPortGroupList () const |
| Returns the list of DtOutputPortGroups registered on this component. | |
| virtual int | priority () const |
| Return the current connection priority for this component. | |
| virtual void | setPriority (int priority) |
| Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value. | |
| double | dT () const |
| This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. | |
| virtual void | setDT (double deltaT) |
| Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary. | |
| virtual void | setComponentDescriptor (DtComponentDescriptor *componentDescriptor) |
| The component descriptor specified in the order of battle file or parameter file that was used to create this component. | |
| virtual const DtComponentDescriptor * | componentDescriptor () const |
| DtVrfProcessStateRepositoryManager * | psrManager () |
| virtual DtString | componentFullName () const |
| virtual void | enable () |
| Is this component enabled or not. | |
| virtual void | disable () |
| Is this component enabled or not. | |
| virtual bool | isEnabled () |
| Is this component enabled or not. | |
| virtual void | setIsEnabled (bool yesNo) |
| Is this component enabled or not. | |
| virtual DtOutputStream & | objectConsoleDebug () const |
| virtual DtOutputStream & | objectConsoleVerbose () const |
| virtual DtOutputStream & | objectConsoleInfo () const |
| virtual DtOutputStream & | objectConsoleWarn () const |
| virtual DtOutputStream & | objectConsoleError () const |
| virtual DtSimResourceManager & | resourceManager () |
| virtual const DtSimResourceManager & | resourceManager () 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) | |
| copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator | |
| 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 | getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. | |
| 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 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 DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| 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 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 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. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| Collection of child DtReaderWriter nodes owned by this object. | |
Static Public Member Functions | |
| static DtSimComponent * | creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| (const DtString&,DtVrfObject*,DtSimManager*, | |
Protected Member Functions | |
| virtual bool | createPortGroups () |
| Creates the local port groups. | |
| virtual bool | createPorts () |
| Creates the input ports and adds them to the component. | |
| virtual bool | createPSR () |
| Creates #myProcessState data member, and adds it to our process state repository manager. | |
| DtWeaponActuator () | |
| default constructor; not implemented | |
| DtWeaponActuator (const DtWeaponActuator &orig) | |
| copy constructor; not implemented | |
| const DtWeaponActuator & | operator= (const DtWeaponActuator &orig) |
| assignment operator; not implemented | |
Protected Member Functions inherited from DtActuatorComponent | |
| DtActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| (const DtString& name, | |
| DtActuatorComponent (const DtActuatorComponent &orig) | |
| copy constructor | |
| const DtActuatorComponent & | operator= (const DtActuatorComponent &orig) |
| assignment operator | |
| virtual void | setRadio (DtSimBaseRadio *radio) |
| DtActuatorComponent () | |
| Default constructor; should not be called. | |
Protected Member Functions inherited from DtSimComponent | |
| bool | testInvariant () const |
| virtual DtPhysicalWorld * | physicalWorld () |
| Gets the physical world that this component's entity exists in. | |
| virtual const DtPhysicalWorld * | physicalWorld () const |
| virtual DtAttachedTerrain * | terrainAttachedTo () |
| Gets the terrain that this component's entity is attached to, if any. | |
| virtual const DtAttachedTerrain * | terrainAttachedTo () const |
| virtual DtVrfObject * | entity () |
| Gets the entity. | |
| virtual const DtVrfObject * | entity () const |
| virtual DtSimManager * | simManager () |
| Gets the sim manager. | |
| virtual const DtSimManager * | simManager () const |
| virtual const Coordinate_System * | coordinateSystem () const |
| Gets the coordinate system, as it should always exist if the physical world is in a valid state! | |
| virtual Coordinate_System * | coordinateSystem () |
| virtual DtVrfObjectStateRepository * | localStateRepository () |
| Gets the local state repository. | |
| virtual const DtVrfObjectStateRepository * | localStateRepository () const |
Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. | |
| 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. | |
Protected Attributes | |
| DtWeaponActuatorDescriptor * | myWeaponActuatorDescriptor |
| DtEntityIdentifier | myObjectId |
| DtReal | myProjectileStartSpeed |
| DtVector | myMuzzleOffset |
| DtVrfObject * | myCurrentEntityTarget |
| These are set by createFireInteraction and used by createDetonationInteraction. | |
| DtEventId | myCurrentEventId |
| DtReal | myCurrentRange |
| DtVrfWeaponPSR * | myWeaponProcessState |
Ports and Port Groups | |
| DtInputPortGroup * | myWeaponInputPortGroup |
| Input Port Group Name: weapon-control Input Port Group Description: | |
| DtAmmunitionInputPort * | myAmmunitionPort |
| Input Port Name: ammunition Input Port Description: Type of ammo to fire. | |
| DtConstrainedIntegerInputPort * | myFusePort |
| Input Port Name: fuze Input Port Description: DIS Enumeration for fuze (see DIS Enumeration and Bit Encoded Values document for values). | |
| DtBooleanInputPort * | myTriggerPort |
| Input Port Name: trigger Input Port Description: True to fire. | |
| DtBooleanInputPort * | myLoadedPort |
| Input Port Name: loaded Input Port Description: True if loaded. | |
| DtOutputPortGroup * | myWeaponOutputPortGroup |
| Output Port Group Name: weapon-info Output Port Group Description: | |
| DtIntegerOutputPort * | myArtPartTypePort |
| Output Port Name: art-part-type Output Port Description: Type of the articulated part. | |
Protected Attributes inherited from DtActuatorComponent | |
| DtSimBaseRadio * | myRadio |
| Actuators can send messages. | |
Protected Attributes inherited from DtSimComponent | |
| DtVrfObject * | myEntity |
| DtVrfObjectStateRepository * | myLocalStateRepository |
| DtSimManager * | mySimManager |
| DtComponentSystem * | mySystem |
| Pointer to the DtComponentSystem that this component belongs. | |
| DtListItem * | myListItem |
| DtInputPortMap | myInputPortList |
| DtOutputPortMap | myOutputPortList |
| DtInputPortGroupMap | myInputPortGroupList |
| DtOutputPortGroupMap | myOutputPortGroupList |
| int | myPriority |
| double | myMinTickPeriod |
| double | myMinTickPeriodVariance |
| double | myNextTickTime |
| double | myLastTickSimTime |
| double | myDT |
| bool | myIsEnabled |
| Indicates whether this component should be enabled for ticking or not. | |
| bool | myFirstTick |
| Initialized to true in the constructor, set to false by the first call to postTick. | |
| const DtComponentDescriptor * | myComponentDescriptor |
Protected Attributes inherited from DtReaderWriter | |
| const DtSymbolString | myName |
| DtReaderWriterRegistry | myRegistry |
| bool | myValueSpecified |
| bool | myReadOnlyFlag |
| bool | myIsVariableReference |
| DtSymbolString | myVariableName |
| bool | myVariableIsBound |
| 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. | |
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::pair < DtSymbolString, DtString > | DtVariableNameType |
Protected Types inherited from DtSimComponent | |
| typedef std::map< DtString, DtInputPort * > | DtInputPortMap |
| typedef std::map< DtString, DtOutputPort * > | DtOutputPortMap |
| typedef std::map< DtString, DtInputPortGroup * > | DtInputPortGroupMap |
| typedef std::map< DtString, DtOutputPortGroup * > | DtOutputPortGroupMap |
Static Protected Attributes inherited from DtSimComponent | |
| static DtSimComponentFactory * | myFactory |
DtWeaponActuator is a simple model of a ballistic gun.
End User Description: It can be given ammo to load, and the command to fire. It creates a fire interaction and preps a detonation interaction at the appropriate time. A derived type of this component, the DtLauncherActuator is used to simulate missile launchers in VR-Forces.
The weapon actuator provides a generic model of a ballistic gun. The indirect fire actuator and launcher actuator are children of the weapon actuator. It accepts ammunition type, load status, and trigger inputs. When the actuator is fired, it creates and sends a fire interaction. Because the weapon actuator does not prepare and send a detonation interaction as part of the firing process, the ballistic gun actuator may be a more appropriate choice for some situations (the ballistic gun actuator determines the detonation result of munition using probability tables, and generates the detonation interaction.).
Uses Descriptor Type: DtWeaponActuatorDescriptor
| DtWeaponActuator::DtWeaponActuator | ( | const DtString & | name, |
| DtVrfObject * | owner, | ||
| DtSimManager * | simManager, | ||
| DtComponentDescriptor * | desc = 0, |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
(const DtString&,DtVrfObject*,DtSimManager*,
| 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). |
|
virtual |
destructor
|
protected |
default constructor; not implemented
|
protected |
copy constructor; not implemented
|
virtual |
to get access to the entity's localStateRepository, which this component will update, and then connect to the controller's ports.
Calls createPSR() to creat e
Reimplemented from DtActuatorComponent.
Reimplemented in DtLauncherActuator.
|
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.
Reimplemented from DtSimComponent.
Reimplemented in DtIndirectFireActuator, and DtLauncherActuator.
|
virtual |
Fire if requested.
Reimplemented from DtSimComponent.
|
virtual |
Overridden to initialize the value on myArtPartTypePort.
Reimplemented from DtSimComponent.
|
virtual |
Calls createFireInteraction() and sends the resulting DtFireInteraction through the exercise connection.
Reimplemented in DtIndirectFireActuator, and DtLauncherActuator.
|
virtual |
Creates and fills out a DtFireInteraction. Returns a DtFireInteraction.
Reimplemented in DtIndirectFireActuator.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Returns the weapon muzzle’s position in local coordinates.
It calls getWeaponSimBody() to get the DtSimBody associated with the weapon. If no DtSimBody part is found for the weapon, it returns the local position of the entity. If it is found, it calls DtSimBody::calculateMeInWorld() to get the position of the weapon in local coordinates. It rotates the muzzle offset (stored by the entity in body coordinates in myMuzzleOffset) by the weapon’s current orientation (a rotation matrix returned by weaponOrientation()), to get the offset in local coordinates. It then adds the offset to the weapon’s local position to get the muzzle position in local coordinates, and returns.
|
virtual |
Returns the rotation matrix needed to rotate a vector from body coordinates of the weapon to local coordinates.
It looks up the DtSimBody associated with the weapon by calling getWeaponSimBody(). If it finds the DtSimBody, it returns the rotation matrix given by the DtSimBody::calculateMeToWorld(). If it does not find the DtSimBody, it calls DtEuler_to_BodyToLocalRef() with the entity’s local orientation, and returns the resulting matrix instead.
|
virtual |
Looks up the DtSimBody* for the weapon in the entity’s state repository.
It first looks up the articulated part type specified in the component’s articulated part descriptor list. If it finds the articulated part type, it tries to look up the DtSimBody in the entity’s state repository, using the articulated part type as a key. If it finds DtSimBody, it returns a pointer to the DtSimBody, if it does not, it returns NULL.
|
static |
(const DtString&,DtVrfObject*,DtSimManager*,
| 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). |
Reimplemented in DtIndirectFireActuator, and DtLauncherActuator.
|
protectedvirtual |
Creates the local port groups.
Reimplemented from DtSimComponent.
|
protectedvirtual |
Creates the input ports and adds them to the component.
Reimplemented from DtSimComponent.
Reimplemented in DtIndirectFireActuator, and DtLauncherActuator.
|
protectedvirtual |
Creates #myProcessState data member, and adds it to our process state repository manager.
Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.
Reimplemented in DtIndirectFireActuator.
|
protected |
assignment operator; not implemented
|
protected |
Input Port Group Name: weapon-control
Input Port Group Description:
|
protected |
Input Port Name: ammunition
Input Port Description: Type of ammo to fire.
Input Port Range:
Input Port Default Value:
Input Group Parent: weapon-control
|
protected |
Input Port Name: fuze
Input Port Description: DIS Enumeration for fuze (see DIS Enumeration and Bit Encoded Values document for values).
Input Port Range:
Input Port Default Value:
Input Group Parent: weapon-control
|
protected |
Input Port Name: trigger
Input Port Description: True to fire.
Input Port Range:
Input Port Default Value:
Input Group Parent: weapon-control
|
protected |
Input Port Name: loaded
Input Port Description: True if loaded.
Input Port Range:
Input Port Default Value:
Input Group Parent: weapon-control
|
protected |
Output Port Group Name: weapon-info
Output Port Group Description:
|
protected |
Output Port Name: art-part-type
Output Port Description: Type of the articulated part.
See the DIS Enumeration and Bit Encoded Values document for values.
Output Port Range:
Output Port Default Value:
Output Group Parent: weapon-info
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
These are set by createFireInteraction and used by createDetonationInteraction.
|
protected |
|
protected |
|
protected |