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