 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
End User Description: DtControllerComponent is the base class for all controllers components. More...
Public Member Functions | |
| DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| (const DtString& name, | |
| virtual | ~DtControllerComponent () |
| destructor | |
| virtual DtString | type () const |
| This returns a string from compTypes.h, and identifies the type of component. | |
| virtual bool | init () |
| Calls setRadio() | |
| virtual DtSimBaseRadio * | radio () |
| The radio this component is listening to. | |
| virtual void | taskNotify (const DtSimTask &task) |
| This is used by the entity to notify all controllers that a new task has been received. | |
| virtual void | clearTask () |
| Called when you want to clear out this component's task state. | |
Protected Member Functions | |
| DtControllerComponent () | |
| default constructor | |
| DtControllerComponent (const DtControllerComponent &orig) | |
| copy constructor | |
| const DtControllerComponent & | operator= (const DtControllerComponent &orig) |
| assignment operator | |
| virtual void | setRadio (DtSimBaseRadio *radio) |
Protected Attributes | |
| DtSimBaseRadio * | myRadio |
| Controller components can send messages. | |
End User Description: DtControllerComponent is the base class for all controllers components.
Developer Description: The DtControllerComponent class extends the base DtSimComponent to perform some task management upon the start of a task, and in the event that a task is being cleared. It caches a pointer to the entity's radio for convenience.
| DtControllerComponent::DtControllerComponent | ( | const DtString & | name, |
| DtVrfObject * | owner, | ||
| DtSimManager * | simManager, | ||
| DtComponentDescriptor * | desc = 0, |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
(const DtString& name,
| 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 DtControllerComponent::~DtControllerComponent | ( | ) | [virtual] |
destructor
| DtControllerComponent::DtControllerComponent | ( | ) | [protected] |
default constructor
| DtControllerComponent::DtControllerComponent | ( | const DtControllerComponent & | orig | ) | [protected] |
copy constructor
| virtual DtString DtControllerComponent::type | ( | ) | const [virtual] |
This returns a string from compTypes.h, and identifies the type of component.
Reimplemented from DtSimComponent.
Reimplemented in DtHumanCollisionAvoidanceController, DtTargetSelectionController, DtDisaggregatedFormationController, DtRailPathController, DtGroundCollisionAvoidanceController, DtPathMovementController, DtSurfaceEntityPilotController, DtDisaggregatedMoveAlongController, DtGroundMovementChooserController, DtLauncherController, DtDIGuyController, DtMissileDistractionController, vrfLua::DtLuaScriptController, DtSpotReportGeneratorController, DtVrfObjectDataMessenger, BHAVE::DtKynapseGroundPlatformController, DtSimpleRotaryWingPilot, DtTurretAcquireController, DtSurfaceEntityMoveAlongController, DtGroundMoveToDestinationControllerComponent, DtSurfaceEntityPatrolRouteController, DtWeaponController, DtFixedWingTakeoffController, BHAVE::DtKynapseController, DtBallisticGunController, DtFixedWingPilotController, BHAVE::DtKynapseLifeformController, DtDisaggregatedMoveIntoFormationController, DtFixedWingMoveAlongController, DtTaskControllerComponent, DtRetreatController, DtOccupancyDirectorController, BHAVE::DtBhaveMoveDirectionController, DtOrganizationController, DtSurfaceEntityPatrolBetweenController, DtTurretSlewController, DtAggregatedMoveToController, DtConvoyTaskController, DtDetonationController, DtHumanMoveAlongController, DtContactFusionController, DtCruiseMissileLaunchController, DtIndirectFireController, DtAirVehicleWeaponHoldController, DtDisaggregatedMoveToLocationController, DtDisaggregatedPatrolAlongController, DtFixedWingLandingController, DtRotaryWingCollisionAvoidanceController, DtEmbarkationController, DtAggregateModelResolutionController, DtAggregateOrganizationController, DtBaseWeaponController, DtCulturalFeatureSetController, DtDisaggregatedEmbarkationController, DtHumanMoveToController, DtFixedWingFlyIntoController, DtFixedWingDefaultController, DtGroundMoveToControllerComponent, DtGroundMoveDirectionController, DtRailMovementController, DtRotaryWingPilotController, DtSurfaceEntityMoveToLocationController, DtTopLevelOrganizationController, DtDisaggregatedPatrolBetweenController, DtFixedWingFlightCommandController, DtHumanAcquireController, DtLasingController, DtRotaryWingLandingController, DtRotaryWingTurnToHeadingController, DtAggregatedPatrolController, DtAirVehicleSetController, DtHumanPatrolController, DtLimitExistenceController, DtMissileMoveToControllerComponent, DtRotaryWingPatrolBetweenController, DtSurfaceEntityFollowEntityController, DtDefaultLandingGearController, DtGroundAutoControllerComponent, DtGroundPatrolRouteController, DtGroundStopMovingControllerComponent, DtHumanLauncherAcquireController, DtHumanPostureController, DtMissileTrackEntityController, DtDisaggregatedWaitController, DtFixedWingPatrolRouteController, DtGroundFollowEntityController, DtGroundInterceptAndDestroyController, DtMissileControllerComponent, DtRotaryWingPatrolRouteController, DtBaseMountingController, DtCruiseMissileDefaultController, DtDisaggregatedMoveToController, DtFixedWingJoyFlightController, DtLaserGuidedLauncherController, DtLasingMissileTrackController, DtRotaryWingJoyFlightController, DtRotaryWingMoveAlongControllerComponent, DtSurfaceEntityMoveToController, DtTurretScanController, DtAutoAggregateDisaggregateController, DtFixedWingFollowEntityController, DtGroundPatrolBetweenController, DtHumanFollowController, DtIffControllerComponent, DtMovementBasedTerrainPreloadController, DtRotaryWingFlightCommandController, DtRotaryWingFollowEntityController, DtRotaryWingLoiterControllerComponent, BHAVE::DtSpawnController, DtDisaggregatedOccupancyDirectorController, DtDisaggregatedTurnToHeadingController, DtFixedWingMoveToController, DtFixedWingPatrolBetweenController, DtGroundTurnToControllerComponent, DtShapeBasedTerrainPreloadController, DtWaitController, DtTurnAndMoveController, DtHumanEyepointController, DtHumanSetController, DtLocalEntitySetController, DtRotaryWingMoveToControllerComponent, DtRotaryWingWaitController, DtFixedWingEntitySetController, DtHumanJoystickMovementController, DtRotaryWingTaskController, DtIndirectFireWeaponController, DtAggregatedMoveAlongController, DtDisaggregatedSetController, DtFixedWingEmbarkationController, DtGroundJoyMoveController, DtGroundMoveToLocationControllerComponent, DtHumanTurnToController, DtBallisticGunJoyController, DtGroundOrbitController, DtHumanAimWeaponController, DtIntegratedLaserGuidedLauncherController, DtGroundJoyTurretController, DtHumanStopMovingController, DtLaunchExpendableResourceController, DtMountingController, DtCruiseMissileMoveAlongController, DtGroundMoveAlongControllerComponent, DtFixedWingMoveToLocationController, DtLaunchSmokeController, DtRotaryWingEmbarkationController, DtRotaryWingMoveToLocationControllerComponent, DtSendRadioMessageController, DtSystemSwitcherComponent, DtVerticalLauncherController, DtCombatRangeController, and DtSimpleRadarWarningResponse.
| virtual bool DtControllerComponent::init | ( | ) | [virtual] |
Calls setRadio()
Reimplemented from DtSimComponent.
Reimplemented in DtTargetSelectionController, DtDisaggregatedFormationController, DtDisaggregatedMoveAlongController, DtSurfaceEntityPilotController, DtRailPathController, DtPathMovementController, BHAVE::DtBhaveMovementChooserController, DtFixedWingEmbarkationController, DtDIGuyController, BHAVE::DtSpawnController, DtTurretAcquireController, DtWeaponController, DtLauncherController, DtGroundMovementChooserController, DtMissileDistractionController, DtBallisticGunController, DtSpotReportGeneratorController, BHAVE::DtKynapseGroundPlatformController, DtDisaggregatedEmbarkationController, DtDisaggregatedMoveIntoFormationController, DtSimpleRotaryWingPilot, DtSurfaceEntityMoveAlongController, DtDetonationController, DtLaunchExpendableResourceController, BHAVE::DtKynapseController, DtCruiseMissileLaunchController, DtDisaggregatedOccupancyDirectorController, BHAVE::DtKynapseLifeformController, DtDisaggregatedPatrolAlongController, DtDisaggregatedMoveToLocationController, DtFixedWingTakeoffController, DtOccupancyDirectorController, DtRailMovementController, BHAVE::DtBhaveMoveDirectionController, DtAggregatedMoveToController, DtAggregatedPatrolController, DtFixedWingPilotController, DtHumanPatrolController, DtLimitExistenceController, DtOrganizationController, DtTurretSlewController, DtConvoyTaskController, DtHumanCollisionAvoidanceController, DtHumanMoveAlongController, DtLaunchSmokeController, DtContactFusionController, DtAirVehicleWeaponHoldController, DtGroundCollisionAvoidanceController, DtLaserGuidedLauncherController, DtDisaggregatedWaitController, DtEmbarkationController, DtGroundMoveToDestinationControllerComponent, DtHumanMoveToController, DtLasingMissileTrackController, DtFixedWingLandingController, DtHumanFollowController, DtTurretScanController, DtGroundMoveDirectionController, DtTopLevelOrganizationController, DtWaitController, DtDisaggregatedPatrolBetweenController, DtLasingController, DtRotaryWingWaitController, DtHumanPostureController, DtAggregatedSetController, DtDefaultLandingGearController, DtFixedWingDefaultController, DtGroundAutoControllerComponent, DtHumanLauncherAcquireController, DtIndirectFireController, DtRotaryWingPilotController, DtCombatRangeController, DtIntegratedLaserGuidedLauncherController, DtMissileControllerComponent, DtDisaggregatedSetController, DtAggregateModelResolutionController, DtAutoAggregateDisaggregateController, DtFixedWingFlightCommandController, DtMovementBasedTerrainPreloadController, DtBaseWeaponController, DtShapeBasedTerrainPreloadController, DtVrfObjectDataMessenger, DtHumanEyepointController, DtLocalEntitySetController, DtRotaryWingFlightCommandController, DtRotaryWingJoyFlightController, DtRotaryWingTaskController, DtRotaryWingMoveAlongControllerComponent, DtCruiseMissileDefaultController, DtHumanAcquireController, DtIffControllerComponent, DtAggregatedMoveAlongController, DtHumanTurnToController, DtSendRadioMessageController, DtTurnAndMoveController, DtRotaryWingCollisionAvoidanceController, DtHumanAimWeaponController, DtHumanStopMovingController, and DtSystemSwitcherComponent.
| virtual DtSimBaseRadio* DtControllerComponent::radio | ( | ) | [virtual] |
The radio this component is listening to.
| virtual void DtControllerComponent::taskNotify | ( | const DtSimTask & | task | ) | [virtual] |
This is used by the entity to notify all controllers that a new task has been received.
It will NOT be called for the controller that received the task; it is used to inform the others...
Reimplemented in DtTaskControllerComponent, and DtSingleTaskControllerComponent.
| virtual void DtControllerComponent::clearTask | ( | ) | [virtual] |
Called when you want to clear out this component's task state.
Base class implementation does nothing.
Reimplemented in DtFixedWingMoveAlongController, DtFixedWingMoveToController, DtRailMovementController, DtRailPathController, DtAggregatedMoveToController, DtPathMovementController, DtHumanMoveToController, DtHumanMoveAlongController, DtGroundMoveAlongControllerComponent, DtAggregatedMoveAlongController, vrfLua::DtLuaScriptController, DtDisaggregatedEmbarkationController, DtHumanFollowController, DtDIGuyController, BHAVE::DtKynapseController, DtDisaggregatedMoveAlongController, DtSurfaceEntityPilotController, DtRotaryWingFlightCommandController, DtFixedWingTakeoffController, DtTurnAndMoveController, DtFixedWingLandingController, DtEmbarkationController, DtDisaggregatedMoveIntoFormationController, DtFixedWingFlightCommandController, DtFixedWingPilotController, DtIndirectFireController, DtLasingController, DtHumanTurnToController, DtDisaggregatedMoveToLocationController, DtConvoyTaskController, DtHumanStopMovingController, DtSingleTaskControllerComponent, DtDisaggregatedMoveToController, DtGroundAutoControllerComponent, DtRotaryWingLandingController, and DtRotaryWingTaskController.
| const DtControllerComponent& DtControllerComponent::operator= | ( | const DtControllerComponent & | orig | ) | [protected] |
assignment operator
| virtual void DtControllerComponent::setRadio | ( | DtSimBaseRadio * | radio | ) | [protected, virtual] |
Reimplemented in DtLocalEntitySetController, DtLasingController, DtDisaggregatedFormationController, DtAggregateModelResolutionController, DtBallisticGunJoyController, DtTaskControllerComponent, DtOrganizationController, DtGroundJoyMoveController, DtHumanJoystickMovementController, DtAggregatedSetController, DtFixedWingJoyFlightController, DtHumanSetController, DtRotaryWingJoyFlightController, DtIffControllerComponent, DtDisaggregatedSetController, DtSystemSwitcherComponent, DtGroundJoyTurretController, DtAggregateOrganizationController, vrfAddSetExample::MyAirVehicleSetController, vrfAddSetExample::MyFixedWingEntitySetController, vrfAddSetExample::MyLocalEntitySetController, and vrfAddSetExample::MyHumanSetController.
DtSimBaseRadio* DtControllerComponent::myRadio [protected] |
Controller components can send messages.
Of course, if your controller never will, you don't have to use this.