src/Instrumentation/render_area_2d.cxx

   1 // RenderArea2D.cxx - a class to manage 2D polygon-based drawing
   2 //                    for a complex instrument (eg. GPS).
   3 //
   4 // Written by David Luff, started 2005.
   5 //
   6 // Copyright (C) 2005 - David C Luff - daveluff AT ntlworld.com
   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 // $Id$
  23
  24
  25 #ifdef HAVE_CONFIG_H
  26 #  include <config.h>
  27 #endif
  28
  29 #include "render_area_2d.hxx"
  30
  31 RA2DPrimitive::RA2DPrimitive() {
  32     invert = false;
  33     debug = false;
  34 }
  35
  36 RenderArea2D::RenderArea2D(int logx, int logy, int sizex, int sizey, int posx, int posy) {
  37     _logx = logx;
  38     _logy = logy;
  39     _sizex = sizex;
  40     _sizey = sizey;
  41     _posx = posx;
  42     _posy = posy;
  43     _clipx1 = 0;
  44     _clipx2 = _logx - 1;
  45     _clipy1 = 0;
  46     _clipy2 = _logy - 1;
  47
  48     _backgroundColor[0] = 0.0;
  49     _backgroundColor[1] = 0.0;
  50     _backgroundColor[2] = 0.0;
  51     _backgroundColor[3] = 1.0;
  52     _pixelColor[0] = 1.0;
  53     _pixelColor[1] = 0.0;
  54     _pixelColor[2] = 0.0;
  55     _pixelColor[3] = 1.0;
  56
  57     _ra2d_debug = false;
  58 }
  59
  60 void RenderArea2D::draw(osg::State& state) {
  61
  62     static osg::ref_ptr<osg::StateSet> renderArea2DStateSet;
  63     if(!renderArea2DStateSet.valid()) {
  64         renderArea2DStateSet = new osg::StateSet;
  65         renderArea2DStateSet->setTextureMode(0, GL_TEXTURE_2D, osg::StateAttribute::OFF);
  66         renderArea2DStateSet->setMode(GL_LIGHTING, osg::StateAttribute::OFF);
  67     }
  68
  69     state.pushStateSet(renderArea2DStateSet.get());
  70     state.apply();
  71     state.setActiveTextureUnit(0);
  72     state.setClientActiveTextureUnit(0);
  73
  74     // DCL - the 2 lines below are copied verbatim from the hotspot drawing code.
  75     // I am not sure if they are needed here or not.
  76     glPushAttrib(GL_ENABLE_BIT);
  77     glDisable(GL_COLOR_MATERIAL);
  78
  79     // FIXME - disabling all clip planes causes bleed-through through the splash screen.
  80     glDisable(GL_CLIP_PLANE0);
  81     glDisable(GL_CLIP_PLANE1);
  82     glDisable(GL_CLIP_PLANE2);
  83     glDisable(GL_CLIP_PLANE3);
  84
  85     oldDrawBackground();
  86
  87     for(unsigned int i = 0; i < drawing_list.size(); ++i) {
  88         RA2DPrimitive prim = drawing_list[i];
  89         switch(prim.type) {
  90         case RA2D_LINE:
  91             oldDrawLine(prim.x1, prim.y1, prim.x2, prim.y2);
  92             break;
  93         case RA2D_QUAD:
  94             if(prim.debug) {
  95                 //cout << "Clipping = " << _clipx1 << ", " << _clipy1 << " to " << _clipx2 << ", " << _clipy2 << '\n';
  96                 //cout << "Drawing quad " << prim.x1 << ", " << prim.y1 << " to " << prim.x2 << ", " << prim.y2 << '\n';
  97             }
  98             oldDrawQuad(prim.x1, prim.y1, prim.x2, prim.y2, prim.invert);
  99             break;
 100         case RA2D_PIXEL:
 101             oldDrawPixel(prim.x1, prim.y1, prim.invert);
 102             break;
 103         }
 104     }
 105
 106     glPopAttrib();
 107
 108     state.popStateSet();
 109     state.apply();
 110     state.setActiveTextureUnit(0);
 111     state.setClientActiveTextureUnit(0);
 112 }
 113
 114 // Set clipping region in logical units
 115 void RenderArea2D::SetClipRegion(int x1, int y1, int x2, int y2) {
 116     _clipx1 = x1;
 117     _clipx2 = x2;
 118     _clipy1 = y1;
 119     _clipy2 = y2;
 120     //cout << "Set clip region, clip region = "  << _clipx1 << ", " << _clipy1 << " to " << _clipx2 << ", " << _clipy2 << '\n';
 121 }
 122
 123 // Set clip region to be the same as the rendered area (default)
 124 void RenderArea2D::ResetClipRegion() {
 125     _clipx1 = 0;
 126     _clipx2 = _logx - 1;
 127     _clipy1 = 0;
 128     _clipy2 = _logy - 1;
 129     //cout << "Reset clip region, clip region = "  << _clipx1 << ", " << _clipy1 << " to " << _clipx2 << ", " << _clipy2 << '\n';
 130 }
 131
 132 void RenderArea2D::SetPosition(int posx, int posy) {
 133     _posx = posx;
 134     _posy = posy;
 135 }
 136
 137 void RenderArea2D::SetLogicalSize(int logx, int logy) {
 138     _logx = logx;
 139     _logy = logy;
 140 }
 141
 142 void RenderArea2D::SetActualSize(int sizex, int sizey) {
 143     _sizex = sizex;
 144     _sizey = sizey;
 145 }
 146
 147 void RenderArea2D::DrawPixel(int x, int y, bool invert) {
 148     // Clip
 149     if(x < _clipx1 || x > _clipx2 || y < _clipy1 || y > _clipy2) return;
 150
 151     RA2DPrimitive prim;
 152     prim.x1 = x;
 153     prim.y1 = y;
 154     prim.x2 = 0;
 155     prim.y2 = 0;
 156     prim.type = RA2D_PIXEL;
 157     prim.invert = invert;
 158     drawing_list.push_back(prim);
 159 }
 160
 161 void RenderArea2D::oldDrawPixel(int x, int y, bool invert) {
 162     // Clip.  In theory this shouldn't be necessary, since all input is clipped before adding
 163     // to the drawing list, but it ensures that any errors in clipping lines etc will only
 164     // spill over the clip area within the instrument, and still be clipped from straying
 165     // outside the instrument.
 166     if(x < _clipx1 || x > _clipx2 || y < _clipy1 || y > _clipy2) return;
 167
 168     // Scale to position within background
 169     float fx1 = (float)x, fy1 = (float)y;
 170     float rx = (float)_sizex / (float)_logx;
 171     float ry = (float)_sizey / (float)_logy;
 172     fx1 *= rx;
 173     fy1 *= ry;
 174     float fx2 = fx1 + rx;
 175     float fy2 = fy1 + ry;
 176
 177     // Translate to final position
 178     fx1 += (float)_posx;
 179     fx2 += (float)_posx;
 180     fy1 += (float)_posy;
 181     fy2 += (float)_posy;
 182
 183     //cout << "DP: " << fx1 << ", " << fy1 << " ... " << fx2 << ", " << fy2 << '\n';
 184
 185     doSetColor(invert ? _backgroundColor : _pixelColor);
 186     SGVec2f corners[4] = {
 187         SGVec2f(fx1, fy1),
 188         SGVec2f(fx2, fy1),
 189         SGVec2f(fx2, fy2),
 190         SGVec2f(fx1, fy2)
 191     };
 192     doDrawQuad(corners);
 193 }
 194
 195 void RenderArea2D::DrawLine(int x1, int y1, int x2, int y2) {
 196     // We need to clip the line to the current region before storing it in the drawing
 197     // list, since when we come to actually draw it the clip region may have changed.
 198
 199     // Liang-Barsky clipping algorithm
 200     int p[4], q[4];
 201     float u1 = 0.0f, u2 = 1.0f;
 202     p[0] = -(x2 - x1); q[0] = (x1 - _clipx1);
 203     p[1] =  (x2 - x1); q[1] = (_clipx2 - x1);
 204     p[2] = -(y2 - y1); q[2] = (y1 - _clipy1);
 205     p[3] =  (y2 - y1); q[3] = (_clipy2 - y1);
 206
 207     for(int i=0; i<4; ++i) {
 208         if(p[i] == 0) {
 209             if(q[i] < 0) {
 210                 // Then we have a trivial rejection of a line parallel to a clip plane
 211                 // completely outside the clip region.
 212                 return;
 213             }
 214         } else if(p[i] < 0) {
 215             float r = (float)q[i]/(float)p[i];
 216             u1 = (u1 > r ? u1 : r);
 217         } else {        // p[i] > 0
 218             float r = (float)q[i]/(float)p[i];
 219             u2 = (u2 < r ? u2 : r);
 220         }
 221         if(u1 > u2) {
 222             // Then the line is completely outside the clip area.
 223             return;
 224         }
 225     }
 226
 227     float fx1 = x1 + u1 * (float)(x2 - x1);
 228     float fy1 = y1 + u1 * (float)(y2 - y1);
 229     float fx2 = x1 + u2 * (float)(x2 - x1);
 230     float fy2 = y1 + u2 * (float)(y2 - y1);
 231     x1 = (int)(fx1 + 0.5);
 232     y1 = (int)(fy1 + 0.5);
 233     x2 = (int)(fx2 + 0.5);
 234     y2 = (int)(fy2 + 0.5);
 235
 236     RA2DPrimitive prim;
 237     prim.x1 = x1;
 238     prim.y1 = y1;
 239     prim.x2 = x2;
 240     prim.y2 = y2;
 241     prim.type = RA2D_LINE;
 242     prim.invert = false;
 243     drawing_list.push_back(prim);
 244 }
 245
 246 void RenderArea2D::oldDrawLine(int x1, int y1, int x2, int y2) {
 247     // Crude implementation of Bresenham line drawing algorithm.
 248
 249     // Our lines are non directional, so first order the points x-direction-wise to leave only 4 octants to consider.
 250     if(x2 < x1) {
 251         int tmp_x = x1;
 252         int tmp_y = y1;
 253         x1 = x2;
 254         y1 = y2;
 255         x2 = tmp_x;
 256         y2 = tmp_y;
 257     }
 258
 259     bool flip_y = (y1 > y2 ? true : false);
 260     int dx = x2 - x1;
 261     int dy = (flip_y ? y1 - y2 : y2 - y1);
 262     if(dx > dy) {
 263         // push the x dir
 264         int y = y1;
 265         int yn = dx/2;
 266         for(int x=x1; x<=x2; ++x) {
 267             oldDrawPixel(x, y);
 268             yn += dy;
 269             if(yn >= dx) {
 270                 yn -= dx;
 271                 y = (flip_y ? y - 1 : y + 1);
 272             }
 273         }
 274     } else {
 275         // push the y dir
 276         int x = x1;
 277         int xn = dy/2;
 278         // Must be a more elegant way to roll the next two cases into one!
 279         if(flip_y) {
 280             for(int y=y1; y>=y2; --y) {
 281                 oldDrawPixel(x, y);
 282                 xn += dx;
 283                 if(xn >= dy) {
 284                     xn -= dy;
 285                     x++;
 286                 }
 287             }
 288         } else {
 289             for(int y=y1; y<=y2; ++y) {
 290                 oldDrawPixel(x, y);
 291                 xn += dx;
 292                 if(xn >= dy) {
 293                     xn -= dy;
 294                     x++;
 295                 }
 296             }
 297         }
 298     }
 299 }
 300
 301 void RenderArea2D::DrawQuad(int x1, int y1, int x2, int y2, bool invert) {
 302     // Force the input to be ordered with x1 < x2 and y1 < y2.
 303     if(x1 > x2) {
 304         int x = x2;
 305         x2 = x1;
 306         x1 = x;
 307     }
 308     if(y1 > y2) {
 309         int y = y2;
 310         y2 = y1;
 311         y1 = y;
 312     }
 313
 314     // Clip the input to the current drawing region.
 315     x1 = x1 < _clipx1 ? _clipx1 : x1;
 316     if(x1 > _clipx2) { return; }
 317     x2 = x2 > _clipx2 ? _clipx2 : x2;
 318     if(x2 < _clipx1) { return; }
 319     y1 = y1 < _clipy1 ? _clipy1 : y1;
 320     if(y1 > _clipy2) { return; }
 321     y2 = y2 > _clipy2 ? _clipy2 : y2;
 322     if(y2 < _clipy1) { return; }
 323
 324     RA2DPrimitive prim;
 325     prim.x1 = x1;
 326     prim.y1 = y1;
 327     prim.x2 = x2;
 328     prim.y2 = y2;
 329     prim.type = RA2D_QUAD;
 330     prim.invert = invert;
 331     if(_ra2d_debug) prim.debug = true;
 332     drawing_list.push_back(prim);
 333 }
 334
 335 void RenderArea2D::oldDrawQuad(int x1, int y1, int x2, int y2, bool invert) {
 336     // Scale to position within background
 337     float fx1 = (float)x1, fy1 = (float)y1;
 338     float fx2 = (float)x2, fy2 = (float)y2;
 339     float rx = (float)_sizex / (float)_logx;
 340     float ry = (float)_sizey / (float)_logy;
 341     fx1 *= rx;
 342     fy1 *= ry;
 343     fx2 *= rx;
 344     fy2 *= ry;
 345
 346     fx2 += rx;
 347     fy2 += ry;
 348
 349     // Translate to final position
 350     fx1 += (float)_posx;
 351     fx2 += (float)_posx;
 352     fy1 += (float)_posy;
 353     fy2 += (float)_posy;
 354
 355     //cout << "DP: " << fx1 << ", " << fy1 << " ... " << fx2 << ", " << fy2 << '\n';
 356
 357     doSetColor(invert ? _backgroundColor : _pixelColor);
 358     SGVec2f corners[4] = {
 359         SGVec2f(fx1, fy1),
 360         SGVec2f(fx2, fy1),
 361         SGVec2f(fx2, fy2),
 362         SGVec2f(fx1, fy2)
 363     };
 364     doDrawQuad(corners);
 365 }
 366
 367 void RenderArea2D::DrawBackground() {
 368     // TODO
 369 }
 370
 371 void RenderArea2D::oldDrawBackground() {
 372     doSetColor(_backgroundColor);
 373     SGVec2f corners[4] = {
 374         SGVec2f(_posx, _posy),
 375         SGVec2f(_posx + _sizex, _posy),
 376         SGVec2f(_posx + _sizex, _posy + _sizey),
 377         SGVec2f(_posx, _posy + _sizey)
 378     };
 379
 380     doDrawQuad(corners);
 381 }
 382
 383 void RenderArea2D::Flush() {
 384     drawing_list.clear();
 385 }
 386
 387 // -----------------------------------------
 388 //
 389 // Actual drawing routines copied from Atlas
 390 //
 391 // -----------------------------------------
 392
 393 void RenderArea2D::doSetColor( const float *rgba ) {
 394     glMaterialfv(GL_FRONT_AND_BACK, GL_AMBIENT_AND_DIFFUSE, rgba);
 395     glColor4fv( rgba );
 396 }
 397
 398 void RenderArea2D::doDrawQuad( const SGVec2f *p) {
 399     glBegin(GL_QUADS);
 400         glNormal3f(0.0f, 0.0f, 0.0f);
 401         glVertex2fv( p[0].data() );
 402         glVertex2fv( p[1].data() );
 403         glVertex2fv( p[2].data() );
 404         glVertex2fv( p[3].data() );
 405     glEnd();
 406 }
 407
 408 void RenderArea2D::doDrawQuad( const SGVec2f *p, const SGVec4f *color ) {
 409     glBegin(GL_QUADS);
 410         glNormal3f(0.0f, 0.0f, 0.0f);
 411         glColor4fv( color[0].data() ); glVertex2fv( p[0].data() );
 412         glColor4fv( color[1].data() ); glVertex2fv( p[1].data() );
 413         glColor4fv( color[2].data() ); glVertex2fv( p[2].data() );
 414         glColor4fv( color[3].data() ); glVertex2fv( p[3].data() );
 415     glEnd();
 416 }