 |
VR-Forces 4.10 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.10 Class Documentation
|
DtBallisticGun provides a simple model of a ballistic gun. More...
Public Member Functions | |
| DtBallisticGun (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| virtual | ~DtBallisticGun () |
| destructor More... | |
| virtual bool | init () |
| Overridden to cache a pointer to the entity's radio in this class. More... | |
| virtual void | initPendingDetonations () |
| Called in the first tick. More... | |
| virtual const char * | type () const |
| Returns a string identifies the class type of component. More... | |
| virtual void | preFirstTickInit () |
| Calls initPendingDetonations. More... | |
| virtual void | tick () |
| Update the gun elevation. More... | |
| virtual void | fire (int roundsToFire, bool computePHit) |
| Create the fire interaction for the fire event and schedule a detonation. More... | |
| virtual bool | checkHitProbability (const DtEntityType &type, DtReal range, int burstSize=1) |
| Returns true if we hit the target, false otherwise. More... | |
| virtual double | hitProbabilityModifier (const DtEntityType &type, DtReal range, int burstSize=1) |
| Computes and returns a hit probability modifier based on motion and other effects. More... | |
| virtual double | targetMotionHitModifier (const DtEntityType &type, DtReal range) |
| Computes and returns a modifier (0-1) to account for target motion. More... | |
| virtual double | selfMotionHitModifier (const DtEntityType &type, DtReal range) |
| Computes and returns a modifier (0-1) to account for self motion. More... | |
| virtual double | skillLevelModifier (const double range) |
| Calculates a modifier on the probability of hit based on range and the training level of the entity. More... | |
| virtual double | lifeformPostureModifier () |
| Calculates a modifier to hit probability based on entity (lifeform) posture. More... | |
| virtual double | burstSizeModifier (int burstSize) |
| Calculates a modifier to hit probability based on burst size. More... | |
| virtual DtFireInteraction * | createFireInteraction (const int rounds) |
| Allocates a DtFireInteraction and then uses the munition information specified on the munition and fuze ports, as well as the current target reported by the entity, to fill in the necessary fields. More... | |
| virtual DtDetonationInteraction * | createDetonationInteraction (int burstSize, DtTime &detTime, bool &isHit, bool assureMiss=false) |
| Allocates a DtDetonationInteraction. More... | |
| virtual void | getMissLocation (DtVector gunPosition, const DtVrfObjectStateRepository *intendedTargetSR, double muzzleSpeed, DtVector &missLocation, DtVector &velocityVector, DtDetonationResult &detonationResult, const DtVrfObject **target) |
| Computes the location of a miss. More... | |
| virtual void | scheduleDetonation (DtDetonationInteraction *detInter, DtTime detTime) |
| Schedules the sending of the DtDetonationInteraction passed as the first argument at a point in the future specified by the second argument, using the DtScheduler facility (which is accessed through the DtSimManager). More... | |
| virtual DtString | probabilityString () const |
| virtual DtVector | calculateMuzzlePosition () const |
| Finds the correct muzzle placement for the gun. More... | |
| virtual DtDetonationInteraction * | createDetonationInteraction (const DtDetonationDescriptor &desc, DtTime &detTime) |
| Creates a new DtDetonationInteraction, given a DtDetonationDescriptor. More... | |
| virtual DtDetonationDescriptor * | createDetonationDescriptor (DtDetonationInteraction *detInter, DtTime simTime) |
| Creates and fills out a new DtDetonationDescriptor, given a DtDetonationInteraction and a time (simulation time to fire, in seconds). More... | |
| virtual double | maxGunRange () const |
| Look up the maximum range of the gun from the P(Hit) table given in the descriptor. More... | |
 Public Member Functions inherited from DtActuatorComponent | |
| virtual | ~DtActuatorComponent () |
| destructor More... | |
| virtual DtSimRadio * | radio () |
| virtual bool | tickWhileDestroyed () const |
| By default, all actuators tick when the entity is destroyed. More... | |
| Public Member Functions inherited from DtSimComponent | |
| DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| virtual | ~DtSimComponent () |
| destructor More... | |
| virtual void | setParentSystem (DtComponentSystem *system) |
| Sets the parent system of this component. More... | |
| DtComponentSystem * | parentSystem () const |
| virtual bool | postAddComponentsInit () |
| Called after all components have been created, initialized and added to the component manager. More... | |
| virtual void | registerAttributeFunctions () |
| Called to register functions that provide system attribute values. More... | |
| virtual void | postTick () |
| This function is called immediately after tick() is called. More... | |
| virtual void | timedTick () |
| This version of tick checks to see if the time to tick has arrived. More... | |
| virtual void | setMinTickPeriod (double minTickPeriod) |
| specifies a minimum tick period (which can also be thought of as More... | |
| virtual double | minTickPeriod () const |
| access the minimum tick period More... | |
| virtual void | setMinTickPeriodVariance (double minTickPeriodVariance) |
| set the variance in the minimum tick time More... | |
| virtual double | minTickPeriodVariance () const |
| access the variance in the minimum tick period More... | |
| virtual void | setNextTickTime (double nextTickTime) |
| The next tick time is normally calculated internally. More... | |
| virtual double | nextTickTime () const |
| access the next tick time More... | |
| virtual double | calculateNextTickTime () const |
| The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More... | |
| virtual double | calculateFirstTickTime () const |
| Returns the first time value that the component should tick at. More... | |
| 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. More... | |
| virtual DtSimComponent * | nextComponent () |
| List management functions. More... | |
| virtual DtSimComponent * | prevComponent () |
| virtual void | setListItem (DtListItem *item) |
| Used by DtComponentList. More... | |
| virtual DtListItem * | listItem () |
| virtual void | putData (std::string &fp, int indentLevel=0) |
| putData writes our type, which is provided by the virtual type accessor of the deriving class. More... | |
| 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 actual stored. More... | |
| 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. More... | |
| 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. More... | |
| virtual DtList | inputPortList () const |
| Returns the list of DtInputPorts registered on this component. More... | |
| 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. More... | |
| 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. More... | |
| virtual DtList | outputPortList () const |
| Returns the list of DtOutputPorts registered on this component. More... | |
| 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. More... | |
| 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. More... | |
| virtual DtList | inputPortGroupList () const |
| Returns the list of DtInputPortGroups registered on this component. More... | |
| 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. More... | |
| 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. More... | |
| virtual DtList | outputPortGroupList () const |
| Returns the list of DtOutputPortGroups registered on this component. More... | |
| virtual int | priority () const |
| Return the current connection priority for this component. More... | |
| 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. More... | |
| double | dT () const |
| This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. More... | |
| 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. More... | |
| 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. More... | |
| virtual const DtComponentDescriptor * | componentDescriptor () const |
| DtVrfProcessStateRepositoryManager * | psrManager () |
| virtual const DtSymbolString & | componentFullName () const |
| DtPhysicalWorld * | physicalWorld () |
| Gets the physical world that this component's entity exists in. More... | |
| const DtPhysicalWorld * | physicalWorld () const |
| DtAttachedTerrain * | terrainAttachedTo () |
| Gets the terrain that this component's entity is attached to, if any. More... | |
| const DtAttachedTerrain * | terrainAttachedTo () const |
| DtVrfObject * | entity () |
| Gets the entity. More... | |
| const DtVrfObject * | entity () const |
| const DtVrfObject * | const_entity () const |
| You would want to use this call if you could be either a const or non-const entity, and you wanted to be sure you only had const access. More... | |
| DtSimManager * | simManager () |
| Gets the sim manager. More... | |
| const DtSimManager * | simManager () const |
| const Coordinate_System * | coordinateSystem () const |
| Gets the coordinate system, as it should always exist if the physical world is in a valid state! More... | |
| DtVrfObjectStateRepository * | localStateRepository () |
| Gets the local state repository. More... | |
| const DtVrfObjectStateRepository * | localStateRepository () const |
| const DtVrfObjectStateRepository * | const_localStateRepository () const |
| You would want to use this call if you could be either a const or non-const local state repository, and you wanted to be sure you only had const access. More... | |
| virtual DtTaskVisualizationMap & | taskVisualizations () |
| Returns the list of task visualizations for this component. More... | |
| virtual bool | taskVisualizationsActive () const |
| Returns true if task visualizations are currently active for this component. More... | |
| virtual bool | taskVisualizationsEnabled () const |
| Returns true if task visualizations are enabled for this component. More... | |
| virtual bool | isThreadSafe () const |
| Returns true if this component is marked as being thread safe. More... | |
| virtual void | addVRLinkDeferredJob (const boost::function< void()> &callback) |
| Adds a deferred job to the VRLink job queue in the DtParallelTickManager, but only if this component is marked at thread safe. More... | |
| virtual void | onRestore () |
| Called whenever a component is restored. Default is no-op. More... | |
| virtual void | enable () |
| Is this component enabled or not. More... | |
| virtual void | disable () |
| virtual bool | isEnabled () |
| virtual void | setIsEnabled (bool yesNo) |
| virtual DtOutputStream & | objectConsoleDebug (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleVerbose (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleInfo (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleWarn (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleError (const DtString &channel="") const |
| virtual DtSimResourceManager & | resourceManager () |
| virtual const DtSimResourceManager & | resourceManager () const |
| Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| default constructor More... | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| real constructor Setting the readonly flag prevents object from writing itself to the stream. More... | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| pseudo-copy constructor More... | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor More... | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator More... | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. More... | |
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| destructor More... | |
| 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. More... | |
| virtual void | postPutSelf () |
| Called after either version of put self (file or environment). Default is no-op. More... | |
| virtual void | prePutSelf () |
| Called before either version of put self (file or environment). Default is no-op. More... | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. More... | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. More... | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. More... | |
| 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. More... | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. More... | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. More... | |
| 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. More... | |
| 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. More... | |
| virtual int | alignment () const |
| For those items that are sent over the network via HLA, this will give the network alignment. More... | |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. More... | |
| virtual void | setName (const DtString &) |
| Set the name of the object. More... | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. More... | |
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. More... | |
| std::string | debugText () const |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| Runs a variable binding pass on this reader writer and any of its children. More... | |
| 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. More... | |
| virtual bool | hasVariableReference () const |
| Returns true if this item or any item in the registry (recursive) is a variable reference. More... | |
| 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. More... | |
| virtual void | recordUpdateTime () const |
| Can be implemented in subclasses to stamp the time when updated. More... | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Can be implemented in subclasses to return true if an update occurred after the specified time. More... | |
| virtual bool | changedSinceLastChecked () |
| Returns true if this objects value has changed since the last time this function was called. More... | |
| virtual bool | peekChangedSinceLastChecked () const |
| Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More... | |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. More... | |
| virtual bool | valueSpecified () const |
| virtual bool | isVariableReference () const |
| Specifies whether or not this reader writer is really a variable that is specified elsewhere. More... | |
| virtual void | setIsVariableReference (bool value) |
| virtual void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. More... | |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. More... | |
| 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. More... | |
| virtual DtReaderWriter * | defaultRWValue () |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More... | |
| 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. More... | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. More... | |
| DtReaderWriterRegistry & | registry () |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual DtRwVariableBindings * | generateVariableBindings () const |
| Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More... | |
| virtual bool | toXml (const DtFilename &) const |
| Writes contents of xml result to the given filename. More... | |
| virtual bool | fromXml (const DtString &) |
| Restores object from given xml string. Returns true if valid. More... | |
| virtual bool | fromXmlFile (const DtFilename &) |
| Restores object from given xml file. More... | |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| Override to add attributes of actual data. More... | |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| Called when the item is a variable reference. More... | |
| 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. More... | |
| 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. More... | |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| Called when the item is a variable reference. More... | |
Static Public Member Functions | |
| static void | detonationCallback (DtTimer *timer) |
| Casts the user data portion of the DtTimer passed to it to a DtDetonationTimerData object. More... | |
| static DtSimComponent * | creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| static void | objectAddedCb (const DtVrfObject *vrfObject, void *usr) |
| Calls processObjectAdded(). More... | |
| Static Public Member Functions inherited from DtSimComponent | |
| static DtSimComponent * | MarkThreadSafe (DtSimComponent *) |
| Marks an instance of a component as being thread safe. More... | |
| static DtSimComponentFactory * | factory () |
| A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More... | |
| static void | setFactory (DtSimComponentFactory *factory) |
| static DtSimComponent * | createComponent (const DtString &name, const DtString &type, DtVrfObject *owner, DtSimManager *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| Creates a DtSimComponent using the factory, then initializes it via the MTL stream. More... | |
| static void | addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn) |
| Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key. More... | |
| 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 () |
| The type that is used when archiving to an XML stream. More... | |
| static const DtFilename & | appPath () |
| Gets the current working directory. More... | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. More... | |
| 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) |
| Given a filename, returns a newly created reader/writer object from the object found within. More... | |
| static DtReaderWriter * | createFromXml (const DtString &, bool createAsProperty=false) |
| Given a xml string, returns a newly created reader/writer object from the object found within. More... | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false) |
| Given a xml environment, returns a newly created reader/writer object from the object found within. More... | |
| static DtString | getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root) |
| Gets the named attribute from a DtEnvValueSP. More... | |
Protected Member Functions | |
| virtual bool | createPortGroups () |
| Overridden to create local port groups. More... | |
| virtual bool | createPorts () |
| Overridden to create local ports. More... | |
| virtual bool | createPSR () |
| Creates myProcessState data member, and adds it to our process state repository manager. More... | |
| virtual void | processObjectAdded (const DtVrfObject *vrfObject) |
| Checks pending detonation list (in the process state repository) for target with same name as new object. More... | |
| virtual void | addRangeItems () |
| Adds all items that have a range to the object state repository. More... | |
| virtual bool | aimGun () |
| Aims the gun based on input ports. More... | |
| virtual DtEntityType | munitionType (DtSimMunition &munitionEntry) |
| Gets either the normal munition type or an alternate type to fill in the fire and detonation interactions. More... | |
| DtBallisticGun () | |
| default constructor; not implemented More... | |
| DtBallisticGun (const DtBallisticGun &orig) | |
| copy constructor; not implemented More... | |
| const DtBallisticGun & | operator= (const DtBallisticGun &orig) |
| assignment operator; not implemented More... | |
| Protected Member Functions inherited from DtActuatorComponent | |
| DtActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| virtual void | setRadio (DtSimRadio *radio) |
| DtActuatorComponent () | |
| Default constructor; should not be called. More... | |
| Protected Member Functions inherited from DtSimComponent | |
| virtual double | computeCurrentTime () |
| Compute current time and myDT. More... | |
| bool | testInvariant () const |
| DtVrfProcessStateRepository * | createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true) |
| Creates a PSR for this component and registers it with the PSR manager. More... | |
| virtual void | updateTaskVisualizations () |
| Called to update task visualizations after every tick. More... | |
| virtual void | destroyTaskVisualizations () |
| Destroys all task visualizations for this component. More... | |
| virtual void | destroyTaskVisualization (const DtString &name) |
| Destroys an existing task visualization. More... | |
| virtual DtPointTaskVisualizationPtr | pointTaskVisualization (const DtString &name) |
| Finds an existing or creates a new point task visualization with the given name. More... | |
| virtual DtLineTaskVisualizationPtr | lineTaskVisualization (const DtString &name) |
| Finds an existing or creates a new line task visualization with the given name. More... | |
| virtual DtAreaTaskVisualizationPtr | areaTaskVisualization (const DtString &name) |
| Finds an existing or creates a new area task visualization with the given name. More... | |
| virtual DtTextTaskVisualizationPtr | textTaskVisualization (const DtString &name) |
| Finds an existing or creates a new text task visualization with the given name. More... | |
| double | calculateNextTaskVisTickTime () const |
| Determines the next time the task visualizations should be ticked. More... | |
| Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. More... | |
Protected Attributes | |
| DtBallisticGunDescriptor * | myBalGunDescriptor |
| DtReal | myMaxGunRange |
| This max gun range is determined by the P(hit) tables. More... | |
| DtReal | myMuzzleSpeed |
| DtVector | myMuzzleOffset |
| const DtVrfObject * | myCurrentTarget |
| These are set by createFireInteraction and used by createDetonationInteraction. More... | |
| DtEventId | myCurrentEventId |
| DtReal | myCurrentRange |
| DtList | myTimerList |
| DtArtPartType | myGunArtPart |
| DtVrfBalGunPSR * | myProcessState |
| Container for state data associated with this component. More... | |
Ports and Port Groups | |
| DtInputPortGroup * | myBalGunControlPortGroup |
| Input Port Group Name: gun-control Input Port Group Description: More... | |
| DtBooleanInputPort * | myTriggerPort |
| Input Port Name: trigger Input Port Description: Edge-triggered input which fires a round whenever a new True arrives on the port. More... | |
| DtIntegerInputPort * | myQuantityInputPort |
| Input Port Name: quantity Input Port Description: Indicates the number of rounds to be fired with a single trigger pull. More... | |
| DtBooleanInputPort * | myLoadedPort |
| Input Port Name: loaded Input Port Description: Must be True for gun to fire. More... | |
| DtIntegerInputPort * | myLosPort |
| Input Port Name: line-of-sight Input Port Description: Indicates the result of a line of sight calculation to the current target. More... | |
| DtAnalogInputPort * | myAimElevationInputPort |
| Input Port Name: aim-elevation Input Port Description: Elevation at which to aim, in radians. More... | |
| Protected Attributes inherited from DtActuatorComponent | |
| DtSimRadio * | myRadio |
| Actuators can send messages. More... | |
| Protected Attributes inherited from DtSimComponent | |
| DtVrfObject * | myEntity |
| DtVrfObjectStateRepository * | myLocalStateRepository |
| DtSimManager * | mySimManager |
| DtComponentSystem * | mySystem |
| Pointer to the DtComponentSystem that this component belongs. More... | |
| 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. More... | |
| bool | myFirstTick |
| Initialized to true in the constructor, set to false by the first call to postTick. More... | |
| bool | myIsThreadSafe |
| Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false. More... | |
| const DtComponentDescriptor * | myComponentDescriptor |
| std::list < DtVrfProcessStateRepository * > | myComponentPsrs |
| List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed. More... | |
| bool | myTickEveryFrame |
| Flag indicating that tickPeriod is set to 0, and the component will tick every frame. More... | |
| DtTaskVisualizationMap | myTaskVisualizations |
| The visualization objects to be drawn for this component. More... | |
| double | myNextTaskVisTickTime |
| The next tick time for updating the task visualizations. More... | |
| DtSymbolString | myFullComponentName |
| 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. More... | |
| bool | myInvalid |
| Set to true if there is a problem reading this item. More... | |
| bool | myChangedFlag |
| Set to true when value changes Set to false when value checked with changedSinceLastChecked. More... | |
| virtual void | processSetTracerUse (DtSimMessage *msg) |
| static void | setTracerUseCallback (DtSimMessage *msg, void *component) |
| Callback function and processing function for handling setTracerUse commands. More... | |
DtBallisticGun provides a simple model of a ballistic gun.
End User Description: The ballistic gun actuator uses the ammunition data and trigger values it receives. When the trigger port has the value of true, it creates a fire interaction using the ammunition indicated and the current state of the entity at the entity’s current target. It also checks the hit probability table to decide if this should be a hit. It creates the proper detonation interaction for the determined result and schedules the interaction to be sent at the appropriate time.
Uses Descriptor Type: DtBallisticGunDescriptor
| DtBallisticGun::DtBallisticGun | ( | const DtString & | name, |
| DtVrfObject * | owner, | ||
| DtSimManager * | simManager, | ||
| DtComponentDescriptor * | desc = 0, |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
| 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 |
Overridden to cache a pointer to the entity's radio in this class.
Reimplemented from DtActuatorComponent.
|
virtual |
Called in the first tick.
Creates and schedules any pending detonations from detonation descriptor data in the process state repository. For those detonations whose target does not exist yet (e.g. target may be remote and not discovered yet), registers the objectAddedCb to provide an opportunity to create and schedule those pending detonations at a later time.
|
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. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.
Implements DtSimComponent.
Reimplemented in DtBallisticGunJoy, and DtHumanGunActuator.
|
virtual |
Calls initPendingDetonations.
Reimplemented from DtSimComponent.
|
virtual |
Update the gun elevation.
If elevation is correct and the trigger port says fire, then fire. Also, if there are remaining fire interactions to generate in a burst, generate the next one.
Reimplemented from DtSimComponent.
Reimplemented in DtHumanGunActuator, and DtBallisticGunJoy.
Create the fire interaction for the fire event and schedule a detonation.
roundsToFire is the number of rounds in this fire interaction– long bursts may use multiple interactions. If computePHit is false, then the normal P(Hit) computation will be skipped; this is appropriate for fire/detonate events after the first one in a burst, which are all assumed to miss.
|
virtual |
Returns true if we hit the target, false otherwise.
Looks up a DtPrbValueList based on entity type and range passed as arguments in the Hit Probability Table specified by the component descriptor describing this component. It uses the probability in the DtPrbValueList indexed by the string returned by the probabilityString() function. This probability is then multiplied by the value from hitProbabilityModifier(). It then generates a random number between 0.0 and 1.0 using DtFRand(). If the value generated is less than or equal to the hit probability, true is returned. If the value generated is greater than the hit probability, false is returned.
|
virtual |
Computes and returns a hit probability modifier based on motion and other effects.
|
virtual |
Computes and returns a modifier (0-1) to account for target motion.
Target motion perpendicular to the line of fire is computed and compared to 1.5mps; the modifier is 0.5 at 1.5mps.
|
virtual |
Computes and returns a modifier (0-1) to account for self motion.
Self speed is compared to 1.0 mps; the modifier is 0.5 at 1.0 mps.
Calculates a modifier on the probability of hit based on range and the training level of the entity.
|
virtual |
Calculates a modifier to hit probability based on entity (lifeform) posture.
Prone = 0.25, kneeling = 0.6, crouched = 0.9. Note – uses myCurrentTarget to get target state.
Calculates a modifier to hit probability based on burst size.
Currently, modifier = log10(burstSize) + 1. This value > 1 for burstSize > 1, but see comment in hitProbabilityModifier above.
|
virtual |
Allocates a DtFireInteraction and then uses the munition information specified on the munition and fuze ports, as well as the current target reported by the entity, to fill in the necessary fields.
It also calculates a muzzle velocity vector to store in the interaction, using myMuzzleSpeed and a unit vector pointing from the firing entity to the target. The range to the target is stored in the member variable myCurrentRange for use by createDetonationInteraction().
|
virtual |
Allocates a DtDetonationInteraction.
It calls checkHitProbability() to determine if the detonation will be a hit or a miss. If it is a hit, the interaction’s result field is set to DtDetResEntityImpact. An (approximate) impact point on the target entity is determined by shooting a ray from the center of the shooting entity to the center of the target entity. The point of intersection between this ray and the target entity's bounding volume is then determined, and this is used as the detonation location. A round velocity vector is also calculated by using myMuzzleSpeed and a normalized version of the shooting vector. If the detonation is determined to be a miss, DtDetResGroundImpact is used for the detonation result, and a ground location is randomly selected from within a 2 ½ meter ring outside the radius of the target’s bounding volume as the detonation point. The round velocity vector is calculated by finding the unit vector from the center of the shooting entity to the impact point and scaling by myMuzzleSpeed. An approximate time to detonation is determined using the approximate distance to the target, stored by createFireInteraction() in myCurrentRange, divided by myMuzzleSpeed. This speed and the DtDetonationInteraction created are returned. If assureMiss is True, the hitProbability is skipped, and a miss is guaranteed.
|
virtual |
Computes the location of a miss.
The input position is in local coordinates, and the output vectors are also in local coordinates. The intended target is the entity the gun was aiming at, while the target is the entity that was hit instead, if any. If the miss hits an entity, the detonation result will be an entity impact, and the target will indicate what was hit. Otherwise, the target is null.
|
virtual |
Schedules the sending of the DtDetonationInteraction passed as the first argument at a point in the future specified by the second argument, using the DtScheduler facility (which is accessed through the DtSimManager).
A DtDetonationTimerData object is allocated, which holds a pointer to the DtDetonationInteraction and a pointer to the DtSimManager. A DtTimer is then created that is set for the desired time and that is given the DtBallisticGun::detonationCallback() as the callback function for when the timer fires, and DtDetonationTimerData object as the user data that will be accessible to the callback. The timer is placed on the scheduler with a call to DtScheduler::addTimer(), which will assume responsibility for firing the DtTimer at the specified time. The DtTimer is also placed on a local timer list myTimerList, so that it can be deleted at a later time.
|
virtual |
|
virtual |
Finds the correct muzzle placement for the gun.
|
virtual |
Creates a new DtDetonationInteraction, given a DtDetonationDescriptor.
Fills out new new interaction with data from the descriptor and returns the detonation time (time in seconds relative to current sim time). The resulting DtDetonationInteraction and DtTime can be directly passed into scheduleDetonation.
|
virtual |
Creates and fills out a new DtDetonationDescriptor, given a DtDetonationInteraction and a time (simulation time to fire, in seconds).
|
virtual |
Look up the maximum range of the gun from the P(Hit) table given in the descriptor.
|
static |
Casts the user data portion of the DtTimer passed to it to a DtDetonationTimerData object.
It then uses the pointer to the Simulation Manager provided in the DtDetonationTimerData to get a pointer to the DtExerciseConn, and sends the DtDetonationInteraction which is also in the DtDetonationTimerData object via the exercise connection. The timer is removed from the scheduler, and the DtDetonationTimerData and DtDetonationInteraction objects are deleted.
|
static |
Callback function and processing function for handling setTracerUse commands.
These set a flag in the gun PSR to indicate that tracers are/are not currently being used.
|
virtual |
|
static |
| 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). |
|
static |
Calls processObjectAdded().
|
protectedvirtual |
Overridden to create local port groups.
Reimplemented from DtSimComponent.
|
protectedvirtual |
Overridden to create local ports.
Reimplemented from DtSimComponent.
Reimplemented in DtHumanGunActuator, and DtBallisticGunJoy.
|
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.
|
protectedvirtual |
Checks pending detonation list (in the process state repository) for target with same name as new object.
If one exists, sets the target global id in the pending object item (a DtDetonationDescriptor), and then schedules the detonation, given the data in the descriptor.
|
protectedvirtual |
Adds all items that have a range to the object state repository.
|
protectedvirtual |
Aims the gun based on input ports.
Uses the myAimElevationInputPort to determine the correct elevation. Returns true if aiming is complete.
Reimplemented in DtHumanGunActuator.
|
protectedvirtual |
Gets either the normal munition type or an alternate type to fill in the fire and detonation interactions.
Checks the PSR to see if tracers are being fired, and if so, returns the tracer-type from simMunition. If that type isn't specified, the normal munition type is returned.
|
protected |
assignment operator; not implemented
|
protected |
|
protected |
This max gun range is determined by the P(hit) tables.
It is computed once at init time and saved for later use in range ring registration and detonation creation.
|
protected |
|
protected |
|
protected |
These are set by createFireInteraction and used by createDetonationInteraction.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Container for state data associated with this component.
This state is saved and restored as part of a scenario (or checkpoint).
|
protected |
Input Port Group Name: gun-control
Input Port Group Description:
|
protected |
Input Port Name: trigger
Input Port Description: Edge-triggered input which fires a round whenever a new True arrives on the port.
Input Port Range:
Input Port Default Value:
Input Group Parent: gun-control
|
protected |
Input Port Name: quantity
Input Port Description: Indicates the number of rounds to be fired with a single trigger pull.
Changes the quantity field in the fire/detonate interactions/PDUs generated by this gun. If not connected, a value of 1 is used.
Input Port Range: 1+
Input Port Default Value: 1
Input Group Parent: gun-control
|
protected |
Input Port Name: loaded
Input Port Description: Must be True for gun to fire.
Input Port Range:
Input Port Default Value:
Input Group Parent: gun-control
|
protected |
Input Port Name: line-of-sight
Input Port Description: Indicates the result of a line of sight calculation to the current target.
This gun is only capable of hitting things with a Clear line of sight. If Unknown, the gun will calculate the los. Input Port Range: 0 = Unkown, 1 = Blocked, 2 = Clear
Input Port Default Value:
Input Group Parent: gun-control
|
protected |
Input Port Name: aim-elevation
Input Port Description: Elevation at which to aim, in radians.
Input Port Range: -pi to pi
Input Port Default Value: 0