Src/DasherCore/DasherButtons.cpp

   1 // DasherButtons.cpp, build a set of boxes for Button Dasher.
   2 // Copyright 2005, Chris Ball and David MacKay.  GPL.
   3
   4 // Idea - should back off button always just undo the previous 'forwards' button?
   5
   6 #include "../Common/Common.h"
   7
   8
   9 #include "DasherButtons.h"
  10 #include <valarray>
  11 #include <iostream>
  12
  13 // Track memory leaks on Windows to the line that new'd the memory
  14 #ifdef _WIN32
  15 #ifdef _DEBUG
  16 #define DEBUG_NEW new( _NORMAL_BLOCK, THIS_FILE, __LINE__ )
  17 #define new DEBUG_NEW
  18 #undef THIS_FILE
  19 static char THIS_FILE[] = __FILE__;
  20 #endif
  21 #endif
  22
  23 static SModuleSettings sSettings[] = {
  24   {LP_ZOOMSTEPS, T_LONG, 1, 63, 1, 1, "Zoom steps"},
  25   {LP_RIGHTZOOM, T_LONG, 1024, 10240, 1024, 1024, "Right zoom"},
  26   {LP_B, T_LONG, 2, 10, 1, 1, "Number of boxes"},
  27   {LP_S, T_LONG, 0, 256, 1, 1, "Safety margin"},
  28   {LP_R, T_LONG, -400, 400, 1, 10, "Box non-uniformity"},
  29   {BP_GLOBAL_KEYBOARD, T_BOOL, -1, -1, -1, -1, "Global keyboard grab"}
  30 };
  31
  32 // FIXME - should compass mode be made a separate class?
  33
  34 CDasherButtons::CDasherButtons(Dasher::CEventHandler * pEventHandler, CSettingsStore *pSettingsStore, CDasherInterfaceBase *pInterface, int iNumBoxes, int iStyle, bool bMenu, long long int iID, const char *szName)
  35   : CInputFilter(pEventHandler, pSettingsStore, pInterface, iID, 1, szName) {
  36
  37   m_pBoxes = 0;
  38
  39   m_iNumBoxes = iNumBoxes;
  40   m_iStyle = iStyle;
  41   m_bMenu = bMenu;
  42
  43   m_pSettingsStore = pSettingsStore;
  44
  45   m_bDecorationChanged = true;
  46
  47   SetupBoxes();
  48 }
  49
  50 CDasherButtons::~CDasherButtons()
  51 {
  52   delete[] m_pBoxes;
  53 }
  54
  55 void CDasherButtons::SetupBoxes()
  56 {
  57
  58     int iDasherY(GetLongParameter(LP_MAX_Y));
  59
  60
  61   if(m_iStyle == 3) {
  62     // Alternating direct mode
  63
  64     m_pBoxes = new SBoxInfo[5];
  65
  66     // Fast boxes
  67
  68     m_pBoxes[0].iTop = 0;
  69     m_pBoxes[0].iBottom = 1000;
  70     m_pBoxes[1].iTop = 3096;
  71     m_pBoxes[1].iBottom = 4096;
  72
  73     // Slow boxes
  74
  75     m_pBoxes[2].iTop = 0;
  76     m_pBoxes[2].iBottom = 3096;
  77     m_pBoxes[3].iTop = 1000;
  78     m_pBoxes[3].iBottom = 4096;
  79
  80     m_pBoxes[0].iDisplayTop = m_pBoxes[0].iTop;
  81     m_pBoxes[0].iDisplayBottom = m_pBoxes[0].iBottom;
  82     m_pBoxes[1].iDisplayTop = m_pBoxes[1].iTop;
  83     m_pBoxes[1].iDisplayBottom = m_pBoxes[1].iBottom;
  84     m_pBoxes[2].iDisplayTop = m_pBoxes[2].iTop;
  85     m_pBoxes[2].iDisplayBottom = m_pBoxes[2].iBottom;
  86     m_pBoxes[3].iDisplayTop = m_pBoxes[3].iTop;
  87     m_pBoxes[3].iDisplayBottom = m_pBoxes[3].iBottom;
  88
  89     m_iNumBoxes = 5;
  90     m_pBoxes[m_iNumBoxes-1].iDisplayTop = 0;
  91     m_pBoxes[m_iNumBoxes-1].iDisplayBottom = iDasherY;
  92
  93     m_pBoxes[m_iNumBoxes-1].iTop = int(- iDasherY / 2);
  94     m_pBoxes[m_iNumBoxes-1].iBottom = int(iDasherY * 1.5);
  95
  96     m_iLastBox = -1;
  97
  98   }
  99   else if(m_iStyle == 2) { // Compass mode
 100     m_pBoxes = new SBoxInfo[4];
 101
 102     iTargetWidth = iDasherY * 1024 / GetLongParameter(LP_RIGHTZOOM);
 103
 104     // FIXME - need to relate these to cross-hair position as stored in the parameters
 105
 106     // Not sure whether this is at all the right algorithm here - need to check
 107
 108     m_pBoxes[1].iTop = (2048 - iTargetWidth / 2);
 109     m_pBoxes[1].iBottom = 4096 - m_pBoxes[1].iTop;
 110
 111     // Make this the inverse of the right zoom option
 112
 113     m_pBoxes[3].iTop = -2048 *  m_pBoxes[1].iTop / (2048 -  m_pBoxes[1].iTop);
 114     m_pBoxes[3].iBottom = 4096 - m_pBoxes[3].iTop;
 115
 116     m_pBoxes[0].iTop = -iTargetWidth;
 117     m_pBoxes[0].iBottom = iDasherY - iTargetWidth;
 118     m_pBoxes[2].iTop = iTargetWidth;
 119     m_pBoxes[2].iBottom = iDasherY + iTargetWidth;
 120
 121     m_pBoxes[0].iDisplayTop = m_pBoxes[0].iTop;
 122     m_pBoxes[0].iDisplayBottom = m_pBoxes[0].iBottom;
 123     m_pBoxes[1].iDisplayTop = m_pBoxes[1].iTop;
 124     m_pBoxes[1].iDisplayBottom = m_pBoxes[1].iBottom;
 125     m_pBoxes[2].iDisplayTop = m_pBoxes[2].iTop;
 126     m_pBoxes[2].iDisplayBottom = m_pBoxes[2].iBottom;
 127     m_pBoxes[3].iDisplayTop = m_pBoxes[3].iTop;
 128     m_pBoxes[3].iDisplayBottom = m_pBoxes[3].iBottom;
 129
 130   }
 131   else {
 132
 133     if((m_iStyle == 1) || (m_iStyle == 0))
 134       m_iNumBoxes = GetLongParameter(LP_B) + 1; // One extra box for backoff
 135
 136     if(m_pBoxes) {
 137       delete[] m_pBoxes;
 138       m_pBoxes = 0;
 139     }
 140
 141     m_pBoxes = new SBoxInfo[m_iNumBoxes];
 142     int iForwardBoxes(m_iNumBoxes - 1);
 143
 144     // Calculate the sizes of non-uniform boxes using standard
 145     // geometric progression results
 146
 147     double dRatio;
 148     double dNorm;
 149
 150     // FIXME - implement this using DJCM's integer method?
 151     // See ~mackay/dasher/buttons/
 152     dRatio = pow(129/127.0, -static_cast<double>(GetLongParameter(LP_R)));
 153
 154     if(m_bMenu) {
 155
 156       double dMaxSize;
 157       if(dRatio == 1.0)
 158         dMaxSize = iDasherY / static_cast<double>(iForwardBoxes);
 159       else
 160         dMaxSize = ((dRatio - 1)/(pow(dRatio, iForwardBoxes) - 1)) * iDasherY;
 161
 162       double dMin(0.0);
 163       double dMax;
 164
 165       for(int i(0); i < m_iNumBoxes - 1; ++i) { // One button reserved for backoff
 166         dMax = dMin + dMaxSize * pow(dRatio, i);
 167
 168 //       m_pBoxes[i].iDisplayTop = (i * iDasherY) / (m_iNumBoxes - 1);
 169 //       m_pBoxes[i].iDisplayBottom = ((i+1) * iDasherY) / (m_iNumBoxes - 1);
 170
 171         m_pBoxes[i].iDisplayTop = static_cast<int>(dMin);
 172         m_pBoxes[i].iDisplayBottom = static_cast<int>(dMax);
 173
 174         m_pBoxes[i].iTop = m_pBoxes[i].iDisplayTop - GetLongParameter(LP_S);
 175         m_pBoxes[i].iBottom = m_pBoxes[i].iDisplayBottom + GetLongParameter(LP_S);
 176
 177         dMin = dMax;
 178       }
 179
 180     }
 181     else {
 182       if(m_iNumBoxes == 2+1) { // Special case for two forwards buttons
 183         dNorm = 1+dRatio;
 184
 185         m_pBoxes[0].iDisplayTop = 0;
 186         m_pBoxes[0].iDisplayBottom = int( (1 / dNorm) * iDasherY );
 187
 188         m_pBoxes[1].iDisplayTop = int( (1 / dNorm) * iDasherY );
 189         m_pBoxes[1].iDisplayBottom = iDasherY;
 190       }
 191       else {
 192         int iForwardsButtons(m_iNumBoxes - 1);
 193         bool bEven(iForwardsButtons % 2 == 0);
 194
 195         int iGeometricTerms;
 196
 197         if(bEven)
 198           iGeometricTerms = iForwardsButtons / 2;
 199         else
 200           iGeometricTerms = (1+iForwardsButtons) / 2;
 201
 202         double dMaxSize;
 203
 204         if(dRatio == 1.0) {
 205           dMaxSize = iDasherY / iForwardsButtons;
 206         }
 207         else {
 208           if(bEven)
 209             dMaxSize = iDasherY * (dRatio - 1) / (2 * (pow(dRatio, iGeometricTerms) - 1));
 210           else
 211             dMaxSize = iDasherY * (dRatio - 1) / (2 * (pow(dRatio, iGeometricTerms) - 1) - (dRatio - 1));
 212         }
 213
 214         double dMin;
 215         double dMax;
 216
 217         if(bEven)
 218           dMin = iDasherY / 2;
 219         else
 220           dMin = (iDasherY - dMaxSize)/2;
 221
 222         int iUpBase;
 223         int iDownBase;
 224
 225         if(bEven) {
 226           iUpBase = iForwardsButtons / 2;
 227           iDownBase = iUpBase - 1;
 228         }
 229         else {
 230           iUpBase = (iForwardsButtons - 1)/ 2;
 231           iDownBase = iUpBase;
 232         }
 233
 234         for(int i(0); i < iGeometricTerms; ++i) { // One button reserved for backoff
 235           dMax = dMin + dMaxSize * pow(dRatio, i);
 236
 237           m_pBoxes[iUpBase + i].iDisplayTop = int(dMin);
 238           m_pBoxes[iUpBase + i].iDisplayBottom = int(dMax);
 239
 240           m_pBoxes[iDownBase - i].iDisplayTop = int(iDasherY - dMax);
 241           m_pBoxes[iDownBase - i].iDisplayBottom = int(iDasherY - dMin);
 242
 243           dMin = dMax;
 244         }
 245       }
 246     }
 247
 248     for(int i(0); i < m_iNumBoxes - 1; ++i) {
 249       m_pBoxes[i].iTop = m_pBoxes[i].iDisplayTop - GetLongParameter(LP_S);
 250       m_pBoxes[i].iBottom = m_pBoxes[i].iDisplayBottom + GetLongParameter(LP_S);
 251     }
 252
 253     m_pBoxes[m_iNumBoxes-1].iDisplayTop = 0;
 254     m_pBoxes[m_iNumBoxes-1].iDisplayBottom = iDasherY;
 255
 256     m_pBoxes[m_iNumBoxes-1].iTop = int(- iDasherY / 2);
 257     m_pBoxes[m_iNumBoxes-1].iBottom = int(iDasherY * 1.5);
 258   }
 259
 260   iActiveBox = 0;
 261   m_bDecorationChanged = true;
 262 }
 263
 264 bool CDasherButtons::DecorateView(CDasherView *pView) {
 265   if(m_iStyle == 2) {
 266     CDasherScreen *pScreen(pView->Screen());
 267
 268     int iPos(2048 - iTargetWidth / 2);
 269
 270     bool bFirst(true);
 271
 272     while(iPos >= 0) {
 273       CDasherScreen::point p[2];
 274
 275       myint iDasherX;
 276       myint iDasherY;
 277
 278       iDasherX = -100;
 279       iDasherY = iPos;
 280
 281       pView->Dasher2Screen(iDasherX, iDasherY, p[0].x, p[0].y);
 282
 283       iDasherX = -1000;
 284       iDasherY = iPos;
 285
 286       pView->Dasher2Screen(iDasherX, iDasherY, p[1].x, p[1].y);
 287
 288       if(bFirst)
 289         pScreen->Polyline(p, 2, 1, 1);
 290       else
 291         pScreen->Polyline(p, 2, 1, 2);
 292
 293       iDasherX = -100;
 294       iDasherY = 4096 - iPos;
 295
 296       pView->Dasher2Screen(iDasherX, iDasherY, p[0].x, p[0].y);
 297
 298       iDasherX = -1000;
 299       iDasherY = 4096 - iPos;
 300
 301       pView->Dasher2Screen(iDasherX, iDasherY, p[1].x, p[1].y);
 302
 303       if(bFirst)
 304         pScreen->Polyline(p, 2, 1, 1);
 305       else
 306         pScreen->Polyline(p, 2, 1, 2);
 307
 308       iPos -= iTargetWidth;
 309       bFirst = false;
 310     }
 311   }
 312   else if(m_iStyle == 3) {
 313     if(m_iLastBox == 1) {
 314       pView->NewDrawGoTo(m_pBoxes[2].iDisplayTop, m_pBoxes[2].iDisplayBottom, false);
 315       pView->NewDrawGoTo(m_pBoxes[1].iDisplayTop, m_pBoxes[3].iDisplayBottom, false);
 316       pView->NewDrawGoTo(m_pBoxes[4].iDisplayTop, m_pBoxes[4].iDisplayBottom, false);
 317     }
 318     else {
 319       pView->NewDrawGoTo(m_pBoxes[0].iDisplayTop, m_pBoxes[0].iDisplayBottom, false);
 320       pView->NewDrawGoTo(m_pBoxes[3].iDisplayTop, m_pBoxes[1].iDisplayBottom, false);
 321       pView->NewDrawGoTo(m_pBoxes[4].iDisplayTop, m_pBoxes[4].iDisplayBottom, false);
 322     }
 323   }
 324   else {
 325     for(int i(0); i < m_iNumBoxes; ++i) {
 326       if(i != iActiveBox)
 327         pView->NewDrawGoTo(m_pBoxes[i].iDisplayTop, m_pBoxes[i].iDisplayBottom, false);
 328     }
 329     pView->NewDrawGoTo(m_pBoxes[iActiveBox].iDisplayTop, m_pBoxes[iActiveBox].iDisplayBottom, m_bMenu || m_bHighlight);
 330   }
 331
 332   bool bRV(m_bDecorationChanged);
 333   m_bDecorationChanged = false;
 334   return bRV;
 335 }
 336
 337
 338 void CDasherButtons::KeyDown(int iTime, int iId, CDasherModel *pModel, CUserLog *pUserLog) {
 339
 340   if(m_bMenu) {
 341     switch(iId) {
 342     case 1:
 343     case 4:
 344       m_bDecorationChanged = true;
 345       ++iActiveBox;
 346       if(iActiveBox == m_iNumBoxes)
 347         iActiveBox = 0;
 348        break;
 349     case 2:
 350     case 3:
 351       m_bDecorationChanged = true;
 352       pModel->ScheduleZoom((m_pBoxes[iActiveBox].iBottom - m_pBoxes[iActiveBox].iTop)/2, (m_pBoxes[iActiveBox].iBottom + m_pBoxes[iActiveBox].iTop)/2);
 353       if(iActiveBox != m_iNumBoxes-1)
 354         iActiveBox = 0;
 355       break;
 356     }
 357   }
 358   else {
 359     if(m_iStyle == 3) {
 360       switch(iId) {
 361       case 2:
 362         if(m_iLastBox == 1)
 363           pModel->ScheduleZoom((m_pBoxes[2].iBottom - m_pBoxes[2].iTop)/2, (m_pBoxes[2].iBottom + m_pBoxes[2].iTop)/2);
 364         else
 365           pModel->ScheduleZoom((m_pBoxes[0].iBottom - m_pBoxes[0].iTop)/2, (m_pBoxes[0].iBottom + m_pBoxes[0].iTop)/2);
 366         m_iLastBox = 1;
 367         break;
 368       case 3:
 369       case 4:
 370         if(m_iLastBox == 2)
 371           pModel->ScheduleZoom((m_pBoxes[3].iBottom - m_pBoxes[3].iTop)/2, (m_pBoxes[3].iBottom + m_pBoxes[3].iTop)/2);
 372         else
 373           pModel->ScheduleZoom((m_pBoxes[1].iBottom - m_pBoxes[1].iTop)/2, (m_pBoxes[1].iBottom + m_pBoxes[1].iTop)/2);
 374         m_iLastBox = 2;
 375         break;
 376       case 1:
 377         pModel->ScheduleZoom((m_pBoxes[4].iBottom - m_pBoxes[4].iTop)/2, (m_pBoxes[4].iBottom + m_pBoxes[4].iTop)/2);
 378         break;
 379       }
 380     }
 381     else {
 382       if(iId == 100) // Ignore mouse events
 383         return;
 384       if(iId == 1)
 385         iActiveBox = m_iNumBoxes - 1;
 386       else if(iId <= m_iNumBoxes)
 387         iActiveBox = iId-2;
 388       else
 389         iActiveBox = m_iNumBoxes-2;
 390
 391       m_iLastTime = iTime;
 392
 393       pModel->ScheduleZoom((m_pBoxes[iActiveBox].iBottom - m_pBoxes[iActiveBox].iTop)/2, (m_pBoxes[iActiveBox].iBottom + m_pBoxes[iActiveBox].iTop)/2);
 394     }
 395   }
 396
 397 }
 398
 399 bool CDasherButtons::Timer(int Time, CDasherView *m_pDasherView, CDasherModel *m_pDasherModel, Dasher::VECTOR_SYMBOL_PROB *pAdded, int *pNumDeleted) {
 400   bool m_bOldHighlight(m_bHighlight);
 401   m_bHighlight = (Time - m_iLastTime < 200);
 402
 403   if(m_bOldHighlight != m_bHighlight)
 404     m_bDecorationChanged = true;
 405
 406   return m_pDasherModel->Tap_on_display(0, 0, Time, pAdded, pNumDeleted);
 407 }
 408
 409 void CDasherButtons::HandleEvent(Dasher::CEvent * pEvent) {
 410   if(pEvent->m_iEventType == 1) {
 411     Dasher::CParameterNotificationEvent * pEvt(static_cast < Dasher::CParameterNotificationEvent * >(pEvent));
 412
 413     switch (pEvt->m_iParameter) {
 414     case LP_B:
 415     case LP_RIGHTZOOM:
 416     case LP_R:
 417       // Delibarate fallthrough
 418       SetupBoxes();
 419       break;
 420     }
 421   }
 422 }
 423
 424 bool CDasherButtons::GetSettings(SModuleSettings **pSettings, int *iCount) {
 425   *pSettings = sSettings;
 426   *iCount = sizeof(sSettings) / sizeof(SModuleSettings);
 427
 428   return true;
 429 };