#include <simgear/route/waypoint.hxx>
#include <simgear/structure/subsystem_mgr.hxx>
+#include <Navaids/route.hxx>
+
// forward decls
-class SGRoute;
class SGPath;
+class PropertyWatcher;
+
+class FGAirport;
+class FGRunway;
+
+typedef SGSharedPtr<FGAirport> FGAirportRef;
/**
* Top level route manager class
class FGRouteMgr : public SGSubsystem
{
+public:
+ FGRouteMgr();
+ ~FGRouteMgr();
+ void init ();
+ void postinit ();
+ void bind ();
+ void unbind ();
+ void update (double dt);
+
+ void insertWayptAtIndex(flightgear::Waypt* aWpt, int aIndex);
+ flightgear::WayptRef removeWayptAtIndex(int index);
+
+ void clearRoute();
+
+ typedef enum {
+ ROUTE_HIGH_AIRWAYS, ///< high-level airways routing
+ ROUTE_LOW_AIRWAYS, ///< low-level airways routing
+ ROUTE_VOR ///< VOR-VOR routing
+ } RouteType;
+
+ /**
+ * Insert waypoints from index-1 to index. In practice this means you can
+ * 'fill in the gaps' between defined waypoints. If index=0, the departure
+ * airport is used as index-1; if index is -1, the destination airport is
+ * used as the final waypoint.
+ */
+ bool routeToIndex(int index, RouteType aRouteType);
+
+ void autoRoute();
+
+ bool isRouteActive() const;
+
+ int currentIndex() const
+ { return _currentIndex; }
+
+ flightgear::Waypt* currentWaypt() const;
+ flightgear::Waypt* nextWaypt() const;
+ flightgear::Waypt* previousWaypt() const;
+
+ const flightgear::WayptVec& waypts() const
+ { return _route; }
+
+ int numWaypts() const
+ { return _route.size(); }
+
+ flightgear::Waypt* wayptAtIndex(int index) const;
+
+ SGPropertyNode_ptr wayptNodeAtIndex(int index) const;
+
+ /**
+ * Find a waypoint in the route, by position, and return its index, or
+ * -1 if no matching waypoint was found in the route.
+ */
+ int findWayptIndex(const SGGeod& aPos) const;
+
+ /**
+ * Activate a built route. This checks for various mandatory pieces of
+ * data, such as departure and destination airports, and creates waypoints
+ * for them on the route structure.
+ *
+ * returns true if the route was activated successfully, or false if the
+ * route could not be activated for some reason
+ */
+ bool activate();
+
+ /**
+ * Step to the next waypoint on the active route
+ */
+ void sequence();
+
+ /**
+ * Set the current waypoint to the specified index.
+ */
+ void jumpToIndex(int index);
+
+ bool saveRoute(const SGPath& p);
+ bool loadRoute(const SGPath& p);
+
+ /**
+ * Helper command to setup current airport/runway if necessary
+ */
+ void initAtPosition();
+
+ /**
+ * Create a WayPoint from a string in the following format:
+ * - simple identifier
+ * - decimal-lon,decimal-lat
+ * - airport-id/runway-id
+ * - navaid/radial-deg/offset-nm
+ */
+ flightgear::WayptRef waypointFromString(const std::string& target);
+
+ FGAirportRef departureAirport() const;
+ FGAirportRef destinationAirport() const;
+
+ FGRunway* departureRunway() const;
+ FGRunway* destinationRunway() const;
private:
- SGRoute* _route;
+ flightgear::WayptVec _route;
+ int _currentIndex;
+
time_t _takeoffTime;
time_t _touchdownTime;
- bool _autoSequence; // true if we are doing internal sequencing
- // false if other code (FMS/GPS) is managing sequencing
+ FGAirportRef _departure;
+ FGAirportRef _destination;
// automatic inputs
SGPropertyNode_ptr lon;
SGPropertyNode_ptr alt;
SGPropertyNode_ptr magvar;
- // automatic outputs
- bool _driveAutopilot;
- SGPropertyNode_ptr _apTargetAltitudeFt;
- SGPropertyNode_ptr _apAltitudeLock;
- SGPropertyNode_ptr _apTrueHeading;
-
+ // automatic outputs
SGPropertyNode_ptr departure; ///< departure airport information
SGPropertyNode_ptr destination; ///< destination airport information
SGPropertyNode_ptr alternate; ///< alternate airport information
SGPropertyNode_ptr active;
SGPropertyNode_ptr airborne;
- SGPropertyNode_ptr currentWp;
SGPropertyNode_ptr wp0;
SGPropertyNode_ptr wp1;
SGPropertyNode_ptr _pathNode;
+ SGPropertyNode_ptr _currentWpt;
+
+ /// integer property corresponding to the RouteType enum
+ SGPropertyNode_ptr _routingType;
+
+ /**
+ * Signal property to notify people that the route was edited
+ */
+ SGPropertyNode_ptr _edited;
+
+ /**
+ * Signal property to notify when the last waypoint is reached
+ */
+ SGPropertyNode_ptr _finished;
void setETAPropertyFromDistance(SGPropertyNode_ptr aProp, double aDistance);
SGPropertyNode_ptr weightOnWheels;
InputListener *listener;
- SGPropertyNode_ptr mirror;
- bool altitude_set;
-
+ SGPropertyNode_ptr mirror;
+
+ void departureChanged();
+ void buildDeparture(flightgear::WayptRef enroute, flightgear::WayptVec& wps);
+
+ void arrivalChanged();
+ void buildArrival(flightgear::WayptRef enroute, flightgear::WayptVec& wps);
+
/**
- * Create a SGWayPoint from a string in the following format:
- * - simple identifier
- * - decimal-lon,decimal-lat
- * - airport-id/runway-id
- * - navaid/radial-deg/offset-nm
+ * Helper to keep various pieces of state in sync when the route is
+ * modified (waypoints added, inserted, removed). Notably, this fires the
+ * 'edited' signal.
*/
- SGWayPoint* make_waypoint(const string& target);
-
+ void waypointsChanged();
void update_mirror();
- bool near_ground();
void currentWaypointChanged();
- /**
- * Helper to update the target_altitude_ft and altitude_set flag when wp0
- * changes
- */
- void updateTargetAltitude();
-
/**
* Parse a route/wp node (from a saved, property-lsit formatted route)
*/
void parseRouteWaypoint(SGPropertyNode* aWP);
-public:
-
- FGRouteMgr();
- ~FGRouteMgr();
-
- void init ();
- void postinit ();
- void bind ();
- void unbind ();
- void update (double dt);
-
- bool build ();
-
- void new_waypoint( const string& tgt_alt, int n = -1 );
- void add_waypoint( const SGWayPoint& wp, int n = -1 );
- SGWayPoint pop_waypoint( int i = 0 );
-
- SGWayPoint get_waypoint( int i ) const;
- int size() const;
-
- bool isRouteActive() const;
-
- int currentWaypoint() const;
-
- /**
- * Find a waypoint in the route, by position, and return its index, or
- * -1 if no matching waypoint was found in the route.
- */
- int findWaypoint(const SGGeod& aPos) const;
-
- /**
- * Activate a built route. This checks for various mandatory pieces of
- * data, such as departure and destination airports, and creates waypoints
- * for them on the route structure.
- *
- * returns true if the route was activated successfully, or false if the
- * route could not be activated for some reason
- */
- bool activate();
-
+
/**
- * Step to the next waypoint on the active route
+ * Check if we've reached the final waypoint.
+ * Returns true if we have.
*/
- void sequence();
+ bool checkFinished();
+
+
+ bool loadPlainTextRoute(const SGPath& path);
+
+ void loadVersion1XMLRoute(SGPropertyNode_ptr routeData);
+ void loadVersion2XMLRoute(SGPropertyNode_ptr routeData);
+ void loadXMLRouteHeader(SGPropertyNode_ptr routeData);
+ flightgear::WayptRef parseVersion1XMLWaypt(SGPropertyNode* aWP);
/**
- *
+ * Predicate for helping the UI - test if at least one waypoint was
+ * entered by the user (as opposed to being generated by the route-manager)
*/
- void jumpToIndex(int index);
+ bool haveUserWaypoints() const;
+
+// tied getters and setters
+ const char* getDepartureICAO() const;
+ const char* getDepartureName() const;
+ void setDepartureICAO(const char* aIdent);
- void saveRoute();
- void loadRoute();
+ const char* getDestinationICAO() const;
+ const char* getDestinationName() const;
+ void setDestinationICAO(const char* aIdent);
+
+ PropertyWatcher* _departureWatcher;
+ PropertyWatcher* _arrivalWatcher;
};
projects / flightgear.git / blobdiff