 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
DtFireForEffectTask is an abstract base class which used to create fire for effect tasks that differ only by target type: entity, location, or target control point. More...
Public Member Functions | |
| virtual | ~DtFireForEffectTask () |
| virtual void | setAmmoTypeName (const DtString &type) |
| Set ammo type. | |
| virtual const DtString & | ammoTypeName () const |
| Get ammo type. | |
| virtual bool | ammoTypeSpecified () const |
| See if ammo type was specified for this task (if not, use default). | |
| virtual void | setNumberOfRounds (int rounds) |
| virtual int | numberOfRounds () const |
| virtual bool | numberOfRoundsSpecified () const |
| virtual void | setDispersionRadius (DtReal radius) |
| virtual DtReal | dispersionRadius () const |
| virtual bool | dispersionRadiusSpecified () const |
| virtual void | setHeightAboveTerrain (DtReal height) |
| virtual DtReal | heightAboveTerrain () const |
| virtual bool | heightAboveTerrainSpecified () const |
| virtual int | netRepSize () const |
| Returns the size of the full network representation padded to an 8-byte boundary. | |
| virtual bool | setFromNet (const char *contentBuffer, unsigned contentSize) |
| Fills in the task from the network buffer. | |
| virtual bool | setToNet () |
| Fills in the network buffer (created by base class simTask) with the task contents. | |
Protected Member Functions | |
| DtFireForEffectTask () | |
| default constructor | |
| DtFireForEffectTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a task 'put' itself, the writeName will preface the task. | |
| DtFireForEffectTask (const DtString &writeName, const DtFireForEffectTask &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtFireForEffectTask & | operator= (const DtFireForEffectTask &orig) |
| assignment operator | |
| virtual DtString | parameterStringRep () const |
| Get a readable string representation of the parameters. | |
Protected Attributes | |
| DtRwString | myAmmoTypeName |
| DtRwInt | myNumberOfRounds |
| DtRwReal | myDispersionRadius |
| DtRwReal | myHeightAboveTerrain |
DtFireForEffectTask is an abstract base class which used to create fire for effect tasks that differ only by target type: entity, location, or target control point.
| DtFireForEffectTask::DtFireForEffectTask | ( | ) | [protected] |
default constructor
| DtFireForEffectTask::DtFireForEffectTask | ( | const DtString & | writeName, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) | [protected] |
constructor If you have a task 'put' itself, the writeName will preface the task.
| DtFireForEffectTask::DtFireForEffectTask | ( | const DtString & | writeName, |
| const DtFireForEffectTask & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) | [protected] |
copy constructor
| virtual DtFireForEffectTask::~DtFireForEffectTask | ( | ) | [virtual] |
| const DtFireForEffectTask& DtFireForEffectTask::operator= | ( | const DtFireForEffectTask & | orig | ) | [protected] |
assignment operator
| virtual void DtFireForEffectTask::setAmmoTypeName | ( | const DtString & | type | ) | [virtual] |
Set ammo type.
| virtual const DtString& DtFireForEffectTask::ammoTypeName | ( | ) | const [virtual] |
Get ammo type.
| virtual bool DtFireForEffectTask::ammoTypeSpecified | ( | ) | const [virtual] |
See if ammo type was specified for this task (if not, use default).
| virtual void DtFireForEffectTask::setNumberOfRounds | ( | int | rounds | ) | [virtual] |
| virtual int DtFireForEffectTask::numberOfRounds | ( | ) | const [virtual] |
| virtual bool DtFireForEffectTask::numberOfRoundsSpecified | ( | ) | const [virtual] |
| virtual void DtFireForEffectTask::setDispersionRadius | ( | DtReal | radius | ) | [virtual] |
| virtual DtReal DtFireForEffectTask::dispersionRadius | ( | ) | const [virtual] |
| virtual bool DtFireForEffectTask::dispersionRadiusSpecified | ( | ) | const [virtual] |
| virtual void DtFireForEffectTask::setHeightAboveTerrain | ( | DtReal | height | ) | [virtual] |
| virtual DtReal DtFireForEffectTask::heightAboveTerrain | ( | ) | const [virtual] |
| virtual bool DtFireForEffectTask::heightAboveTerrainSpecified | ( | ) | const [virtual] |
| virtual int DtFireForEffectTask::netRepSize | ( | ) | const [virtual] |
Returns the size of the full network representation padded to an 8-byte boundary.
Reimplemented from DtSimTask.
Reimplemented in DtFireForEffectOnEntityTask, DtFireForEffectOnTargetTask, and DtFireForEffectOnLocationTask.
| virtual bool DtFireForEffectTask::setFromNet | ( | const char * | contentBuffer, |
| unsigned | contentSize | ||
| ) | [virtual] |
Fills in the task from the network buffer.
Reimplemented from DtSimTask.
Reimplemented in DtFireForEffectOnEntityTask, DtFireForEffectOnTargetTask, and DtFireForEffectOnLocationTask.
| virtual bool DtFireForEffectTask::setToNet | ( | ) | [virtual] |
Fills in the network buffer (created by base class simTask) with the task contents.
Reimplemented from DtSimTask.
Reimplemented in DtFireForEffectOnEntityTask, DtFireForEffectOnTargetTask, and DtFireForEffectOnLocationTask.
| virtual DtString DtFireForEffectTask::parameterStringRep | ( | ) | const [protected, virtual] |
Get a readable string representation of the parameters.
DtRwString DtFireForEffectTask::myAmmoTypeName [protected] |
DtRwInt DtFireForEffectTask::myNumberOfRounds [protected] |
DtRwReal DtFireForEffectTask::myDispersionRadius [protected] |
DtRwReal DtFireForEffectTask::myHeightAboveTerrain [protected] |