src/Instrumentation/HUD/HUD_runway.cxx

   1 // HUD_runway.cxx -- An instrument that renders a virtual runway on the HUD
   2 //
   3 // Written by Aaron Wilson & Phillip Merritt, Nov 2004.
   4 //
   5 // Copyright (C) 2004 Aaron Wilson, Aaron.I.Wilson@nasa.gov
   6 // Copyright (C) 2004 Phillip Merritt, Phillip.M.Merritt@nasa.gov
   7 //
   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.
  12 //
  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.
  17 //
  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.
  21
  22 #ifdef HAVE_CONFIG_H
  23 #  include <config.h>
  24 #endif
  25
  26 #include <simgear/compiler.h>
  27 #include <simgear/math/sg_geodesy.hxx>
  28 #include <simgear/math/polar3d.hxx>
  29 #include <osg/GLU>
  30
  31 #include <Main/globals.hxx>
  32 #include <Scenery/scenery.hxx>
  33 #include <Aircraft/aircraft.hxx>
  34 #include <Aircraft/controls.hxx>
  35 #include <FDM/flight.hxx>
  36 #include <Environment/environment.hxx>
  37 #include <Environment/environment_mgr.hxx>
  38 #include <Main/viewer.hxx>
  39 #include <Main/viewmgr.hxx>
  40 #include <ATCDCL/ATCutils.hxx>
  41
  42 #include "HUD.hxx"
  43
  44
  45 HUD::Runway::Runway(HUD *hud, const SGPropertyNode *node, float x, float y) :
  46     Item(hud, node, x, y),
  47     _agl(fgGetNode("/position/altitude-agl-ft", true)),
  48     _arrow_scale(node->getDoubleValue("arrow-scale", 1.0)),
  49     _arrow_radius(node->getDoubleValue("arrow-radius")),
  50     _line_scale(node->getDoubleValue("line-scale", 1.0)),
  51     _scale_dist(node->getDoubleValue("scale-dist-nm")),
  52     _default_pitch(fgGetDouble("/sim/view[0]/config/pitch-pitch-deg", 0.0)),
  53     _default_heading(fgGetDouble("/sim/view[0]/config/pitch-heading-deg", 0.0)),
  54     _cockpit_view(globals->get_viewmgr()->get_view(0)),
  55     _stipple_out(node->getIntValue("outer_stipple", 0xFFFF)),
  56     _stipple_center(node->getIntValue("center-stipple", 0xFFFF)),
  57     _draw_arrow(_arrow_scale > 0 ? true : false),
  58     _draw_arrow_always(_arrow_scale > 0 ? node->getBoolValue("arrow-always") : false)
  59 {
  60     _view[0] = 0;
  61     _view[1] = 0;
  62     _view[2] = 640;
  63     _view[3] = 480;
  64
  65     _center_x = _view[2] / 2;
  66     _center_y = _view[3] / 2;
  67
  68     _left = _center_x - (_w / 2) + _x;
  69     _right = _center_x + (_w / 2) + _x;
  70     _bottom = _center_y - (_h / 2) + _y;
  71     _top = _center_y + (_h / 2) + _y;
  72 }
  73
  74
  75 void HUD::Runway::draw()
  76 {
  77     if (!get_active_runway(_runway))
  78         return;
  79
  80     glPushAttrib(GL_LINE_STIPPLE | GL_LINE_STIPPLE_PATTERN | GL_LINE_WIDTH);
  81     float modelView[4][4], projMat[4][4];
  82     bool anyLines;
  83     //Get the current view
  84     FGViewer* curr_view = globals->get_viewmgr()->get_current_view();
  85     int curr_view_id = globals->get_viewmgr()->get_current();
  86     double gpo = curr_view->getGoalPitchOffset_deg();
  87     double gho = curr_view->getGoalHeadingOffset_deg();
  88     double po = curr_view->getPitchOffset_deg();
  89     double ho = curr_view->getHeadingOffset_deg();
  90
  91     double yaw = -(_cockpit_view->getHeadingOffset_deg() - _default_heading) * SG_DEGREES_TO_RADIANS;
  92     double pitch = (_cockpit_view->getPitchOffset_deg() - _default_pitch) * SG_DEGREES_TO_RADIANS;
  93     //double roll = fgGetDouble("/sim/view[0]/config/roll-offset-deg",0.0) //TODO: adjust for default roll offset
  94     double sPitch = sin(pitch), cPitch = cos(pitch),
  95            sYaw = sin(yaw), cYaw = cos(yaw);
  96
  97     //Assuming that the "Cockpit View" is always at position zero!!!
  98     if (curr_view_id != 0) {
  99         globals->get_viewmgr()->set_view(0);
 100         globals->get_viewmgr()->copyToCurrent();
 101     }
 102     //Set the camera to the cockpit view to get the view of the runway from the cockpit
 103     // OSGFIXME
 104 //     ssgSetCamera((sgVec4 *)_cockpit_view->get_VIEW());
 105     get_rwy_points(_points3d);
 106     //Get the current project matrix
 107     // OSGFIXME
 108 //     ssgGetProjectionMatrix(projMat);
 109 //    const sgVec4 *viewMat = globals->get_current_view()->get_VIEW();
 110     //Get the current model view matrix (cockpit view)
 111     // OSGFIXME
 112 //     ssgGetModelviewMatrix(modelView);
 113     //Create a rotation matrix to correct for any offsets (other than default offsets) to the model view matrix
 114     sgMat4 xy; //rotation about the Rxy, negate the sin's on Ry
 115     xy[0][0] = cYaw,         xy[1][0] = 0.0f,   xy[2][0] = -sYaw,        xy[3][0] = 0.0f;
 116     xy[0][1] = sPitch*-sYaw, xy[1][1] = cPitch, xy[2][1] = -sPitch*cYaw, xy[3][1] = 0.0f;
 117     xy[0][2] = cPitch*sYaw,  xy[1][2] = sPitch, xy[2][2] = cPitch*cYaw,  xy[3][2] = 0.0f;
 118     xy[0][3] = 0.0f,         xy[1][3] = 0.0f,   xy[2][3] = 0.0f,         xy[3][3] = 1.0f;
 119     //Re-center the model view
 120     sgPostMultMat4(modelView,xy);
 121     //copy float matrices to double
 122     for (int i = 0; i < 4; i++) {
 123         for (int j = 0; j < 4; j++) {
 124             int idx = (i * 4) + j;
 125             _mm[idx] = (double)modelView[i][j];
 126             _pm[idx] = (double)projMat[i][j];
 127         }
 128     }
 129
 130     //Calculate the 2D points via gluProject
 131     int result = GL_TRUE;
 132     for (int i = 0; i < 6; i++) {
 133         result = gluProject(_points3d[i][0], _points3d[i][1], _points3d[i][2], _mm,
 134                 _pm, _view, &_points2d[i][0], &_points2d[i][1], &_points2d[i][2]);
 135     }
 136     //set the line width based on our distance from the runway
 137     setLineWidth();
 138     //Draw the runway lines on the HUD
 139     glEnable(GL_LINE_STIPPLE);
 140     glLineStipple(1, _stipple_out);
 141     anyLines =
 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
 146
 147     glLineStipple(1, _stipple_center);
 148     anyLines |= drawLine(_points3d[5], _points3d[4], _points2d[5], _points2d[4]); //draw center
 149
 150     //Check to see if arrow needs drawn
 151     if ((!anyLines && _draw_arrow) || _draw_arrow_always) {
 152         drawArrow(); //draw indication arrow
 153     }
 154
 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);
 163     }
 164     //Set the camera back to the current view
 165     // OSGFIXME
 166 //     ssgSetCamera((sgVec4 *)curr_view);
 167     glPopAttrib();
 168 }
 169
 170
 171 bool HUD::Runway::get_active_runway(FGRunway& runway)
 172 {
 173     FGEnvironment stationweather =
 174             ((FGEnvironmentMgr *)globals->get_subsystem("environment"))->getEnvironment();
 175     double hdg = stationweather.get_wind_from_heading_deg();
 176     return globals->get_runways()->search(fgGetString("/sim/presets/airport-id"), int(hdg), &runway);
 177 }
 178
 179
 180 void HUD::Runway::get_rwy_points(sgdVec3 *_points3d)
 181 {
 182     double alt = current_aircraft.fdm_state->get_Runway_altitude() * SG_FEET_TO_METER;
 183     double length = (_runway._length / 2.0) * SG_FEET_TO_METER;
 184     double width = (_runway._width / 2.0) * SG_FEET_TO_METER;
 185     double frontLat, frontLon, backLat, backLon,az, tempLat, tempLon;
 186
 187     geo_direct_wgs_84(alt, _runway._lat, _runway._lon, _runway._heading, length, &backLat, &backLon, &az);
 188     sgGeodToCart(backLat * SG_DEGREES_TO_RADIANS, backLon * SG_DEGREES_TO_RADIANS, alt, _points3d[4]);
 189
 190     geo_direct_wgs_84(alt, _runway._lat, _runway._lon, _runway._heading + 180, length, &frontLat, &frontLon, &az);
 191     sgGeodToCart(frontLat * SG_DEGREES_TO_RADIANS, frontLon * SG_DEGREES_TO_RADIANS, alt, _points3d[5]);
 192
 193     geo_direct_wgs_84(alt, backLat, backLon, _runway._heading + 90, width, &tempLat, &tempLon, &az);
 194     sgGeodToCart(tempLat * SG_DEGREES_TO_RADIANS, tempLon * SG_DEGREES_TO_RADIANS, alt, _points3d[0]);
 195
 196     geo_direct_wgs_84(alt, backLat, backLon, _runway._heading - 90, width, &tempLat, &tempLon, &az);
 197     sgGeodToCart(tempLat * SG_DEGREES_TO_RADIANS, tempLon * SG_DEGREES_TO_RADIANS, alt, _points3d[1]);
 198
 199     geo_direct_wgs_84(alt, frontLat, frontLon, _runway._heading - 90, width, &tempLat, &tempLon, &az);
 200     sgGeodToCart(tempLat * SG_DEGREES_TO_RADIANS, tempLon * SG_DEGREES_TO_RADIANS, alt, _points3d[2]);
 201
 202     geo_direct_wgs_84(alt, frontLat, frontLon, _runway._heading + 90, width, &tempLat, &tempLon, &az);
 203     sgGeodToCart(tempLat * SG_DEGREES_TO_RADIANS, tempLon * SG_DEGREES_TO_RADIANS, alt, _points3d[3]);
 204 }
 205
 206
 207 bool HUD::Runway::drawLine(const sgdVec3& a1, const sgdVec3& a2, const sgdVec3& point1, const sgdVec3& point2)
 208 {
 209     sgdVec3 p1, p2;
 210     sgdCopyVec3(p1, point1);
 211     sgdCopyVec3(p2, point2);
 212     bool p1Inside = (p1[0] >= _left && p1[0] <= _right && p1[1] >= _bottom && p1[1] <= _top);
 213     bool p1Insight = (p1[2] >= 0.0 && p1[2] < 1.0);
 214     bool p1Valid = p1Insight && p1Inside;
 215     bool p2Inside = (p2[0] >= _left && p2[0] <= _right && p2[1] >= _bottom && p2[1] <= _top);
 216     bool p2Insight = (p2[2] >= 0.0 && p2[2] < 1.0);
 217     bool p2Valid = p2Insight && p2Inside;
 218
 219     if (p1Valid && p2Valid) { //Both project points are valid, draw the line
 220         glBegin(GL_LINES);
 221         glVertex2d(p1[0],p1[1]);
 222         glVertex2d(p2[0],p2[1]);
 223         glEnd();
 224
 225     } else if (p1Valid) { //p1 is valid and p2 is not, calculate a new valid point
 226         sgdVec3 vec = {a2[0] - a1[0], a2[1] - a1[1], a2[2] - a1[2]};
 227         //create the unit vector
 228         sgdScaleVec3(vec, 1.0 / sgdLengthVec3(vec));
 229         sgdVec3 newPt;
 230         sgdCopyVec3(newPt, a1);
 231         sgdAddVec3(newPt, vec);
 232         if (gluProject(newPt[0], newPt[1], newPt[2], _mm, _pm, _view, &p2[0], &p2[1], &p2[2])
 233                 && (p2[2] > 0 && p2[2] < 1.0)) {
 234             boundPoint(p1, p2);
 235             glBegin(GL_LINES);
 236             glVertex2d(p1[0], p1[1]);
 237             glVertex2d(p2[0], p2[1]);
 238             glEnd();
 239         }
 240
 241     } else if (p2Valid) { //p2 is valid and p1 is not, calculate a new valid point
 242         sgdVec3 vec = {a1[0] - a2[0], a1[1] - a2[1], a1[2] - a2[2]};
 243         //create the unit vector
 244         sgdScaleVec3(vec, 1.0 / sgdLengthVec3(vec));
 245         sgdVec3 newPt;
 246         sgdCopyVec3(newPt, a2);
 247         sgdAddVec3(newPt, vec);
 248         if (gluProject(newPt[0], newPt[1], newPt[2], _mm, _pm, _view, &p1[0], &p1[1], &p1[2])
 249                 && (p1[2] > 0 && p1[2] < 1.0)) {
 250             boundPoint(p2, p1);
 251             glBegin(GL_LINES);
 252             glVertex2d(p2[0], p2[1]);
 253             glVertex2d(p1[0], p1[1]);
 254             glEnd();
 255         }
 256
 257     } else if (p1Insight && p2Insight) { //both points are insight, but not inside
 258         bool v = boundOutsidePoints(p1, p2);
 259         if (v) {
 260             glBegin(GL_LINES);
 261                 glVertex2d(p1[0], p1[1]);
 262                 glVertex2d(p2[0], p2[1]);
 263             glEnd();
 264         }
 265         return v;
 266     }
 267     //else both points are not insight, don't draw anything
 268     return (p1Valid && p2Valid);
 269 }
 270
 271
 272 void HUD::Runway::boundPoint(const sgdVec3& v, sgdVec3& m)
 273 {
 274     double y = v[1];
 275     if (m[1] < v[1])
 276         y = _bottom;
 277     else if (m[1] > v[1])
 278         y = _top;
 279
 280     if (m[0] == v[0]) {
 281         m[1] = y;
 282         return;  //prevent divide by zero
 283     }
 284
 285     double slope = (m[1] - v[1]) / (m[0] - v[0]);
 286     m[0] = (y - v[1]) / slope + v[0];
 287     m[1] = y;
 288
 289     if (m[0] < _left) {
 290         m[0] = _left;
 291         m[1] = slope * (_left - v[0]) + v[1];
 292
 293     } else if (m[0] > _right) {
 294         m[0] = _right;
 295         m[1] = slope * (_right - v[0]) + v[1];
 296     }
 297 }
 298
 299
 300 bool HUD::Runway::boundOutsidePoints(sgdVec3& v, sgdVec3& m)
 301 {
 302     bool pointsInvalid = (v[1] > _top && m[1] > _top) ||
 303                          (v[1] < _bottom && m[1] < _bottom) ||
 304                          (v[0] > _right && m[0] > _right) ||
 305                          (v[0] < _left && m[0] < _left);
 306     if (pointsInvalid)
 307         return false;
 308
 309     if (m[0] == v[0]) {//x's are equal, vertical line
 310         if (m[1] > v[1]) {
 311             m[1] = _top;
 312             v[1] = _bottom;
 313         } else {
 314             v[1] = _top;
 315             m[1] = _bottom;
 316         }
 317         return true;
 318     }
 319
 320     if (m[1] == v[1]) { //y's are equal, horizontal line
 321         if (m[0] > v[0]) {
 322             m[0] = _right;
 323             v[0] = _left;
 324         } else {
 325             v[0] = _right;
 326             m[0] = _left;
 327         }
 328         return true;
 329     }
 330
 331     double slope = (m[1] - v[1]) / (m[0] - v[0]);
 332     double b = v[1] - (slope * v[0]);
 333     double y1 = slope * _left + b;
 334     double y2 = slope * _right + b;
 335     double x1 = (_bottom - b) / slope;
 336     double x2 = (_top - b) / slope;
 337     int counter = 0;
 338
 339     if (y1 >= _bottom && y1 <= _top) {
 340         v[0] = _left;
 341         v[1] = y1;
 342         counter++;
 343     }
 344
 345     if (y2 >= _bottom && y2 <= _top) {
 346         if (counter > 0) {
 347             m[0] = _right;
 348             m[1] = y2;
 349         } else {
 350             v[0] = _right;
 351             v[1] = y2;
 352         }
 353         counter++;
 354     }
 355
 356     if (x1 >= _left && x1 <= _right) {
 357         if (counter > 0) {
 358             m[0] = x1;
 359             m[1] = _bottom;
 360         } else {
 361             v[0] = x1;
 362             v[1] = _bottom;
 363         }
 364         counter++;
 365     }
 366
 367     if (x2 >= _left && x2 <= _right) {
 368         m[0] = x1;
 369         m[1] = _bottom;
 370         counter++;
 371     }
 372     return (counter == 2);
 373 }
 374
 375
 376 void HUD::Runway::drawArrow()
 377 {
 378     Point3D ac(0.0), rwy(0.0);
 379     ac.setlat(current_aircraft.fdm_state->get_Latitude_deg());
 380     ac.setlon(current_aircraft.fdm_state->get_Longitude_deg());
 381     rwy.setlat(_runway._lat);
 382     rwy.setlon(_runway._lon);
 383     float theta = GetHeadingFromTo(ac, rwy);
 384     theta -= fgGetDouble("/orientation/heading-deg");
 385     theta = -theta;
 386     glMatrixMode(GL_MODELVIEW);
 387     glPushMatrix();
 388     glTranslated((_right + _left) / 2.0, (_top + _bottom) / 2.0, 0.0);
 389     glRotated(theta, 0.0, 0.0, 1.0);
 390     glTranslated(0.0, _arrow_radius, 0.0);
 391     glScaled(_arrow_scale, _arrow_scale, 0.0);
 392
 393     glBegin(GL_TRIANGLES);
 394     glVertex2d(-5.0, 12.5);
 395     glVertex2d(0.0, 25.0);
 396     glVertex2d(5.0, 12.5);
 397     glEnd();
 398
 399     glBegin(GL_QUADS);
 400     glVertex2d(-2.5, 0.0);
 401     glVertex2d(-2.5, 12.5);
 402     glVertex2d(2.5, 12.5);
 403     glVertex2d(2.5, 0.0);
 404     glEnd();
 405     glPopMatrix();
 406 }
 407
 408
 409 void HUD::Runway::setLineWidth()
 410 {
 411     //Calculate the distance from the runway, A
 412     double course, distance;
 413     calc_gc_course_dist(Point3D(_runway._lon * SGD_DEGREES_TO_RADIANS,
 414             _runway._lat * SGD_DEGREES_TO_RADIANS, 0.0),
 415             Point3D(current_aircraft.fdm_state->get_Longitude(),
 416             current_aircraft.fdm_state->get_Latitude(), 0.0 ),
 417             &course, &distance);
 418     distance *= SG_METER_TO_NM;
 419     //Get altitude above runway, B
 420     double alt_nm = _agl->getDoubleValue();
 421
 422     if (_hud->getUnits() == FEET)
 423         alt_nm *= SG_FEET_TO_METER;
 424
 425     alt_nm *= SG_METER_TO_NM;
 426
 427     //Calculate distance away from runway, C = v(A²+B²)
 428     distance = sqrt(alt_nm * alt_nm + distance*distance);
 429     if (distance < _scale_dist)
 430         glLineWidth(1.0 + ((_line_scale - 1) * ((_scale_dist - distance) / _scale_dist)));
 431     else
 432         glLineWidth(1.0);
 433
 434 }
 435
 436