include/wx/graphics.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/graphics.h
   3 // Purpose:     graphics context header
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // Created:
   7 // Copyright:   (c) Stefan Csomor
   8 // RCS-ID:      $Id$
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_GRAPHICS_H_
  13 #define _WX_GRAPHICS_H_
  14
  15 #include "wx/geometry.h"
  16 #include "wx/dynarray.h"
  17
  18 class WXDLLEXPORT wxWindowDC;
  19
  20 #if wxUSE_GRAPHICS_CONTEXT
  21
  22 /*
  23  * notes about the graphics context apis
  24  *
  25  * angles : are measured in radians, 0.0 being in direction of positiv x axis, PI/2 being
  26  * in direction of positive y axis.
  27  */
  28
  29 class WXDLLEXPORT wxGraphicsPath
  30 {
  31 public :
  32     wxGraphicsPath() {}
  33     virtual ~wxGraphicsPath() {}
  34
  35     //
  36     // These are the path primitives from which everything else can be constructed
  37     //
  38
  39     // begins a new subpath at (x,y)
  40     virtual void MoveToPoint( wxDouble x, wxDouble y ) = 0;
  41
  42     // adds a straight line from the current point to (x,y)
  43     virtual void AddLineToPoint( wxDouble x, wxDouble y ) = 0;
  44
  45     // adds a cubic Bezier curve from the current point, using two control points and an end point
  46     virtual void AddCurveToPoint( wxDouble cx1, wxDouble cy1, wxDouble cx2, wxDouble cy2, wxDouble x, wxDouble y ) = 0;
  47
  48     // closes the current sub-path
  49     virtual void CloseSubpath() = 0;
  50
  51     // gets the last point of the current path, (0,0) if not yet set
  52     virtual void GetCurrentPoint( wxDouble& x, wxDouble&y) = 0;
  53
  54     // adds an arc of a circle centering at (x,y) with radius (r) from startAngle to endAngle
  55     virtual void AddArc( wxDouble x, wxDouble y, wxDouble r, wxDouble startAngle, wxDouble endAngle, bool clockwise ) = 0;
  56
  57     //
  58     // These are convenience functions which - if not available natively will be assembled
  59     // using the primitives from above
  60     //
  61
  62     // adds a quadratic Bezier curve from the current point, using a control point and an end point
  63     virtual void AddQuadCurveToPoint( wxDouble cx, wxDouble cy, wxDouble x, wxDouble y );
  64
  65     // appends a rectangle as a new closed subpath
  66     virtual void AddRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h );
  67
  68     // appends an ellipsis as a new closed subpath fitting the passed rectangle
  69     virtual void AddCircle( wxDouble x, wxDouble y, wxDouble r );
  70
  71     // draws a an arc to two tangents connecting (current) to (x1,y1) and (x1,y1) to (x2,y2), also a straight line from (current) to (x1,y1)
  72     virtual void AddArcToPoint( wxDouble x1, wxDouble y1 , wxDouble x2, wxDouble y2, wxDouble r ) ;
  73
  74     // wrappers using wxPoint2DDoubles
  75
  76     wxPoint2DDouble GetCurrentPoint();
  77
  78     void MoveToPoint( const wxPoint2DDouble& p);
  79
  80     void AddLineToPoint( const wxPoint2DDouble& p);
  81
  82     void AddCurveToPoint( const wxPoint2DDouble& c1, const wxPoint2DDouble& c2, const wxPoint2DDouble& e);
  83
  84     void AddArc( const wxPoint2DDouble& c, wxDouble r, wxDouble startAngle, wxDouble endAngle, bool clockwise);
  85
  86     DECLARE_NO_COPY_CLASS(wxGraphicsPath)
  87 };
  88
  89 /*
  90 class WXDLLEXPORT wxGraphicsMatrix
  91 {
  92 public :
  93         wxGraphicsMatrix() {}
  94
  95         virtual ~wxGraphicsMatrix() {}
  96
  97         wxGraphicsMatrix* Concat( const wxGraphicsMatrix *t ) const;
  98
  99         // returns the inverse matrix
 100         wxGraphicsMatrix* Invert() const;
 101
 102         // returns true if the elements of the transformation matrix are equal ?
 103     bool operator==(const wxGraphicsMatrix& t) const;
 104
 105         // return true if this is the identity matrix
 106         bool IsIdentity();
 107
 108     //
 109     // transformation
 110     //
 111
 112     // translate
 113     virtual void Translate( wxDouble dx , wxDouble dy ) = 0;
 114
 115     // scale
 116     virtual void Scale( wxDouble xScale , wxDouble yScale ) = 0;
 117
 118     // rotate (radians)
 119     virtual void Rotate( wxDouble angle ) = 0;
 120 } ;
 121 */
 122
 123 class WXDLLEXPORT wxGraphicsContext
 124 {
 125 public:
 126     wxGraphicsContext() {}
 127
 128     virtual ~wxGraphicsContext() {}
 129
 130     static wxGraphicsContext* Create( const wxWindowDC& dc) ;
 131
 132     static wxGraphicsContext* CreateFromNative( void * context ) ;
 133
 134 #ifdef __WXMAC__
 135     static wxGraphicsContext* CreateFromNativeWindow( void * window ) ;
 136 #endif
 137     static wxGraphicsContext* Create( wxWindow* window ) ;
 138
 139     // creates a path instance that corresponds to the type of graphics context, ie GDIPlus, cairo, CoreGraphics ...
 140     virtual wxGraphicsPath * CreatePath() = 0;
 141
 142         /*
 143         // create a 'native' matrix corresponding to these values
 144         virtual wxGraphicsMatrix* CreateMatrix( wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0,
 145                 wxDouble tx=0.0, wxDouble ty=0.0) = 0;
 146         */
 147
 148     // push the current state of the context, ie the transformation matrix on a stack
 149     virtual void PushState() = 0;
 150
 151     // pops a stored state from the stack
 152     virtual void PopState() = 0;
 153
 154     // clips drawings to the region, combined to current clipping region
 155     virtual void Clip( const wxRegion &region ) = 0;
 156
 157     // clips drawings to the rect
 158     virtual void Clip( wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
 159
 160         // resets the clipping to original extent
 161         virtual void ResetClip() = 0 ;
 162
 163         // returns the native context
 164         virtual void * GetNativeContext() = 0;
 165
 166     //
 167     // transformation : changes the current transformation matrix CTM of the context
 168     //
 169
 170     // translate
 171     virtual void Translate( wxDouble dx , wxDouble dy ) = 0;
 172
 173     // scale
 174     virtual void Scale( wxDouble xScale , wxDouble yScale ) = 0;
 175
 176     // rotate (radians)
 177     virtual void Rotate( wxDouble angle ) = 0;
 178
 179     //
 180     // setting the paint
 181     //
 182
 183     // sets the pan
 184     virtual void SetPen( const wxPen &pen ) = 0;
 185
 186     // sets the brush for filling
 187     virtual void SetBrush( const wxBrush &brush ) = 0;
 188
 189     // sets the brush to a linear gradient, starting at (x1,y1) with color c1 to (x2,y2) with color c2
 190     virtual void SetLinearGradientBrush( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2,
 191         const wxColour&c1, const wxColour&c2) = 0;
 192
 193     // sets the brush to a radial gradient originating at (xo,yc) with color oColor and ends on a circle around (xc,yc)
 194     // with radius r and color cColor
 195     virtual void SetRadialGradientBrush( wxDouble xo, wxDouble yo, wxDouble xc, wxDouble yc, wxDouble radius,
 196         const wxColour &oColor, const wxColour &cColor) = 0;
 197
 198     // sets the font
 199     virtual void SetFont( const wxFont &font ) = 0;
 200
 201     // sets the text color
 202     virtual void SetTextColor( const wxColour &col ) = 0;
 203
 204     // strokes along a path with the current pen
 205     virtual void StrokePath( const wxGraphicsPath *path ) = 0;
 206
 207     // fills a path with the current brush
 208     virtual void FillPath( const wxGraphicsPath *path, int fillStyle = wxWINDING_RULE ) = 0;
 209
 210     // draws a path by first filling and then stroking
 211     virtual void DrawPath( const wxGraphicsPath *path, int fillStyle = wxWINDING_RULE );
 212
 213     //
 214     // text
 215     //
 216
 217     virtual void DrawText( const wxString &str, wxDouble x, wxDouble y ) = 0;
 218
 219     virtual void DrawText( const wxString &str, wxDouble x, wxDouble y, wxDouble angle );
 220
 221     virtual void GetTextExtent( const wxString &text, wxDouble *width, wxDouble *height,
 222         wxDouble *descent, wxDouble *externalLeading ) const  = 0;
 223
 224     virtual void GetPartialTextExtents(const wxString& text, wxArrayDouble& widths) const = 0;
 225
 226     //
 227     // image support
 228     //
 229
 230     virtual void DrawBitmap( const wxBitmap &bmp, wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
 231
 232     virtual void DrawIcon( const wxIcon &icon, wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
 233
 234     //
 235     // convenience methods
 236     //
 237
 238     // strokes a single line
 239     virtual void StrokeLine( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2);
 240
 241     // stroke lines connecting each of the points
 242     virtual void StrokeLines( size_t n, const wxPoint2DDouble *points);
 243
 244     // stroke disconnected lines from begin to end points
 245     virtual void StrokeLines( size_t n, const wxPoint2DDouble *beginPoints, const wxPoint2DDouble *endPoints);
 246
 247     // draws a polygon
 248     virtual void DrawLines( size_t n, const wxPoint2DDouble *points, int fillStyle = wxWINDING_RULE );
 249
 250     // draws a polygon
 251     virtual void DrawRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h);
 252
 253     // draws an ellipse
 254     virtual void DrawEllipse( wxDouble x, wxDouble y, wxDouble w, wxDouble h);
 255
 256     // draws a rounded rectangle
 257     virtual void DrawRoundedRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h, wxDouble radius);
 258
 259      // wrappers using wxPoint2DDouble TODO
 260
 261     DECLARE_NO_COPY_CLASS(wxGraphicsContext)
 262 };
 263
 264 #ifdef __WXMAC__
 265 #define wxGCDC wxDC
 266 #endif
 267
 268 class WXDLLEXPORT wxGCDC:
 269 #ifdef __WXMAC__
 270         public wxDCBase
 271 #else
 272         public wxDC
 273 #endif
 274 {
 275     DECLARE_DYNAMIC_CLASS(wxGCDC)
 276     DECLARE_NO_COPY_CLASS(wxGCDC)
 277
 278 public:
 279     wxGCDC(const wxWindowDC& dc);
 280     wxGCDC();
 281     virtual ~wxGCDC();
 282
 283     void Init();
 284
 285
 286     // implement base class pure virtuals
 287     // ----------------------------------
 288
 289     virtual void Clear();
 290
 291     virtual bool StartDoc( const wxString& WXUNUSED(message) ) { return true; }
 292     virtual void EndDoc(void) {}
 293
 294     virtual void StartPage(void) {}
 295     virtual void EndPage(void) {}
 296
 297     virtual void SetFont(const wxFont& font);
 298     virtual void SetPen(const wxPen& pen);
 299     virtual void SetBrush(const wxBrush& brush);
 300     virtual void SetBackground(const wxBrush& brush);
 301     virtual void SetBackgroundMode(int mode);
 302     virtual void SetPalette(const wxPalette& palette);
 303
 304     virtual void DestroyClippingRegion();
 305
 306     virtual wxCoord GetCharHeight() const;
 307     virtual wxCoord GetCharWidth() const;
 308
 309     virtual bool CanDrawBitmap() const;
 310     virtual bool CanGetTextExtent() const;
 311     virtual int GetDepth() const;
 312     virtual wxSize GetPPI() const;
 313
 314     virtual void SetMapMode(int mode);
 315     virtual void SetUserScale(double x, double y);
 316
 317     virtual void SetLogicalScale(double x, double y);
 318     virtual void SetLogicalOrigin(wxCoord x, wxCoord y);
 319     virtual void SetDeviceOrigin(wxCoord x, wxCoord y);
 320     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
 321     virtual void SetLogicalFunction(int function);
 322
 323     virtual void SetTextForeground(const wxColour& colour);
 324     virtual void SetTextBackground(const wxColour& colour);
 325
 326     virtual void ComputeScaleAndOrigin();
 327
 328     wxGraphicsContext* GetGraphicsContext() { return m_graphicContext; }
 329     virtual void SetGraphicsContext( wxGraphicsContext* ctx )
 330                 { delete m_graphicContext; m_graphicContext = ctx; }
 331 protected:
 332     // the true implementations
 333     virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
 334         int style = wxFLOOD_SURFACE);
 335
 336     virtual void DoGradientFillLinear(const wxRect& rect,
 337         const wxColour& initialColour,
 338         const wxColour& destColour,
 339         wxDirection nDirection = wxEAST);
 340
 341     virtual void DoGradientFillConcentric(const wxRect& rect,
 342         const wxColour& initialColour,
 343         const wxColour& destColour,
 344         const wxPoint& circleCenter);
 345
 346     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const;
 347
 348     virtual void DoDrawPoint(wxCoord x, wxCoord y);
 349
 350 #if wxUSE_SPLINES
 351     virtual void DoDrawSpline(wxList *points);
 352 #endif
 353
 354     virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
 355
 356     virtual void DoDrawArc(wxCoord x1, wxCoord y1,
 357         wxCoord x2, wxCoord y2,
 358         wxCoord xc, wxCoord yc);
 359
 360     virtual void DoDrawCheckMark(wxCoord x, wxCoord y,
 361         wxCoord width, wxCoord height);
 362
 363     virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
 364         double sa, double ea);
 365
 366     virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 367     virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
 368         wxCoord width, wxCoord height,
 369         double radius);
 370     virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 371
 372     virtual void DoCrossHair(wxCoord x, wxCoord y);
 373
 374     virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
 375     virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
 376         bool useMask = false);
 377
 378     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y);
 379     virtual void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
 380         double angle);
 381
 382     virtual bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
 383         wxDC *source, wxCoord xsrc, wxCoord ysrc,
 384         int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1);
 385
 386     virtual void DoGetSize(int *,int *) const;
 387     virtual void DoGetSizeMM(int* width, int* height) const;
 388
 389     virtual void DoDrawLines(int n, wxPoint points[],
 390         wxCoord xoffset, wxCoord yoffset);
 391     virtual void DoDrawPolygon(int n, wxPoint points[],
 392         wxCoord xoffset, wxCoord yoffset,
 393         int fillStyle = wxODDEVEN_RULE);
 394     virtual void DoDrawPolyPolygon(int n, int count[], wxPoint points[],
 395         wxCoord xoffset, wxCoord yoffset,
 396         int fillStyle);
 397
 398     virtual void DoSetClippingRegionAsRegion(const wxRegion& region);
 399     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
 400         wxCoord width, wxCoord height);
 401
 402     virtual void DoGetTextExtent(const wxString& string,
 403         wxCoord *x, wxCoord *y,
 404         wxCoord *descent = NULL,
 405         wxCoord *externalLeading = NULL,
 406         wxFont *theFont = NULL) const;
 407
 408     virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;
 409
 410 protected:
 411     // scaling variables
 412     double       m_mm_to_pix_x, m_mm_to_pix_y;
 413
 414         double m_formerScaleX, m_formerScaleY;
 415
 416     wxGraphicsContext* m_graphicContext;
 417 };
 418
 419 #endif
 420
 421 #endif
 422     // _WX_GRID_H_BASE_