1 // HUD_runway.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.
26 #include <simgear/compiler.h>
27 #include <simgear/math/sg_geodesy.hxx>
28 #include <simgear/math/project.hxx>
30 #include <Main/globals.hxx>
31 #include <Scenery/scenery.hxx>
32 #include <Aircraft/controls.hxx>
33 #include <FDM/flight.hxx>
34 #include <Environment/environment.hxx>
35 #include <Environment/environment_mgr.hxx>
36 #include <Main/viewer.hxx>
37 #include <Main/viewmgr.hxx>
38 #include <ATCDCL/ATCutils.hxx>
43 HUD::Runway::Runway(HUD *hud, const SGPropertyNode *node, float x, float y) :
44 Item(hud, node, x, y),
45 _agl(fgGetNode("/position/altitude-agl-ft", true)),
46 _arrow_scale(node->getDoubleValue("arrow-scale", 1.0)),
47 _arrow_radius(node->getDoubleValue("arrow-radius")),
48 _line_scale(node->getDoubleValue("line-scale", 1.0)),
49 _scale_dist(node->getDoubleValue("scale-dist-nm")),
50 _default_pitch(fgGetDouble("/sim/view[0]/config/pitch-pitch-deg", 0.0)),
51 _default_heading(fgGetDouble("/sim/view[0]/config/pitch-heading-deg", 0.0)),
52 _cockpit_view(globals->get_viewmgr()->get_view(0)),
53 _stipple_out(node->getIntValue("outer_stipple", 0xFFFF)),
54 _stipple_center(node->getIntValue("center-stipple", 0xFFFF)),
55 _draw_arrow(_arrow_scale > 0 ? true : false),
56 _draw_arrow_always(_arrow_scale > 0 ? node->getBoolValue("arrow-always") : false)
63 _center_x = _view[2] / 2;
64 _center_y = _view[3] / 2;
66 _left = _center_x - (_w / 2) + _x;
67 _right = _center_x + (_w / 2) + _x;
68 _bottom = _center_y - (_h / 2) + _y;
69 _top = _center_y + (_h / 2) + _y;
73 void HUD::Runway::draw()
75 _runway = get_active_runway();
79 glPushAttrib(GL_LINE_STIPPLE | GL_LINE_STIPPLE_PATTERN | GL_LINE_WIDTH);
80 float modelView[4][4], projMat[4][4];
82 //Get the current view
83 FGViewer* curr_view = globals->get_viewmgr()->get_current_view();
84 int curr_view_id = globals->get_viewmgr()->get_current();
85 double gpo = curr_view->getGoalPitchOffset_deg();
86 double gho = curr_view->getGoalHeadingOffset_deg();
87 double po = curr_view->getPitchOffset_deg();
88 double ho = curr_view->getHeadingOffset_deg();
90 double yaw = -(_cockpit_view->getHeadingOffset_deg() - _default_heading) * SG_DEGREES_TO_RADIANS;
91 double pitch = (_cockpit_view->getPitchOffset_deg() - _default_pitch) * SG_DEGREES_TO_RADIANS;
92 //double roll = fgGetDouble("/sim/view[0]/config/roll-offset-deg",0.0) //TODO: adjust for default roll offset
93 double sPitch = sin(pitch), cPitch = cos(pitch),
94 sYaw = sin(yaw), cYaw = cos(yaw);
96 //Assuming that the "Cockpit View" is always at position zero!!!
97 if (curr_view_id != 0) {
98 globals->get_viewmgr()->set_view(0);
99 globals->get_viewmgr()->copyToCurrent();
101 //Set the camera to the cockpit view to get the view of the runway from the cockpit
103 // ssgSetCamera((sgVec4 *)_cockpit_view->get_VIEW());
104 get_rwy_points(_points3d);
105 //Get the current project matrix
107 // ssgGetProjectionMatrix(projMat);
108 // const sgVec4 *viewMat = globals->get_current_view()->get_VIEW();
109 //Get the current model view matrix (cockpit view)
111 // ssgGetModelviewMatrix(modelView);
112 //Create a rotation matrix to correct for any offsets (other than default offsets) to the model view matrix
113 sgMat4 xy; //rotation about the Rxy, negate the sin's on Ry
114 xy[0][0] = cYaw, xy[1][0] = 0.0f, xy[2][0] = -sYaw, xy[3][0] = 0.0f;
115 xy[0][1] = sPitch*-sYaw, xy[1][1] = cPitch, xy[2][1] = -sPitch*cYaw, xy[3][1] = 0.0f;
116 xy[0][2] = cPitch*sYaw, xy[1][2] = sPitch, xy[2][2] = cPitch*cYaw, xy[3][2] = 0.0f;
117 xy[0][3] = 0.0f, xy[1][3] = 0.0f, xy[2][3] = 0.0f, xy[3][3] = 1.0f;
118 //Re-center the model view
119 sgPostMultMat4(modelView,xy);
120 //copy float matrices to double
121 for (int i = 0; i < 4; i++) {
122 for (int j = 0; j < 4; j++) {
123 int idx = (i * 4) + j;
124 _mm[idx] = (double)modelView[i][j];
125 _pm[idx] = (double)projMat[i][j];
129 //Calculate the 2D points via gluProject
130 int result = GL_TRUE;
131 for (int i = 0; i < 6; i++) {
132 result = simgear::project(_points3d[i][0], _points3d[i][1], _points3d[i][2],
134 &_points2d[i][0], &_points2d[i][1], &_points2d[i][2]);
136 //set the line width based on our distance from the runway
138 //Draw the runway lines on the HUD
139 glEnable(GL_LINE_STIPPLE);
140 glLineStipple(1, _stipple_out);
142 drawLine(_points3d[0], _points3d[1], _points2d[0], _points2d[1]) | //draw top
143 drawLine(_points3d[2], _points3d[1], _points2d[2], _points2d[1]) | //draw right
144 drawLine(_points3d[2], _points3d[3], _points2d[2], _points2d[3]) | //draw bottom
145 drawLine(_points3d[3], _points3d[0], _points2d[3], _points2d[0]); //draw left
147 glLineStipple(1, _stipple_center);
148 anyLines |= drawLine(_points3d[5], _points3d[4], _points2d[5], _points2d[4]); //draw center
150 //Check to see if arrow needs drawn
151 if ((!anyLines && _draw_arrow) || _draw_arrow_always) {
152 drawArrow(); //draw indication arrow
155 //Restore the current view and any offsets
156 if (curr_view_id != 0) {
157 globals->get_viewmgr()->set_view(curr_view_id);
158 globals->get_viewmgr()->copyToCurrent();
159 curr_view->setHeadingOffset_deg(ho);
160 curr_view->setPitchOffset_deg(po);
161 curr_view->setGoalHeadingOffset_deg(gho);
162 curr_view->setGoalPitchOffset_deg(gpo);
164 //Set the camera back to the current view
166 // ssgSetCamera((sgVec4 *)curr_view);
171 FGRunway* HUD::Runway::get_active_runway()
173 const FGAirport* apt = fgFindAirportID(fgGetString("/sim/presets/airport-id"));
174 if (!apt) return NULL;
176 return apt->getActiveRunwayForUsage();
181 void HUD::Runway::get_rwy_points(sgdVec3 *_points3d)
183 double alt = _runway->geod().getElevationM();
184 double length = _runway->lengthM() * 0.5;
185 double width = _runway->widthM() * 0.5;
186 double frontLat = 0.0, frontLon = 0.0, backLat = 0.0, backLon = 0.0, az = 0.0, tempLat = 0.0, tempLon = 0.0;
188 geo_direct_wgs_84(alt, _runway->latitude(), _runway->longitude(), _runway->headingDeg(), length, &backLat, &backLon, &az);
189 sgGeodToCart(backLat * SG_DEGREES_TO_RADIANS, backLon * SG_DEGREES_TO_RADIANS, alt, _points3d[4]);
191 geo_direct_wgs_84(alt, _runway->latitude(), _runway->longitude(), _runway->headingDeg() + 180, length, &frontLat, &frontLon, &az);
192 sgGeodToCart(frontLat * SG_DEGREES_TO_RADIANS, frontLon * SG_DEGREES_TO_RADIANS, alt, _points3d[5]);
194 geo_direct_wgs_84(alt, backLat, backLon, _runway->headingDeg() + 90, width, &tempLat, &tempLon, &az);
195 sgGeodToCart(tempLat * SG_DEGREES_TO_RADIANS, tempLon * SG_DEGREES_TO_RADIANS, alt, _points3d[0]);
197 geo_direct_wgs_84(alt, backLat, backLon, _runway->headingDeg() - 90, width, &tempLat, &tempLon, &az);
198 sgGeodToCart(tempLat * SG_DEGREES_TO_RADIANS, tempLon * SG_DEGREES_TO_RADIANS, alt, _points3d[1]);
200 geo_direct_wgs_84(alt, frontLat, frontLon, _runway->headingDeg() - 90, width, &tempLat, &tempLon, &az);
201 sgGeodToCart(tempLat * SG_DEGREES_TO_RADIANS, tempLon * SG_DEGREES_TO_RADIANS, alt, _points3d[2]);
203 geo_direct_wgs_84(alt, frontLat, frontLon, _runway->headingDeg() + 90, width, &tempLat, &tempLon, &az);
204 sgGeodToCart(tempLat * SG_DEGREES_TO_RADIANS, tempLon * SG_DEGREES_TO_RADIANS, alt, _points3d[3]);
208 bool HUD::Runway::drawLine(const sgdVec3& a1, const sgdVec3& a2, const sgdVec3& point1, const sgdVec3& point2)
211 sgdCopyVec3(p1, point1);
212 sgdCopyVec3(p2, point2);
213 bool p1Inside = (p1[0] >= _left && p1[0] <= _right && p1[1] >= _bottom && p1[1] <= _top);
214 bool p1Insight = (p1[2] >= 0.0 && p1[2] < 1.0);
215 bool p1Valid = p1Insight && p1Inside;
216 bool p2Inside = (p2[0] >= _left && p2[0] <= _right && p2[1] >= _bottom && p2[1] <= _top);
217 bool p2Insight = (p2[2] >= 0.0 && p2[2] < 1.0);
218 bool p2Valid = p2Insight && p2Inside;
220 if (p1Valid && p2Valid) { //Both project points are valid, draw the line
222 glVertex2d(p1[0],p1[1]);
223 glVertex2d(p2[0],p2[1]);
226 } else if (p1Valid) { //p1 is valid and p2 is not, calculate a new valid point
227 sgdVec3 vec = {a2[0] - a1[0], a2[1] - a1[1], a2[2] - a1[2]};
228 //create the unit vector
229 sgdScaleVec3(vec, 1.0 / sgdLengthVec3(vec));
231 sgdCopyVec3(newPt, a1);
232 sgdAddVec3(newPt, vec);
233 if (simgear::project(newPt[0], newPt[1], newPt[2], _mm, _pm, _view,
234 &p2[0], &p2[1], &p2[2])
235 && (p2[2] > 0 && p2[2] < 1.0)) {
238 glVertex2d(p1[0], p1[1]);
239 glVertex2d(p2[0], p2[1]);
243 } else if (p2Valid) { //p2 is valid and p1 is not, calculate a new valid point
244 sgdVec3 vec = {a1[0] - a2[0], a1[1] - a2[1], a1[2] - a2[2]};
245 //create the unit vector
246 sgdScaleVec3(vec, 1.0 / sgdLengthVec3(vec));
248 sgdCopyVec3(newPt, a2);
249 sgdAddVec3(newPt, vec);
250 if (simgear::project(newPt[0], newPt[1], newPt[2], _mm, _pm, _view,
251 &p1[0], &p1[1], &p1[2])
252 && (p1[2] > 0 && p1[2] < 1.0)) {
255 glVertex2d(p2[0], p2[1]);
256 glVertex2d(p1[0], p1[1]);
260 } else if (p1Insight && p2Insight) { //both points are insight, but not inside
261 bool v = boundOutsidePoints(p1, p2);
264 glVertex2d(p1[0], p1[1]);
265 glVertex2d(p2[0], p2[1]);
270 //else both points are not insight, don't draw anything
271 return (p1Valid && p2Valid);
275 void HUD::Runway::boundPoint(const sgdVec3& v, sgdVec3& m)
280 else if (m[1] > v[1])
285 return; //prevent divide by zero
288 double slope = (m[1] - v[1]) / (m[0] - v[0]);
289 m[0] = (y - v[1]) / slope + v[0];
294 m[1] = slope * (_left - v[0]) + v[1];
296 } else if (m[0] > _right) {
298 m[1] = slope * (_right - v[0]) + v[1];
303 bool HUD::Runway::boundOutsidePoints(sgdVec3& v, sgdVec3& m)
305 bool pointsInvalid = (v[1] > _top && m[1] > _top) ||
306 (v[1] < _bottom && m[1] < _bottom) ||
307 (v[0] > _right && m[0] > _right) ||
308 (v[0] < _left && m[0] < _left);
312 if (m[0] == v[0]) {//x's are equal, vertical line
323 if (m[1] == v[1]) { //y's are equal, horizontal line
334 double slope = (m[1] - v[1]) / (m[0] - v[0]);
335 double b = v[1] - (slope * v[0]);
336 double y1 = slope * _left + b;
337 double y2 = slope * _right + b;
338 double x1 = (_bottom - b) / slope;
339 double x2 = (_top - b) / slope;
342 if (y1 >= _bottom && y1 <= _top) {
348 if (y2 >= _bottom && y2 <= _top) {
359 if (x1 >= _left && x1 <= _right) {
370 if (x2 >= _left && x2 <= _right) {
375 return (counter == 2);
379 void HUD::Runway::drawArrow()
381 SGGeod acPos(SGGeod::fromDeg(
382 fgGetDouble("/position/longitude-deg"),
383 fgGetDouble("/position/latitude-deg")));
384 float theta = SGGeodesy::courseDeg(acPos, _runway->geod());
385 theta -= fgGetDouble("/orientation/heading-deg");
387 glMatrixMode(GL_MODELVIEW);
389 glTranslated((_right + _left) / 2.0, (_top + _bottom) / 2.0, 0.0);
390 glRotated(theta, 0.0, 0.0, 1.0);
391 glTranslated(0.0, _arrow_radius, 0.0);
392 glScaled(_arrow_scale, _arrow_scale, 0.0);
394 glBegin(GL_TRIANGLES);
395 glVertex2d(-5.0, 12.5);
396 glVertex2d(0.0, 25.0);
397 glVertex2d(5.0, 12.5);
401 glVertex2d(-2.5, 0.0);
402 glVertex2d(-2.5, 12.5);
403 glVertex2d(2.5, 12.5);
404 glVertex2d(2.5, 0.0);
410 void HUD::Runway::setLineWidth()
412 //Calculate the distance from the runway, A
413 SGGeod acPos(SGGeod::fromDeg(
414 fgGetDouble("/position/longitude-deg"),
415 fgGetDouble("/position/latitude-deg")));
416 double distance = SGGeodesy::distanceNm(acPos, _runway->geod());
417 //Get altitude above runway, B
418 double alt_nm = _agl->getDoubleValue();
420 if (_hud->getUnits() == FEET)
421 alt_nm *= SG_FEET_TO_METER;
423 alt_nm *= SG_METER_TO_NM;
425 //Calculate distance away from runway, C = v(A≤+B≤)
426 distance = sqrt(alt_nm * alt_nm + distance*distance);
427 if (distance < _scale_dist)
428 glLineWidth(1.0 + ((_line_scale - 1) * ((_scale_dist - distance) / _scale_dist)));