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 SG_GLU_H
  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 <ATC/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     //Get the current tile center
 204     SGVec3d tileCenter = globals->get_scenery()->get_center();
 205     for (int i = 0; i < 6; i++) {
 206         _points3d[i][0] -= tileCenter.x();
 207         _points3d[i][1] -= tileCenter.y();
 208         _points3d[i][2] -= tileCenter.z();
 209     }
 210 }
 211
 212
 213 bool HUD::Runway::drawLine(const sgdVec3& a1, const sgdVec3& a2, const sgdVec3& point1, const sgdVec3& point2)
 214 {
 215     sgdVec3 p1, p2;
 216     sgdCopyVec3(p1, point1);
 217     sgdCopyVec3(p2, point2);
 218     bool p1Inside = (p1[0] >= _left && p1[0] <= _right && p1[1] >= _bottom && p1[1] <= _top);
 219     bool p1Insight = (p1[2] >= 0.0 && p1[2] < 1.0);
 220     bool p1Valid = p1Insight && p1Inside;
 221     bool p2Inside = (p2[0] >= _left && p2[0] <= _right && p2[1] >= _bottom && p2[1] <= _top);
 222     bool p2Insight = (p2[2] >= 0.0 && p2[2] < 1.0);
 223     bool p2Valid = p2Insight && p2Inside;
 224
 225     if (p1Valid && p2Valid) { //Both project points are valid, draw the line
 226         glBegin(GL_LINES);
 227         glVertex2d(p1[0],p1[1]);
 228         glVertex2d(p2[0],p2[1]);
 229         glEnd();
 230
 231     } else if (p1Valid) { //p1 is valid and p2 is not, calculate a new valid point
 232         sgdVec3 vec = {a2[0] - a1[0], a2[1] - a1[1], a2[2] - a1[2]};
 233         //create the unit vector
 234         sgdScaleVec3(vec, 1.0 / sgdLengthVec3(vec));
 235         sgdVec3 newPt;
 236         sgdCopyVec3(newPt, a1);
 237         sgdAddVec3(newPt, vec);
 238         if (gluProject(newPt[0], newPt[1], newPt[2], _mm, _pm, _view, &p2[0], &p2[1], &p2[2])
 239                 && (p2[2] > 0 && p2[2] < 1.0)) {
 240             boundPoint(p1, p2);
 241             glBegin(GL_LINES);
 242             glVertex2d(p1[0], p1[1]);
 243             glVertex2d(p2[0], p2[1]);
 244             glEnd();
 245         }
 246
 247     } else if (p2Valid) { //p2 is valid and p1 is not, calculate a new valid point
 248         sgdVec3 vec = {a1[0] - a2[0], a1[1] - a2[1], a1[2] - a2[2]};
 249         //create the unit vector
 250         sgdScaleVec3(vec, 1.0 / sgdLengthVec3(vec));
 251         sgdVec3 newPt;
 252         sgdCopyVec3(newPt, a2);
 253         sgdAddVec3(newPt, vec);
 254         if (gluProject(newPt[0], newPt[1], newPt[2], _mm, _pm, _view, &p1[0], &p1[1], &p1[2])
 255                 && (p1[2] > 0 && p1[2] < 1.0)) {
 256             boundPoint(p2, p1);
 257             glBegin(GL_LINES);
 258             glVertex2d(p2[0], p2[1]);
 259             glVertex2d(p1[0], p1[1]);
 260             glEnd();
 261         }
 262
 263     } else if (p1Insight && p2Insight) { //both points are insight, but not inside
 264         bool v = boundOutsidePoints(p1, p2);
 265         if (v) {
 266             glBegin(GL_LINES);
 267                 glVertex2d(p1[0], p1[1]);
 268                 glVertex2d(p2[0], p2[1]);
 269             glEnd();
 270         }
 271         return v;
 272     }
 273     //else both points are not insight, don't draw anything
 274     return (p1Valid && p2Valid);
 275 }
 276
 277
 278 void HUD::Runway::boundPoint(const sgdVec3& v, sgdVec3& m)
 279 {
 280     double y = v[1];
 281     if (m[1] < v[1])
 282         y = _bottom;
 283     else if (m[1] > v[1])
 284         y = _top;
 285
 286     if (m[0] == v[0]) {
 287         m[1] = y;
 288         return;  //prevent divide by zero
 289     }
 290
 291     double slope = (m[1] - v[1]) / (m[0] - v[0]);
 292     m[0] = (y - v[1]) / slope + v[0];
 293     m[1] = y;
 294
 295     if (m[0] < _left) {
 296         m[0] = _left;
 297         m[1] = slope * (_left - v[0]) + v[1];
 298
 299     } else if (m[0] > _right) {
 300         m[0] = _right;
 301         m[1] = slope * (_right - v[0]) + v[1];
 302     }
 303 }
 304
 305
 306 bool HUD::Runway::boundOutsidePoints(sgdVec3& v, sgdVec3& m)
 307 {
 308     bool pointsInvalid = (v[1] > _top && m[1] > _top) ||
 309                          (v[1] < _bottom && m[1] < _bottom) ||
 310                          (v[0] > _right && m[0] > _right) ||
 311                          (v[0] < _left && m[0] < _left);
 312     if (pointsInvalid)
 313         return false;
 314
 315     if (m[0] == v[0]) {//x's are equal, vertical line
 316         if (m[1] > v[1]) {
 317             m[1] = _top;
 318             v[1] = _bottom;
 319         } else {
 320             v[1] = _top;
 321             m[1] = _bottom;
 322         }
 323         return true;
 324     }
 325
 326     if (m[1] == v[1]) { //y's are equal, horizontal line
 327         if (m[0] > v[0]) {
 328             m[0] = _right;
 329             v[0] = _left;
 330         } else {
 331             v[0] = _right;
 332             m[0] = _left;
 333         }
 334         return true;
 335     }
 336
 337     double slope = (m[1] - v[1]) / (m[0] - v[0]);
 338     double b = v[1] - (slope * v[0]);
 339     double y1 = slope * _left + b;
 340     double y2 = slope * _right + b;
 341     double x1 = (_bottom - b) / slope;
 342     double x2 = (_top - b) / slope;
 343     int counter = 0;
 344
 345     if (y1 >= _bottom && y1 <= _top) {
 346         v[0] = _left;
 347         v[1] = y1;
 348         counter++;
 349     }
 350
 351     if (y2 >= _bottom && y2 <= _top) {
 352         if (counter > 0) {
 353             m[0] = _right;
 354             m[1] = y2;
 355         } else {
 356             v[0] = _right;
 357             v[1] = y2;
 358         }
 359         counter++;
 360     }
 361
 362     if (x1 >= _left && x1 <= _right) {
 363         if (counter > 0) {
 364             m[0] = x1;
 365             m[1] = _bottom;
 366         } else {
 367             v[0] = x1;
 368             v[1] = _bottom;
 369         }
 370         counter++;
 371     }
 372
 373     if (x2 >= _left && x2 <= _right) {
 374         m[0] = x1;
 375         m[1] = _bottom;
 376         counter++;
 377     }
 378     return (counter == 2);
 379 }
 380
 381
 382 void HUD::Runway::drawArrow()
 383 {
 384     Point3D ac(0.0), rwy(0.0);
 385     ac.setlat(current_aircraft.fdm_state->get_Latitude_deg());
 386     ac.setlon(current_aircraft.fdm_state->get_Longitude_deg());
 387     rwy.setlat(_runway._lat);
 388     rwy.setlon(_runway._lon);
 389     float theta = GetHeadingFromTo(ac, rwy);
 390     theta -= fgGetDouble("/orientation/heading-deg");
 391     theta = -theta;
 392     glMatrixMode(GL_MODELVIEW);
 393     glPushMatrix();
 394     glTranslated((_right + _left) / 2.0, (_top + _bottom) / 2.0, 0.0);
 395     glRotated(theta, 0.0, 0.0, 1.0);
 396     glTranslated(0.0, _arrow_radius, 0.0);
 397     glScaled(_arrow_scale, _arrow_scale, 0.0);
 398
 399     glBegin(GL_TRIANGLES);
 400     glVertex2d(-5.0, 12.5);
 401     glVertex2d(0.0, 25.0);
 402     glVertex2d(5.0, 12.5);
 403     glEnd();
 404
 405     glBegin(GL_QUADS);
 406     glVertex2d(-2.5, 0.0);
 407     glVertex2d(-2.5, 12.5);
 408     glVertex2d(2.5, 12.5);
 409     glVertex2d(2.5, 0.0);
 410     glEnd();
 411     glPopMatrix();
 412 }
 413
 414
 415 void HUD::Runway::setLineWidth()
 416 {
 417     //Calculate the distance from the runway, A
 418     double course, distance;
 419     calc_gc_course_dist(Point3D(_runway._lon * SGD_DEGREES_TO_RADIANS,
 420             _runway._lat * SGD_DEGREES_TO_RADIANS, 0.0),
 421             Point3D(current_aircraft.fdm_state->get_Longitude(),
 422             current_aircraft.fdm_state->get_Latitude(), 0.0 ),
 423             &course, &distance);
 424     distance *= SG_METER_TO_NM;
 425     //Get altitude above runway, B
 426     double alt_nm = _agl->getDoubleValue();
 427
 428     if (_hud->getUnits() == FEET)
 429         alt_nm *= SG_FEET_TO_METER;
 430
 431     alt_nm *= SG_METER_TO_NM;
 432
 433     //Calculate distance away from runway, C = v(A²+B²)
 434     distance = sqrt(alt_nm * alt_nm + distance*distance);
 435     if (distance < _scale_dist)
 436         glLineWidth(1.0 + ((_line_scale - 1) * ((_scale_dist - distance) / _scale_dist)));
 437     else
 438         glLineWidth(1.0);
 439
 440 }
 441
 442