VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
aggregatedMoveToController.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2014 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
9 
11 
12 #pragma once
13 
16 
17 class DtCgf;
19 class DtSimMessage;
21 class DtOutputPortGroup;
23 class DtVectorOutputPort;
25 class DtAnalogOutputPort;
26 class DtSetDataRequest;
27 class DtSetDataManager;
28 
43 {
44 private:
51 public:
54 
57 
59  virtual bool init();
60 
62  virtual const char* type() const;
63 
65  virtual void tick();
66 
71  static void moveToCallback(DtSimMessage * msg, void * usr);
72  static void moveToRetrogradeCallback(DtSimMessage * msg, void * usr);
73 
78  static void setLocationCallback(DtSimMessage* msg, void* usr);
79 
84  static void moveToLocationCallback(DtSimMessage * msg, void * usr);
85  static void moveToLocationRetrogradeCallback(DtSimMessage * msg, void * usr);
86 
91  static void moveIntoFormationCallback(DtSimMessage * msg, void * usr);
92 
97  static void turnToHeadingCallback(DtSimMessage* msg, void* usrData);
98 
100  static DtSimComponent* creator(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager, DtComponentDescriptor* desc=0, DtReaderWriterRegistry* parentRegistry=0);
101 
103  static void modifyVrfObjectCallback(DtSimMessage* msg, void* usr);
104 
105  virtual void updateTaskVisualizations();
106 
107 protected:
108 
111  virtual void processMoveToTask(DtSimMessage * msg);
112  virtual void processMoveToLocationTask(DtSimMessage * msg);
113  virtual void processMoveToRetrogradeTask(DtSimMessage * msg);
114  virtual void processMoveToLocationRetrogradeTask(DtSimMessage * msg);
115  virtual void preFirstTickInit();
116 
121  virtual void processDestinationChanged();
122 
126  virtual bool setupDestination();
127 
136  virtual void setupDestinationVector() const;
137 
139  virtual void invalidateDestinationVector() const;
140 
149  virtual bool atDestination();
150 
152  virtual void doMoving();
153 
155  virtual double findDesiredHeading();
156 
158  virtual void moveToDestination();
159 
161  virtual void stop();
162 
164  virtual void registerTaskMsgCallbacks();
165 
169  virtual void processModifyVrfObject(DtSimMessage* msg);
170 
173  virtual void processSetLocation(DtSimMessage* msg);
174 
176  virtual bool createPortGroups();
177 
179  virtual bool createPorts();
180 
186  virtual bool createPSR();
187 
188  virtual double distanceToDestination() const;
189 
191  virtual void clearTask();
192 
197  virtual double atDistance() const;
198 
202  virtual void processMoveIntoFormationTask(DtSimMessage* msg);
203 
206  virtual void processTurnToHeadingTask(DtSimMessage* msg);
207 
209  virtual void sendRequestToSelf(const DtSetDataRequest& request) const;
210 
212  virtual void processEstimatedTotCalculation();
213 
214 protected:
215 
218 
224 
230 
233 
240 
242 
246 
249 
252 
257 
259  const double DtEstimatedTotCalcInterval = 5.0;
260 
263 
265 
269 
271 
275 
277 };
278 
DtAggregatedMoveToDescriptor * myAggregatedMoveToDescriptor
Definition: aggregatedMoveToController.h:270
#define DT_DLL_vrfmodel
This file is used to determine how to build.
Definition: vrfmodelDefines.h:24
DtAggregatedMoveToController is a controller that models movement to a <location> or <waypoint> for a...
Definition: aggregatedMoveToController.h:42
double myEstimatedTotValue
Definition: aggregatedMoveToController.h:255
class DtAggregatedMoveToPSR:
Definition: aggregatedMoveToPSR.h:28
DtAggregatedMoveToPSR * myProcessState
Container for state data associated with this component. This state is saved and restored as part of ...
Definition: aggregatedMoveToController.h:268
virtual const char * type() const override=0
Returns a string identifies the class type of component. Type values are defined in compTypes...
Instances of DtBooleanOutputPort are output ports through which data producers can send boolean data...
Definition: boolIOPort.h:45
bool myDestinationVectorIsValid
Definition: aggregatedMoveToController.h:251
virtual void registerTaskMsgCallbacks()
DtVectorOutputPort * myDestinationOutputPort
Output Port Name: destination Output Port Description: Specifies the current destination of the entit...
Definition: aggregatedMoveToController.h:239
virtual void preFirstTickInit()
This function can be overridden to initialize a component before it is ticked for the first time...
This class provides a base class for all controllers that are capable of executing a DtSimTask...
Definition: singleTaskControllerComponent.h:22
DtVector myWorldDestination
Definition: aggregatedMoveToController.h:248
The DtSimObjectReference is a shared pointer that can be used amongst many object for access to the u...
Definition: simObjectReference.h:26
A readable, writable type whose name is the name of a component and that has a list of component name...
Definition: componentDescriptor.h:49
DtOutputPortGroup * myOutputPortGroup
Output Group Name: movement-control .
Definition: aggregatedMoveToController.h:232
Definition: readerWriterRegistry.h:39
DtVector myEstimatedTotTextPos
tot text position
Definition: aggregatedMoveToController.h:262
DtOutputPortGroup is a data port group of a data provider. It may contain any number of DtOutputPorts...
Definition: outputPortGroup.h:34
DtSimObjectReference myControlPoint
This is looked up once per tick - assumed unchanging while we have control.
Definition: aggregatedMoveToController.h:245
DtBooleanOutputPort * myRetrogradeOutputPort
Definition: aggregatedMoveToController.h:276
DtVrfAggregateStateRepository * myAggregateStateRepository
Definition: aggregatedMoveToController.h:264
virtual void updateTaskVisualizations()
Called to update task visualizations after every tick. Implemented by subclasses. ...
Definition: simComponent.h:437
virtual bool init() override
Calls setRadio()
DtSetDataRequest is an abstract base class from which real setDataRequests can derive. It manages the read/write capability; derived classes need only use and register read/writatble data types for derived information.
Definition: setDataRequest.h:41
Instances of DtAnalogOutputPort are input ports through which data producers can send real numbers...
Definition: analogIOPort.h:45
Instances of DtVectorOutputPort are output ports through which data producers can send a DtVector...
Definition: vectorIOPort.h:52
File: simMsg.h.
Definition: simMessage.h:35
DtVector myLocalDestination
Definition: aggregatedMoveToController.h:247
DtVector myDestinationVector
Definition: aggregatedMoveToController.h:250
virtual void tick()
This gives the thread of control to the component. The component is ticked once each simulation from ...
virtual bool createPorts()
Called by init. Derived classes should override this method to create all their input/output ports an...
DtAnalogOutputPort * myMovementDirectionOutputPort
Output Port Name: desired-movement-direction Output Port Description: Specifies the current movement ...
Definition: aggregatedMoveToController.h:223
virtual bool createPortGroups()
Called by init. Derived classes should override this method to create all their input/output port gro...
Central access point of all non-object-specific the services and managers that are available for use ...
Definition: simulationServices.h:94
The DtSimComponent class is the base class for the entire simulation model component hierarchy...
Definition: simComponent.h:91
const DtTaskControllerComponent & operator=(const DtTaskControllerComponent &orig)
assignment operator
This class manages the distribution of DtSetDataRequests within a single DtLocalObject. Components of the object, or other parts of the code, register interested in particular types of set data messages and when such a message is processed by the DtSetDataManager, each of the registered parties is notified.
Definition: setDataManager.h:48
bool myAtDestination
Definition: aggregatedMoveToController.h:253
DtAggregatedMoveToDescriptor; descriptor for the DtAggregatedMoveToDescriptor component.
Definition: aggregatedMoveToDescriptor.h:21
DtAnalogOutputPort * mySpeedOutputPort
Output Port Name: desired-speed Output Port Description: Specifies the current speed of the entity in...
Definition: aggregatedMoveToController.h:229
virtual void clearTask() override
If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false...
DtSetDataManager * mySetDataManager
Pointer to aggregate's DtSetDataManager, cached in this class for convenience.
Definition: aggregatedMoveToController.h:274
double myDistanceSquared
Definition: aggregatedMoveToController.h:254
void processSetLocation(DtSetDataRequest *set, const DtVertexList &vertices, double position, DtMoveAlongRouteTimeEstimator *est)
Definition: vrfAggregateStateRepository.h:21
The top level class of a VR-Forces Simulation Engine, representing a Computer Generated Forces instan...
Definition: cgf.h:147
double myEstimatedTotLastCalcTime
Definition: aggregatedMoveToController.h:256
A locally simulated VRF object. Holds all internal and external data for the object, and provides access to both the current frame and next frame state data for the object. All current frame data is read-only, and next-frame data can be written to. No thread safety guarantees are made on this object during the simulation frame and it should only be accessed by the thread that is simulating the object.
Definition: localObject.h:86

Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)