Src/DasherCore/DasherView.h

   1 // DasherView.h
   2 //
   3 // Copyright (c) 2001-2005 David Ward
   4
   5 #ifndef __DasherView_h_
   6 #define __DasherView_h_
   7
   8 namespace Dasher {
   9   class CDasherScreen;
  10   class CDasherModel;
  11   class CDasherInput;
  12   class CDasherComponent;
  13   class CDasherView;
  14 }
  15
  16 #include "DasherTypes.h"
  17 #include "DasherComponent.h"
  18
  19
  20 // CDasherView is an abstract view class
  21 // See the CDasherViewSquare class for an example
  22
  23 // DJW 200504 - at the moment its quite hard work to plug in a new view
  24
  25 ////// \brief View base class.
  26 ////// Dasher views represent the visualisation of a Dasher model on the screen.
  27 ////// Note that we really should aim to avoid having to try and keep
  28 /// multiple pointers to the same object (model etc.) up-to-date at
  29 /// once. We should be able to avoid the need for this just by being
  30 /// sane about passing pointers as arguments to the relevant
  31 /// functions, for example we could pass a pointer to the canvas every
  32 /// time we call the render routine, rather than worrying about
  33 /// notifying this object every time it changes. The same logic can be
  34 /// applied in several other places.
  35 ///
  36 /// We should also attempt to try and remove the need for this class
  37 /// to know about the model. When we call render we should just pass a
  38 /// pointer to the root node, which we can obtain elsewhere, and make
  39 /// sure that the data structure contains all the info we need to do
  40 /// the rendering (eg make sure it contains strings as well as symbol
  41 /// IDs).
  42 ////// There are really three roles played by CDasherView: providing high
  43 /// level drawing functions, providing a mapping between Dasher
  44 /// co-ordinates and screen co-ordinates and providing a mapping
  45 /// between true and effective Dasher co-ordinates (eg for eyetracking
  46 /// mode). We should probably consider creating separate classes for
  47 /// these.
  48
  49 class Dasher::CDasherView:public CDasherComponent
  50 {
  51 public:
  52
  53   ///
  54   /// \param pEventHandler Pointer to the event handler
  55   /// \param pSettingsStore Pointer to the settings store
  56   /// \param DasherScreen Pointer to the CDasherScreen object used to do rendering
  57   /// \param DasherModel Reference to the CDasherModel which is to be represented
  58
  59   CDasherView(CEventHandler * pEventHandler, CSettingsStore * pSettingsStore, CDasherScreen * DasherScreen, CDasherModel * DasherModel);
  60   virtual ~ CDasherView() {
  61   }
  62   ////// Event handler
  63   /// \param pEvent Pointer to incoming event
  64   virtual void HandleEvent(Dasher::CEvent * pEvent);
  65
  66   /// \deprecated Use parameter interface instead
  67
  68   void ChangeOrientation(Dasher::Opts::ScreenOrientations Orientation);
  69
  70   virtual bool CheckForNewRoot() {};
  71
  72   //void SetDrawKeyboard(bool bDrawKeyboard);
  73
  74   // 0 - no box, 1 - upper box, 2 - lower box
  75   //void SetDrawMousePosBox(int MousePosBox);
  76
  77   /// Render the display
  78
  79   virtual void Render();
  80
  81   /// Renders Dasher with mouse-dependent items
  82   /// \todo Clarify relationship between Render functions and probably only expose one
  83
  84   virtual bool Render(int iMouseX, int iMouseY, bool bRedrawDisplay);
  85
  86   /// Renders the Dasher node structure
  87   /// \todo Shouldn't be public?
  88
  89   virtual void RenderNodes() = 0;
  90
  91   /// Translates the screen coordinates to Dasher coordinates and calls
  92   /// dashermodel.TapOnDisplay
  93
  94   virtual void TapOnDisplay(screenint mousex, screenint mousey, unsigned long Time, VECTOR_SYMBOL_PROB* pAdded = NULL, int* pNumDeleted = NULL)=0;
  95
  96   /// Dasher Click Mode
  97
  98   virtual void ClickTo(int x, int y, int width, int height) = 0;
  99
 100   /// Handles start-on-mouse behaviour - check whether we are in the box, and change box or start on timer,.
 101   /// \param iTime Current time in ms.
 102
 103   virtual bool HandleStartOnMouse(int iTime) = 0;
 104
 105   /// translates the screen coordinates to Dasher coordinates and calls
 106   /// dashermodel.GoTo
 107
 108   virtual void GoTo(screenint mousex, screenint mousey) = 0;
 109
 110   /// Change the screen - must be called if the Screen is replaced or resized
 111   /// \param NewScreen Pointer to the new CDasherScreen.
 112
 113   virtual void ChangeScreen(CDasherScreen * NewScreen);
 114
 115   /// Get autocallibration offset
 116   /// \retval Current offset
 117
 118   virtual int GetAutoOffset() const {
 119     return 0;
 120   }
 121   ////// \todo Document this
 122   virtual void DrawGoTo(screenint mousex, screenint mousey) = 0;
 123
 124   /// Draw the mouse cursor
 125   /// \todo Probably shouldn't be public
 126
 127   virtual void DrawMouse(screenint mousex, screenint mousey) = 0;
 128
 129   /// Draw the mouse line
 130   /// \todo Probably shouldn't be public
 131
 132   virtual void DrawMouseLine(screenint mousex, screenint mousey) = 0;
 133
 134   /// \todo Document this
 135
 136   virtual void DrawKeyboard() = 0;
 137
 138   /// \todo Document this
 139
 140   virtual void DrawMousePosBox();
 141
 142   /// Draw the game mode pointer
 143
 144   virtual void DrawGameModePointer() = 0;
 145
 146   ///
 147   /// Return a reference to the model
 148
 149   CDasherModel * DasherModel() {
 150     return m_pDasherModel;
 151   }
 152
 153   /// \todo Erm...
 154
 155   const CDasherModel * DasherModel() const {
 156     return m_pDasherModel;
 157   }
 158   ////// Return a reference to the screen
 159
 160   CDasherScreen * Screen() {
 161     return m_pScreen;
 162   }
 163
 164   /// Request the Screen to copy its buffer to the Display
 165   /// \todo Shouldn't be public?
 166
 167   void Display();
 168
 169   /// \todo Document this
 170
 171   virtual void ResetSum() {
 172   }
 173
 174   /// \todo Document this
 175
 176   virtual void ResetSumCounter() {
 177   }
 178
 179   /// \todo Document this
 180
 181   virtual void ResetYAutoOffset() {
 182   }
 183
 184   /// Set the input device class. Note that this class will now assume ownership of the pointer, ie it will delete the object when it's done with it.
 185   /// \param _pInput Pointer to the new CDasherInput.
 186
 187   void SetInput(CDasherInput * _pInput);
 188
 189   /// Get the co-ordinates from the input device
 190   /// \todo This shouldn't be public?
 191
 192   int GetCoordinates(int iN, myint * pCoordinates);
 193
 194   /// Get the co-ordinate count from the input device
 195
 196   int GetCoordinateCount();
 197
 198 protected:
 199   // Orientation of Dasher Screen
 200   inline void MapScreen(screenint * DrawX, screenint * DrawY);
 201   inline void UnMapScreen(screenint * DrawX, screenint * DrawY);
 202
 203 private:
 204   CDasherScreen * m_pScreen;    // provides the graphics (text, lines, rectangles):
 205   CDasherModel * m_pDasherModel; // Model view represents
 206   CDasherInput *m_pInput;       // Input device abstraction
 207
 208   // Pure virtuals to implement
 209   virtual void Crosshair(myint sx) = 0; // Tells m_Screen to draw a crosshair - or other static decoration
 210 };
 211
 212 #include "DasherView.inl"
 213
 214 #endif /* #ifndef __DasherView_h_ */