1 // hud_rwy.cxx -- An instrument that renders a virtual runway on the HUD
3 // Written by Aaron Wilson & Phillip Merritt, Nov 2004.
5 // Copyright (C) 2004 Aaron Wilson, Aaron.I.Wilson@nasa.gov
6 // Copyright (C) 2004 Phillip Merritt, Phillip.M.Merritt@nasa.gov
8 // This program is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU General Public License as
10 // published by the Free Software Foundation; either version 2 of the
11 // License, or (at your option) any later version.
13 // This program is distributed in the hope that it will be useful, but
14 // WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 #include <simgear/compiler.h>
28 #include <Main/globals.hxx>
29 #include <Scenery/scenery.hxx>
30 #include <Aircraft/aircraft.hxx>
31 #include <Environment/environment.hxx>
32 #include <Environment/environment_mgr.hxx>
33 #include <simgear/math/sg_geodesy.hxx>
34 #include <simgear/math/polar3d.hxx>
35 #include <ATCDCL/ATCutils.hxx>
40 // int x, int y, int width, int height, float scale_data, bool working)
42 runway_instr::runway_instr(const SGPropertyNode *node) :
44 node->getIntValue("x"),
45 node->getIntValue("y"),
46 node->getIntValue("width"),
47 node->getIntValue("height"),
49 node->getDoubleValue("scale"),
51 node->getBoolValue("working", true)),
52 arrowScale(node->getDoubleValue("arrow_scale", 1.0)),
53 arrowRad(node->getDoubleValue("arrow_radius")),
54 lnScale(node->getDoubleValue("line_scale", 1.0)),
55 scaleDist(node->getDoubleValue("scale_dist_nm")),
56 default_pitch(fgGetDouble("/sim/view[0]/config/pitch-pitch-deg", 0.0)),
57 default_heading(fgGetDouble("/sim/view[0]/config/pitch-heading-deg", 0.0)),
58 cockpit_view(globals->get_viewmgr()->get_view(0)),
59 stippleOut(node->getIntValue("outer_stipple", 0xFFFF)),
60 stippleCen(node->getIntValue("center_stipple", 0xFFFF)),
61 drawIA(arrowScale > 0 ? true : false),
62 drawIAAlways(arrowScale > 0 ? node->getBoolValue("arrow_always") : false)
64 SG_LOG(SG_INPUT, SG_INFO, "Done reading runway instrument "
65 << node->getStringValue("name", "[unnamed]"));
72 center.x = view[2] >> 1;
73 center.y = view[3] >> 1;
75 location.left = center.x - (get_width() >> 1) + get_x();
76 location.right = center.x + (get_width() >>1) + get_x();
77 location.bottom = center.y - (get_height() >>1) + get_y();
78 location.top = center.y + (get_height() >> 1) + get_y();
83 void runway_instr::draw()
85 if (!is_broken() && get_active_runway(runway)) {
86 glPushAttrib(GL_LINE_STIPPLE | GL_LINE_STIPPLE_PATTERN | GL_LINE_WIDTH);
87 float modelView[4][4], projMat[4][4];
89 //Get the current view
90 FGViewer* curr_view = globals->get_viewmgr()->get_current_view();
91 int curr_view_id = globals->get_viewmgr()->get_current();
92 double gpo = curr_view->getGoalPitchOffset_deg();
93 double gho = curr_view->getGoalHeadingOffset_deg();
94 double po = curr_view->getPitchOffset_deg();
95 double ho = curr_view->getHeadingOffset_deg();
97 double yaw = -(cockpit_view->getHeadingOffset_deg() - default_heading) * SG_DEGREES_TO_RADIANS;
98 double pitch = (cockpit_view->getPitchOffset_deg() - default_pitch) * SG_DEGREES_TO_RADIANS;
99 //double roll = fgGetDouble("/sim/view[0]/config/roll-offset-deg",0.0) //TODO: adjust for default roll offset
100 double sPitch = sin(pitch), cPitch = cos(pitch),
101 sYaw = sin(yaw), cYaw = cos(yaw);
103 //Assuming that the "Cockpit View" is always at position zero!!!
104 if (curr_view_id != 0) {
105 globals->get_viewmgr()->set_view(0);
106 globals->get_viewmgr()->copyToCurrent();
108 //Set the camera to the cockpit view to get the view of the runway from the cockpit
110 // ssgSetCamera((sgVec4 *)cockpit_view->get_VIEW());
111 get_rwy_points(points3d);
112 //Get the current project matrix
114 // ssgGetProjectionMatrix(projMat);
115 // const sgVec4 *viewMat = globals->get_current_view()->get_VIEW();
116 //Get the current model view matrix (cockpit view)
118 // ssgGetModelviewMatrix(modelView);
119 //Create a rotation matrix to correct for any offsets (other than default offsets) to the model view matrix
120 sgMat4 xy; //rotation about the Rxy, negate the sin's on Ry
121 xy[0][0] = cYaw; xy[1][0] = 0.0f; xy[2][0] = -sYaw; xy[3][0] = 0.0f;
122 xy[0][1] = sPitch*-sYaw; xy[1][1] = cPitch; xy[2][1] = -sPitch*cYaw; xy[3][1] = 0.0f;
123 xy[0][2] = cPitch*sYaw; xy[1][2] = sPitch; xy[2][2] = cPitch*cYaw; xy[3][2] = 0.0f;
124 xy[0][3] = 0.0f; xy[1][3] = 0.0f; xy[2][3] = 0.0f; xy[3][3] = 1.0f;
125 //Re-center the model view
126 sgPostMultMat4(modelView,xy);
127 //copy float matrices to double
128 for (int i = 0; i < 4; i++) {
129 for (int j = 0; j < 4; j++) {
130 int idx = (i * 4) + j;
131 mm[idx] = (double)modelView[i][j];
132 pm[idx] = (double)projMat[i][j];
136 //Calculate the 2D points via gluProject
137 int result = GL_TRUE;
138 for (int i = 0; i < 6; i++) {
139 result = gluProject(points3d[i][0], points3d[i][1], points3d[i][2], mm,
140 pm, view, &points2d[i][0], &points2d[i][1], &points2d[i][2]);
142 //set the line width based on our distance from the runway
144 //Draw the runway lines on the HUD
145 glEnable(GL_LINE_STIPPLE);
146 glLineStipple(1, stippleOut);
148 drawLine(points3d[0], points3d[1], points2d[0], points2d[1]) | //draw top
149 drawLine(points3d[2], points3d[1], points2d[2], points2d[1]) | //draw right
150 drawLine(points3d[2], points3d[3], points2d[2], points2d[3]) | //draw bottom
151 drawLine(points3d[3], points3d[0], points2d[3], points2d[0]); //draw left
153 glLineStipple(1, stippleCen);
154 anyLines |= drawLine(points3d[5], points3d[4], points2d[5], points2d[4]); //draw center
156 //Check to see if arrow needs drawn
157 if ((!anyLines && drawIA) || drawIAAlways) {
158 drawArrow(); //draw indication arrow
161 //Restore the current view and any offsets
162 if (curr_view_id != 0) {
163 globals->get_viewmgr()->set_view(curr_view_id);
164 globals->get_viewmgr()->copyToCurrent();
165 curr_view->setHeadingOffset_deg(ho);
166 curr_view->setPitchOffset_deg(po);
167 curr_view->setGoalHeadingOffset_deg(gho);
168 curr_view->setGoalPitchOffset_deg(gpo);
170 //Set the camera back to the current view
172 // ssgSetCamera((sgVec4 *)curr_view);
178 bool runway_instr::get_active_runway(FGRunway& runway)
180 const FGAirport* apt = fgFindAirportID(fgGetString("/sim/presets/airport-id"));
181 if (!apt) return false;
183 runway = apt->getActiveRunwayForUsage();
184 return (!runway._rwy_no.empty());
188 void runway_instr::get_rwy_points(sgdVec3 *points3d)
190 double alt = current_aircraft.fdm_state->get_Runway_altitude() * SG_FEET_TO_METER;
191 double length = (runway._length / 2.0) * SG_FEET_TO_METER;
192 double width = (runway._width / 2.0) * SG_FEET_TO_METER;
193 double frontLat, frontLon, backLat, backLon,az, tempLat, tempLon;
195 geo_direct_wgs_84(alt, runway._lat, runway._lon, runway._heading, length, &backLat, &backLon, &az);
196 sgGeodToCart(backLat * SG_DEGREES_TO_RADIANS, backLon * SG_DEGREES_TO_RADIANS, alt, points3d[4]);
198 geo_direct_wgs_84(alt, runway._lat, runway._lon, runway._heading + 180, length, &frontLat, &frontLon, &az);
199 sgGeodToCart(frontLat * SG_DEGREES_TO_RADIANS, frontLon * SG_DEGREES_TO_RADIANS, alt, points3d[5]);
201 geo_direct_wgs_84(alt, backLat, backLon, runway._heading + 90, width, &tempLat, &tempLon, &az);
202 sgGeodToCart(tempLat * SG_DEGREES_TO_RADIANS, tempLon * SG_DEGREES_TO_RADIANS, alt, points3d[0]);
204 geo_direct_wgs_84(alt, backLat, backLon, runway._heading - 90, width, &tempLat, &tempLon, &az);
205 sgGeodToCart(tempLat * SG_DEGREES_TO_RADIANS, tempLon * SG_DEGREES_TO_RADIANS, alt, points3d[1]);
207 geo_direct_wgs_84(alt, frontLat, frontLon, runway._heading - 90, width, &tempLat, &tempLon, &az);
208 sgGeodToCart(tempLat * SG_DEGREES_TO_RADIANS, tempLon * SG_DEGREES_TO_RADIANS, alt, points3d[2]);
210 geo_direct_wgs_84(alt, frontLat, frontLon, runway._heading + 90, width, &tempLat, &tempLon, &az);
211 sgGeodToCart(tempLat * SG_DEGREES_TO_RADIANS, tempLon * SG_DEGREES_TO_RADIANS, alt, points3d[3]);
215 bool runway_instr::drawLine(const sgdVec3& a1, const sgdVec3& a2, const sgdVec3& point1, const sgdVec3& point2)
218 sgdCopyVec3(p1, point1);
219 sgdCopyVec3(p2, point2);
220 bool p1Inside = (p1[0] >= location.left && p1[0] <= location.right
221 && p1[1] >= location.bottom && p1[1] <= location.top);
222 bool p1Insight = (p1[2] >= 0.0 && p1[2] < 1.0);
223 bool p1Valid = p1Insight && p1Inside;
224 bool p2Inside = (p2[0] >= location.left && p2[0] <= location.right
225 && p2[1] >= location.bottom && p2[1] <= location.top);
226 bool p2Insight = (p2[2] >= 0.0 && p2[2] < 1.0);
227 bool p2Valid = p2Insight && p2Inside;
229 if (p1Valid && p2Valid) { //Both project points are valid, draw the line
231 glVertex2d(p1[0],p1[1]);
232 glVertex2d(p2[0],p2[1]);
235 } else if (p1Valid) { //p1 is valid and p2 is not, calculate a new valid point
236 sgdVec3 vec = {a2[0] - a1[0], a2[1] - a1[1], a2[2] - a1[2]};
237 //create the unit vector
238 sgdScaleVec3(vec, 1.0 / sgdLengthVec3(vec));
240 sgdCopyVec3(newPt, a1);
241 sgdAddVec3(newPt, vec);
242 if (gluProject(newPt[0], newPt[1], newPt[2], mm, pm, view, &p2[0], &p2[1], &p2[2])
243 && (p2[2] > 0 && p2[2] < 1.0)) {
246 glVertex2d(p1[0], p1[1]);
247 glVertex2d(p2[0], p2[1]);
251 } else if (p2Valid) { //p2 is valid and p1 is not, calculate a new valid point
252 sgdVec3 vec = {a1[0] - a2[0], a1[1] - a2[1], a1[2] - a2[2]};
253 //create the unit vector
254 sgdScaleVec3(vec, 1.0 / sgdLengthVec3(vec));
256 sgdCopyVec3(newPt, a2);
257 sgdAddVec3(newPt, vec);
258 if (gluProject(newPt[0], newPt[1], newPt[2], mm, pm, view, &p1[0], &p1[1], &p1[2])
259 && (p1[2] > 0 && p1[2] < 1.0)) {
262 glVertex2d(p2[0], p2[1]);
263 glVertex2d(p1[0], p1[1]);
267 } else if (p1Insight && p2Insight) { //both points are insight, but not inside
268 bool v = boundOutsidePoints(p1, p2);
271 glVertex2d(p1[0], p1[1]);
272 glVertex2d(p2[0], p2[1]);
277 //else both points are not insight, don't draw anything
278 return (p1Valid && p2Valid);
282 void runway_instr::boundPoint(const sgdVec3& v, sgdVec3& m)
287 else if (m[1] > v[1])
292 return; //prevent divide by zero
295 double slope = (m[1] - v[1]) / (m[0] - v[0]);
296 m[0] = (y - v[1]) / slope + v[0];
299 if (m[0] < location.left) {
300 m[0] = location.left;
301 m[1] = slope * (location.left - v[0]) + v[1];
303 } else if (m[0] > location.right) {
304 m[0] = location.right;
305 m[1] = slope * (location.right - v[0]) + v[1];
310 bool runway_instr::boundOutsidePoints(sgdVec3& v, sgdVec3& m)
312 bool pointsInvalid = (v[1] > location.top && m[1] > location.top) ||
313 (v[1] < location.bottom && m[1] < location.bottom) ||
314 (v[0] > location.right && m[0] > location.right) ||
315 (v[0] < location.left && m[0] < location.left);
319 if (m[0] == v[0]) {//x's are equal, vertical line
322 v[1] = location.bottom;
325 m[1] = location.bottom;
330 if (m[1] == v[1]) { //y's are equal, horizontal line
332 m[0] = location.right;
333 v[0] = location.left;
335 v[0] = location.right;
336 m[0] = location.left;
341 double slope = (m[1] - v[1]) / (m[0] - v[0]);
342 double b = v[1] - (slope * v[0]);
343 double y1 = slope * location.left + b;
344 double y2 = slope * location.right + b;
345 double x1 = (location.bottom - b) / slope;
346 double x2 = (location.top - b) / slope;
349 if (y1 >= location.bottom && y1 <= location.top) {
350 v[0] = location.left;
355 if (y2 >= location.bottom && y2 <= location.top) {
357 m[0] = location.right;
360 v[0] = location.right;
366 if (x1 >= location.left && x1 <= location.right) {
369 m[1] = location.bottom;
372 v[1] = location.bottom;
377 if (x2 >= location.left && x2 <= location.right) {
379 m[1] = location.bottom;
382 return (counter == 2);
385 void runway_instr::drawArrow()
387 Point3D ac(0.0), rwy(0.0);
388 ac.setlat(current_aircraft.fdm_state->get_Latitude_deg());
389 ac.setlon(current_aircraft.fdm_state->get_Longitude_deg());
390 rwy.setlat(runway._lat);
391 rwy.setlon(runway._lon);
392 float theta = GetHeadingFromTo(ac, rwy);
393 theta -= fgGetDouble("/orientation/heading-deg");
395 glMatrixMode(GL_MODELVIEW);
397 glTranslated((location.right + location.left) / 2.0,(location.top + location.bottom) / 2.0, 0.0);
398 glRotated(theta, 0.0, 0.0, 1.0);
399 glTranslated(0.0, arrowRad, 0.0);
400 glScaled(arrowScale, arrowScale, 0.0);
402 glBegin(GL_TRIANGLES);
403 glVertex2d(-5.0, 12.5);
404 glVertex2d(0.0, 25.0);
405 glVertex2d(5.0, 12.5);
409 glVertex2d(-2.5, 0.0);
410 glVertex2d(-2.5, 12.5);
411 glVertex2d(2.5, 12.5);
412 glVertex2d(2.5, 0.0);
417 void runway_instr::setLineWidth()
419 //Calculate the distance from the runway, A
420 double course, distance;
421 calc_gc_course_dist(Point3D(runway._lon * SGD_DEGREES_TO_RADIANS,
422 runway._lat * SGD_DEGREES_TO_RADIANS, 0.0),
423 Point3D(current_aircraft.fdm_state->get_Longitude(),
424 current_aircraft.fdm_state->get_Latitude(), 0.0 ),
426 distance *= SG_METER_TO_NM;
427 //Get altitude above runway, B
428 double alt_nm = get_agl();
429 static const SGPropertyNode *startup_units_node = fgGetNode("/sim/startup/units");
431 if (!strcmp(startup_units_node->getStringValue(), "feet"))
432 alt_nm *= SG_FEET_TO_METER*SG_METER_TO_NM;
434 alt_nm *= SG_METER_TO_NM;
436 //Calculate distance away from runway, C = v(A≤+B≤)
437 distance = sqrt(alt_nm * alt_nm + distance*distance);
438 if (distance < scaleDist)
439 glLineWidth(1.0 + ((lnScale - 1) * ((scaleDist - distance) / scaleDist)));
445 void runway_instr::setArrowRotationRadius(double radius) { arrowRad = radius; }
446 void runway_instr::setArrowScale(double scale) { arrowScale = scale; }
447 void runway_instr::setDrawArrow(bool draw) {drawIA = draw;}
448 void runway_instr::setDrawArrowAlways(bool draw) {drawIAAlways = draw;}
449 void runway_instr::setLineScale(double scale) {lnScale = scale;}
450 void runway_instr::setScaleDist(double dist_m) {scaleDist = dist_m;}
451 void runway_instr::setStippleOutline(unsigned short stipple) {stippleOut = stipple;}
452 void runway_instr::setStippleCenterline(unsigned short stipple){stippleCen = stipple;}