VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
railPathController.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2012 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
11 
12 #pragma once
13 
15 #include <matrix/vlVector.h>
17 #include "vrfutil/railSegment.h"
18 
19 #include <boost/shared_ptr.hpp>
20 
21 class DtRailPathTask;
24 class DtAsyncJobMapEntry;
25 class DtScriptedTaskTask;
26 
58 {
59 private:
66 
67 public:
68 
71  DtRailPathController(const DtString& name,
72  DtLocalObject* owner,
73  DtSimulationServices* simManager,
74  DtComponentDescriptor* desc = NULL,
75  DtReaderWriterRegistry* parentRegistry = NULL);
76 
77  virtual ~DtRailPathController();
78 
80  virtual bool init();
81 
87  virtual bool createPSR();
88 
89  virtual void preFirstTickInit() override;
90 
91  static void railTaskCallback(DtSimMessage* msg, void* usr, DtSimTaskStatePtr taskStatePtr);
92  static void scriptedTaskCallback(DtSimMessage* msg, void* usr, DtSimTaskStatePtr taskStatePtr);
93  static void deprecatedMovementTaskCallback(DtSimMessage* msg, void* usr, DtSimTaskStatePtr taskStatePtr);
94 
95  virtual DtSimTaskStatePtr currentTaskState() const override;
96 
99  virtual const char* type() const override;
100 
102  virtual void registerTaskMsgCallbacks() override;
103 
104  static void taskCompleteReportCallback(DtSimMessage* msg, void* usr);
105 
106  virtual void processTaskCompleteReport(DtSimMessage* msg);
107  virtual void processDeprecatedMovementTask(DtSimMessage* msg, DtSimTaskStatePtr taskStatePtr);
108 
109  static void destinationChangedCallback(const DtLocalObject* obj, void* usrData);
110 
115  virtual void processDestinationChanged();
116 
120 
121  virtual void processSetLocationComplete();
123 
125  virtual void tick() override;
126 
127 protected:
129  virtual void processRailTaskMsg(const DtTaskMessage& msg, DtSimTaskStatePtr taskStatePtr);
131  virtual void processScriptedRoadTaskMsg(const DtTaskMessage& msg, DtSimTaskStatePtr taskStatePtr);
133  virtual void processRailPathTask(const DtRailPathTask* task, DtSimTaskStatePtr taskStatePtr);
134 
135 
136  virtual void clearCurrentPath();
137  virtual bool setupPathFromRailList(DtRailSegmentList*, bool testRange = true);
138  virtual bool setupPathFromRoute(const DtSimObject* route, bool startClosestPoint, DtIteratorDirection traversalDirection);
139 
141  virtual bool isEntityCloseEnoughToRoad(
142  DtRailSegment* railSegment, double distance, double& actualDistSq) const;
143 
145  virtual bool isEntityOnRoad(DtRailSegment* railSegment) const;
146 
147  double maxSearchRadius(const DtVector& start, const DtVector& end);
148 
150  virtual bool setupPathToDestination(const DtVector& start, const DtVector& end);
151 
155  virtual void clearTask() override;
156 
157 public:
158 
162  static DtSimComponent * creator(const DtString& name,
163  DtLocalObject* owner,
164  DtSimulationServices* simManager,
165  DtComponentDescriptor* desc = 0,
166  DtReaderWriterRegistry* parentRegistry = 0);
167 
168 protected:
170  boost::shared_ptr<DtAsyncJobMapEntry> myPathJobEntry;
171 
175 
178 
180  boost::signals2::scoped_connection mySetLocationCompleteConnection;
181 };
182 
#define DT_DLL_vrfmodel
This file is used to determine how to build.
Definition: vrfmodelDefines.h:24
bool myDestinationChangedCallbackRegistered
Definition: railPathController.h:177
std::list< DtRailSegment * > DtRailSegmentList
Definition: railSegment.h:197
virtual const char * type() const override=0
Returns a string identifies the class type of component. Type values are defined in compTypes...
DtSimObjectReference myDestination
Bookkeeping for callback registration.
Definition: railPathController.h:179
virtual void registerTaskMsgCallbacks()
virtual void preFirstTickInit()
This function can be overridden to initialize a component before it is ticked for the first time...
DtRailSegment are segments entities can follow when using the rail movement system.
Definition: railSegment.h:23
This class provides a base class for all controllers that are capable of executing a DtSimTask...
Definition: singleTaskControllerComponent.h:22
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
Definition: readerWriterRegistry.h:39
DtRailPathControllerPSR * myProcessState
Container for state data associated with this component. This state is saved and restored as part of ...
Definition: railPathController.h:174
DtBoost::shared_ptr< DtSimTaskState > DtSimTaskStatePtr
Definition: taskAndTaskStateDefines.h:18
DtRailPathControllerDescriptor; descriptor for the DDtRailPathController component.
Definition: railPathControllerDescriptor.h:23
virtual bool init() override
Calls setRadio()
DtIteratorDirection
Definition: iteratorBase.h:23
const DtRailPathControllerDescriptor * myPathDescriptor
Definition: railPathController.h:176
Specialized classes.
Definition: scriptedTaskTask.h:274
DT_DLL_VRVCORE double distance(const makVrv::DtCoordinateSystem &, const DtVector &from, const DtVector &to)
Returns the distance from the two points. Coordinates are in local database coordinates The coordinat...
File: simMsg.h.
Definition: simMessage.h:35
virtual void tick()
This gives the thread of control to the component. The component is ticked once each simulation from ...
virtual DtSimTaskStatePtr currentTaskState() const
class DtRailPathControllerPSR:
Definition: railPathControllerPSR.h:28
DtRailPathController is a controller that models movement along a generated path for an entity making...
Definition: railPathController.h:57
Handle to async job.
Definition: asyncJobMapEntry.h:29
boost::shared_ptr< DtAsyncJobMapEntry > myPathJobEntry
Token for asynchronous path plan task.
Definition: railPathController.h:170
Central access point of all non-object-specific the services and managers that are available for use ...
Definition: simulationServices.h:95
The DtSimComponent class is the base class for the entire simulation model component hierarchy...
Definition: simComponent.h:91
Represents a single simulation object in the exercise. Object may be VRF simulation, or non-VRF simulated, and may be simulated by the local sim engine, or by a remote sim engine. Only public (external) state of the object is available. All data is read-only. All access to data of the object is thread safe within the simulation frame.
Definition: simObject.h:88
const DtTaskControllerComponent & operator=(const DtTaskControllerComponent &orig)
assignment operator
virtual void clearTask() override
If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false...
File: railPathTask.h.
Definition: railPathTask.h:45
A DtTaskMsg is a DtRadioMsg with a pointer to a task. The type of the taskMsg is just the type of the...
Definition: taskMessage.h:21
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
boost::signals2::scoped_connection mySetLocationCompleteConnection
Definition: railPathController.h:180

Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)