VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions
DtBallisticGunJoy Class Reference

DtBallisticGunJoy extends the DtBallisticGun actuator class with the ability to be controlled from a joystick. More...

Inheritance diagram for DtBallisticGunJoy:
Inheritance graph
[legend]

Public Member Functions

 DtBallisticGunJoy (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc, DtReaderWriterRegistry *const parentRegistry=0)
 
virtual ~DtBallisticGunJoy ()
 destructor More...
 
virtual const chartype () const
 Returns a string identifies the class type of component. More...
 
virtual bool createPorts ()
 Creates myElevationPort. More...
 
virtual void setComponentDescriptor (DtComponentDescriptor *descriptor)
 Override so we can extract the values we want and set our pointer. More...
 
virtual void tick ()
 Fire and detonate. More...
 
virtual DtReal setTarget (DtArticulatedPartStateRepository *rotBody)
 Uses targetSelection() to try to find an entity in the gun's line of fire; if it finds one, it sets the PSR->currentTarget. More...
 
virtual DtFireInteraction * manualFireInteraction (DtArticulatedPartStateRepository *rotBody)
 Creates a fire interaction. More...
 
virtual DtDetonationInteractionmanualDetonationInteraction (DtArticulatedPartStateRepository *rotBody, DtReal &detTime, DtReal dist)
 
virtual const DtVrfObjecttargetSelection (DtArticulatedPartStateRepository *rotBody, DtReal &dist)
 Casts a ray out from the gun to a point MAX_RANGE away, where MAX_RANGE is 4000m currently. More...
 
virtual DtReal distanceToTarget ()
 
- Public Member Functions inherited from DtBallisticGun
 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 void preFirstTickInit ()
 Calls initPendingDetonations. 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 DtDetonationInteractioncreateDetonationInteraction (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 DtDetonationInteractioncreateDetonationInteraction (const DtDetonationDescriptor &desc, DtTime &detTime)
 Creates a new DtDetonationInteraction, given a DtDetonationDescriptor. More...
 
virtual DtDetonationDescriptorcreateDetonationDescriptor (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...
 
virtual void processSetTracerUse (DtSimMessage *msg)
 
- Public Member Functions inherited from DtActuatorComponent
virtual ~DtActuatorComponent ()
 destructor More...
 
virtual DtSimRadioradio ()
 
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...
 
DtComponentSystemparentSystem () 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 DtSimComponentnextComponent ()
 List management functions. More...
 
virtual DtSimComponentprevComponent ()
 
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 DtInputPortlookupInputPort (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 DtOutputPortlookupOutputPort (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 DtInputPortGrouplookupInputPortGroup (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 DtOutputPortGrouplookupOutputPortGroup (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 const
DtComponentDescriptor
componentDescriptor () const
 
DtVrfProcessStateRepositoryManagerpsrManager ()
 
virtual const DtSymbolStringcomponentFullName () const
 
DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in. More...
 
const DtPhysicalWorldphysicalWorld () const
 
DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any. More...
 
const DtAttachedTerrainterrainAttachedTo () const
 
DtVrfObjectentity ()
 Gets the entity. More...
 
const DtVrfObjectentity () const
 
const DtVrfObjectconst_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...
 
DtSimManagersimManager ()
 Gets the sim manager. More...
 
const DtSimManagersimManager () const
 
const Coordinate_SystemcoordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state! More...
 
DtVrfObjectStateRepositorylocalStateRepository ()
 Gets the local state repository. More...
 
const DtVrfObjectStateRepositorylocalStateRepository () const
 
const DtVrfObjectStateRepositoryconst_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 DtTaskVisualizationMaptaskVisualizations ()
 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 DtSimResourceManagerresourceManager ()
 
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 DtReaderWriteroperator= (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 aliasContaineraliases () 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 charreaderWriterType () const
 Used to supply a string type that this reader writer type is. More...
 
virtual const charxmlType () 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 DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified. More...
 
virtual DtReaderWriterdefaultRWValue ()
 
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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object. More...
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () 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 DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
- Static Public Member Functions inherited from DtBallisticGun
static void detonationCallback (DtTimer *timer)
 Casts the user data portion of the DtTimer passed to it to a DtDetonationTimerData object. More...
 
static DtSimComponentcreator (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 void setTracerUseCallback (DtSimMessage *msg, void *component)
 Callback function and processing function for handling setTracerUse commands. More...
 
- Static Public Member Functions inherited from DtSimComponent
static DtSimComponentMarkThreadSafe (DtSimComponent *)
 Marks an instance of a component as being thread safe. More...
 
static DtSimComponentFactoryfactory ()
 A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More...
 
static void setFactory (DtSimComponentFactory *factory)
 
static DtSimComponentcreateComponent (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 chartheXmlType ()
 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 DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromEnvironment (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 Attributes

bool myReportedNoArticulation
 A flag to remember whether a warning message was printed about not finding an articulated part. More...
 
Ports and Port Groups
DtConstrainedAnalogInputPortmyElevationPort
 Input Port Name: elevation
Input Port Description:
Input Port Range: -1. More...
 
DtBooleanInputPortmyActiveJoystickPort
 Input Port Name: joystick-active
Input Port Description:
Input Port Range:
Input Port Default Value:
Input Group Parent: gun-control. More...
 
- Protected Attributes inherited from DtBallisticGun
DtBallisticGunDescriptormyBalGunDescriptor
 
DtReal myMaxGunRange
 This max gun range is determined by the P(hit) tables. More...
 
DtReal myMuzzleSpeed
 
DtVector myMuzzleOffset
 
const DtVrfObjectmyCurrentTarget
 These are set by createFireInteraction and used by createDetonationInteraction. More...
 
DtEventId myCurrentEventId
 
DtReal myCurrentRange
 
DtList myTimerList
 
DtArtPartType myGunArtPart
 
DtVrfBalGunPSRmyProcessState
 Container for state data associated with this component. More...
 
DtInputPortGroupmyBalGunControlPortGroup
 Input Port Group Name: gun-control
Input Port Group Description: More...
 
DtBooleanInputPortmyTriggerPort
 Input Port Name: trigger
Input Port Description: Edge-triggered input which fires a round whenever a new True arrives on the port. More...
 
DtIntegerInputPortmyQuantityInputPort
 Input Port Name: quantity
Input Port Description: Indicates the number of rounds to be fired with a single trigger pull. More...
 
DtBooleanInputPortmyLoadedPort
 Input Port Name: loaded
Input Port Description: Must be True for gun to fire. More...
 
DtIntegerInputPortmyLosPort
 Input Port Name: line-of-sight
Input Port Description: Indicates the result of a line of sight calculation to the current target. More...
 
DtAnalogInputPortmyAimElevationInputPort
 Input Port Name: aim-elevation
Input Port Description: Elevation at which to aim, in radians. More...
 
- Protected Attributes inherited from DtActuatorComponent
DtSimRadiomyRadio
 Actuators can send messages. More...
 
- Protected Attributes inherited from DtSimComponent
DtVrfObjectmyEntity
 
DtVrfObjectStateRepositorymyLocalStateRepository
 
DtSimManagermySimManager
 
DtComponentSystemmySystem
 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 DtComponentDescriptormyComponentDescriptor
 
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
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
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...
 

Private Member Functions

 DtBallisticGunJoy ()
 Default constructor; should not be called. More...
 
 DtBallisticGunJoy (const DtBallisticGunJoy &orig)
 copy constructor; shallow copy - timers not copied More...
 
const DtBallisticGunJoyoperator= (const DtBallisticGunJoy &orig)
 assignment operator; see comments on copy constructor! More...
 

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 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
 
- Protected Member Functions inherited from DtBallisticGun
virtual bool createPortGroups ()
 Overridden to create local port groups. 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 DtBallisticGunoperator= (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
 
DtVrfProcessStateRepositorycreateComponentPsr (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...
 
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Detailed Description

DtBallisticGunJoy extends the DtBallisticGun actuator class with the ability to be controlled from a joystick.

Uses Descriptor Type: DtBallisticGunDescriptor

Constructor & Destructor Documentation

DtBallisticGunJoy::DtBallisticGunJoy ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc,
DtReaderWriterRegistry *const  parentRegistry = 0 
)

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
virtual DtBallisticGunJoy::~DtBallisticGunJoy ( )
virtual

destructor

DtBallisticGunJoy::DtBallisticGunJoy ( )
private

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtBallisticGunJoy::DtBallisticGunJoy ( const DtBallisticGunJoy orig)
private

copy constructor; shallow copy - timers not copied

Member Function Documentation

virtual const char* DtBallisticGunJoy::type ( ) const
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.

Returns
DtBallisticGunJoyActuatorType

Reimplemented from DtBallisticGun.

virtual bool DtBallisticGunJoy::createPorts ( )
virtual

Creates myElevationPort.

Reimplemented from DtBallisticGun.

virtual void DtBallisticGunJoy::setComponentDescriptor ( DtComponentDescriptor descriptor)
virtual

Override so we can extract the values we want and set our pointer.

Calls down to the base class's set.

Reimplemented from DtSimComponent.

virtual void DtBallisticGunJoy::tick ( )
virtual

Fire and detonate.

It detects if we need to use local or parent function depending on joystick enable/disable state

Reimplemented from DtBallisticGun.

virtual DtReal DtBallisticGunJoy::setTarget ( DtArticulatedPartStateRepository rotBody)
virtual

Uses targetSelection() to try to find an entity in the gun's line of fire; if it finds one, it sets the PSR->currentTarget.

Parameter rotBody should be the SR of the gun articulated part, if there is one; otherwise, the entity SR.

virtual DtFireInteraction* DtBallisticGunJoy::manualFireInteraction ( DtArticulatedPartStateRepository rotBody)
virtual

Creates a fire interaction.

Uses the currentTarget in the PSR as the fire target, if present. Parameter rotBody should be the SR of the gun articulated part, if there is one; otherwise, the entity SR.

virtual DtDetonationInteraction* DtBallisticGunJoy::manualDetonationInteraction ( DtArticulatedPartStateRepository rotBody,
DtReal &  detTime,
DtReal  dist 
)
virtual
virtual const DtVrfObject* DtBallisticGunJoy::targetSelection ( DtArticulatedPartStateRepository rotBody,
DtReal &  dist 
)
virtual

Casts a ray out from the gun to a point MAX_RANGE away, where MAX_RANGE is 4000m currently.

Determines, using physicalWorld->getVrfObjectsAlongChord(), if there are any platforms, lifeforms, or cultural features on the ray. Returns the first one found, and the range. Parameter rotBody should be the SR of the gun articulated part, if there is one; otherwise, the entity SR.

virtual DtReal DtBallisticGunJoy::distanceToTarget ( )
virtual
static void DtBallisticGunJoy::detonationCallback ( DtTimer timer)
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 DtSimComponent* DtBallisticGunJoy::creator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)
static

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
Returns
New instance of this class.
const DtBallisticGunJoy& DtBallisticGunJoy::operator= ( const DtBallisticGunJoy orig)
private

assignment operator; see comments on copy constructor!

Member Data Documentation

DtConstrainedAnalogInputPort* DtBallisticGunJoy::myElevationPort
protected

Input Port Name: elevation
Input Port Description:
Input Port Range: -1.

to 1.
Input Port Default Value:
Input Group Parent: gun-control

DtBooleanInputPort* DtBallisticGunJoy::myActiveJoystickPort
protected

Input Port Name: joystick-active
Input Port Description:
Input Port Range:
Input Port Default Value:
Input Group Parent: gun-control.

bool DtBallisticGunJoy::myReportedNoArticulation
protected

A flag to remember whether a warning message was printed about not finding an articulated part.


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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)