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/defs.h"
  16
  17 #if wxUSE_GRAPHICS_CONTEXT
  18
  19 #include "wx/geometry.h"
  20 #include "wx/dynarray.h"
  21 #include "wx/dc.h"
  22 #include "wx/vector.h"
  23
  24 enum wxAntialiasMode
  25 {
  26     wxANTIALIAS_NONE, // should be 0
  27     wxANTIALIAS_DEFAULT,
  28 };
  29
  30 enum wxInterpolationQuality
  31 {
  32     // default interpolation
  33     wxINTERPOLATION_DEFAULT,
  34     // no interpolation
  35     wxINTERPOLATION_NONE,
  36     // fast interpolation, suited for interactivity
  37     wxINTERPOLATION_FAST,
  38     // better quality
  39     wxINTERPOLATION_GOOD,
  40     // best quality, not suited for interactivity
  41     wxINTERPOLATION_BEST
  42 };
  43
  44 enum wxCompositionMode
  45 {
  46     // R = Result, S = Source, D = Destination, premultiplied with alpha
  47     // Ra, Sa, Da their alpha components
  48
  49     // classic Porter-Duff compositions
  50     // http://keithp.com/~keithp/porterduff/p253-porter.pdf
  51
  52     wxCOMPOSITION_INVALID = -1, /* indicates invalid/unsupported mode */
  53     wxCOMPOSITION_CLEAR, /* R = 0 */
  54     wxCOMPOSITION_SOURCE, /* R = S */
  55     wxCOMPOSITION_OVER, /* R = S + D*(1 - Sa) */
  56     wxCOMPOSITION_IN, /* R = S*Da */
  57     wxCOMPOSITION_OUT, /* R = S*(1 - Da) */
  58     wxCOMPOSITION_ATOP, /* R = S*Da + D*(1 - Sa) */
  59
  60     wxCOMPOSITION_DEST, /* R = D, essentially a noop */
  61     wxCOMPOSITION_DEST_OVER, /* R = S*(1 - Da) + D */
  62     wxCOMPOSITION_DEST_IN, /* R = D*Sa */
  63     wxCOMPOSITION_DEST_OUT, /* R = D*(1 - Sa) */
  64     wxCOMPOSITION_DEST_ATOP, /* R = S*(1 - Da) + D*Sa */
  65     wxCOMPOSITION_XOR, /* R = S*(1 - Da) + D*(1 - Sa) */
  66
  67     // mathematical compositions
  68     wxCOMPOSITION_ADD /* R = S + D */
  69 };
  70
  71 class WXDLLIMPEXP_FWD_CORE wxWindowDC;
  72 class WXDLLIMPEXP_FWD_CORE wxMemoryDC;
  73 #if wxUSE_PRINTING_ARCHITECTURE
  74 class WXDLLIMPEXP_FWD_CORE wxPrinterDC;
  75 #endif
  76 #ifdef __WXMSW__
  77 #if wxUSE_ENH_METAFILE
  78 class WXDLLIMPEXP_FWD_CORE wxEnhMetaFileDC;
  79 #endif
  80 #endif
  81 class WXDLLIMPEXP_FWD_CORE wxGraphicsContext;
  82 class WXDLLIMPEXP_FWD_CORE wxGraphicsPath;
  83 class WXDLLIMPEXP_FWD_CORE wxGraphicsMatrix;
  84 class WXDLLIMPEXP_FWD_CORE wxGraphicsFigure;
  85 class WXDLLIMPEXP_FWD_CORE wxGraphicsRenderer;
  86 class WXDLLIMPEXP_FWD_CORE wxGraphicsPen;
  87 class WXDLLIMPEXP_FWD_CORE wxGraphicsBrush;
  88 class WXDLLIMPEXP_FWD_CORE wxGraphicsFont;
  89 class WXDLLIMPEXP_FWD_CORE wxGraphicsBitmap;
  90
  91 /*
  92  * notes about the graphics context apis
  93  *
  94  * angles : are measured in radians, 0.0 being in direction of positiv x axis, PI/2 being
  95  * in direction of positive y axis.
  96  */
  97
  98 // Base class of all objects used for drawing in the new graphics API, the always point back to their
  99 // originating rendering engine, there is no dynamic unloading of a renderer currently allowed,
 100 // these references are not counted
 101
 102 //
 103 // The data used by objects like graphics pens etc is ref counted, in order to avoid unnecessary expensive
 104 // duplication. Any operation on a shared instance that results in a modified state, uncouples this
 105 // instance from the other instances that were shared - using copy on write semantics
 106 //
 107
 108 class WXDLLIMPEXP_FWD_CORE wxGraphicsObjectRefData;
 109 class WXDLLIMPEXP_FWD_CORE wxGraphicsMatrixData;
 110 class WXDLLIMPEXP_FWD_CORE wxGraphicsPathData;
 111
 112 class WXDLLIMPEXP_CORE wxGraphicsObject : public wxObject
 113 {
 114 public:
 115     wxGraphicsObject();
 116     wxGraphicsObject( wxGraphicsRenderer* renderer );
 117     virtual ~wxGraphicsObject();
 118
 119     bool IsNull() const;
 120
 121     // returns the renderer that was used to create this instance, or NULL if it has not been initialized yet
 122     wxGraphicsRenderer* GetRenderer() const;
 123     wxGraphicsObjectRefData* GetGraphicsData() const;
 124 protected:
 125     virtual wxObjectRefData* CreateRefData() const;
 126     virtual wxObjectRefData* CloneRefData(const wxObjectRefData* data) const;
 127
 128     DECLARE_DYNAMIC_CLASS(wxGraphicsObject)
 129 };
 130
 131 class WXDLLIMPEXP_CORE wxGraphicsPen : public wxGraphicsObject
 132 {
 133 public:
 134     wxGraphicsPen() {}
 135     virtual ~wxGraphicsPen() {}
 136 private:
 137     DECLARE_DYNAMIC_CLASS(wxGraphicsPen)
 138 };
 139
 140 extern WXDLLIMPEXP_DATA_CORE(wxGraphicsPen) wxNullGraphicsPen;
 141
 142 class WXDLLIMPEXP_CORE wxGraphicsBrush : public wxGraphicsObject
 143 {
 144 public:
 145     wxGraphicsBrush() {}
 146     virtual ~wxGraphicsBrush() {}
 147 private:
 148     DECLARE_DYNAMIC_CLASS(wxGraphicsBrush)
 149 };
 150
 151 extern WXDLLIMPEXP_DATA_CORE(wxGraphicsBrush) wxNullGraphicsBrush;
 152
 153 class WXDLLIMPEXP_CORE wxGraphicsFont : public wxGraphicsObject
 154 {
 155 public:
 156     wxGraphicsFont() {}
 157     virtual ~wxGraphicsFont() {}
 158 private:
 159     DECLARE_DYNAMIC_CLASS(wxGraphicsFont)
 160 };
 161
 162 extern WXDLLIMPEXP_DATA_CORE(wxGraphicsFont) wxNullGraphicsFont;
 163
 164 class WXDLLIMPEXP_CORE wxGraphicsBitmap : public wxGraphicsObject
 165 {
 166 public:
 167     wxGraphicsBitmap() {}
 168     virtual ~wxGraphicsBitmap() {}
 169 private:
 170     DECLARE_DYNAMIC_CLASS(wxGraphicsBitmap)
 171 };
 172
 173 extern WXDLLIMPEXP_DATA_CORE(wxGraphicsBitmap) wxNullGraphicsBitmap;
 174
 175 class WXDLLIMPEXP_CORE wxGraphicsMatrix : public wxGraphicsObject
 176 {
 177 public:
 178     wxGraphicsMatrix() {}
 179
 180     virtual ~wxGraphicsMatrix() {}
 181
 182     // concatenates the matrix
 183     virtual void Concat( const wxGraphicsMatrix *t );
 184     void Concat( const wxGraphicsMatrix &t ) { Concat( &t ); }
 185
 186     // sets the matrix to the respective values
 187     virtual void Set(wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0,
 188         wxDouble tx=0.0, wxDouble ty=0.0);
 189
 190     // gets the component valuess of the matrix
 191     virtual void Get(wxDouble* a=NULL, wxDouble* b=NULL,  wxDouble* c=NULL,
 192                      wxDouble* d=NULL, wxDouble* tx=NULL, wxDouble* ty=NULL) const;
 193
 194     // makes this the inverse matrix
 195     virtual void Invert();
 196
 197     // returns true if the elements of the transformation matrix are equal ?
 198     virtual bool IsEqual( const wxGraphicsMatrix* t) const;
 199     bool IsEqual( const wxGraphicsMatrix& t) const { return IsEqual( &t ); }
 200
 201     // return true if this is the identity matrix
 202     virtual bool IsIdentity() const;
 203
 204     //
 205     // transformation
 206     //
 207
 208     // add the translation to this matrix
 209     virtual void Translate( wxDouble dx , wxDouble dy );
 210
 211     // add the scale to this matrix
 212     virtual void Scale( wxDouble xScale , wxDouble yScale );
 213
 214     // add the rotation to this matrix (radians)
 215     virtual void Rotate( wxDouble angle );
 216
 217     //
 218     // apply the transforms
 219     //
 220
 221     // applies that matrix to the point
 222     virtual void TransformPoint( wxDouble *x, wxDouble *y ) const;
 223
 224     // applies the matrix except for translations
 225     virtual void TransformDistance( wxDouble *dx, wxDouble *dy ) const;
 226
 227     // returns the native representation
 228     virtual void * GetNativeMatrix() const;
 229
 230     const wxGraphicsMatrixData* GetMatrixData() const
 231     { return (const wxGraphicsMatrixData*) GetRefData(); }
 232     wxGraphicsMatrixData* GetMatrixData()
 233     { return (wxGraphicsMatrixData*) GetRefData(); }
 234
 235 private:
 236     DECLARE_DYNAMIC_CLASS(wxGraphicsMatrix)
 237 };
 238
 239 extern WXDLLIMPEXP_DATA_CORE(wxGraphicsMatrix) wxNullGraphicsMatrix;
 240
 241 class WXDLLIMPEXP_CORE wxGraphicsPath : public wxGraphicsObject
 242 {
 243 public:
 244     wxGraphicsPath()  {}
 245     virtual ~wxGraphicsPath() {}
 246
 247     //
 248     // These are the path primitives from which everything else can be constructed
 249     //
 250
 251     // begins a new subpath at (x,y)
 252     virtual void MoveToPoint( wxDouble x, wxDouble y );
 253     void MoveToPoint( const wxPoint2DDouble& p);
 254
 255     // adds a straight line from the current point to (x,y)
 256     virtual void AddLineToPoint( wxDouble x, wxDouble y );
 257     void AddLineToPoint( const wxPoint2DDouble& p);
 258
 259     // adds a cubic Bezier curve from the current point, using two control points and an end point
 260     virtual void AddCurveToPoint( wxDouble cx1, wxDouble cy1, wxDouble cx2, wxDouble cy2, wxDouble x, wxDouble y );
 261     void AddCurveToPoint( const wxPoint2DDouble& c1, const wxPoint2DDouble& c2, const wxPoint2DDouble& e);
 262
 263     // adds another path
 264     virtual void AddPath( const wxGraphicsPath& path );
 265
 266     // closes the current sub-path
 267     virtual void CloseSubpath();
 268
 269     // gets the last point of the current path, (0,0) if not yet set
 270     virtual void GetCurrentPoint( wxDouble* x, wxDouble* y) const;
 271     wxPoint2DDouble GetCurrentPoint() const;
 272
 273     // adds an arc of a circle centering at (x,y) with radius (r) from startAngle to endAngle
 274     virtual void AddArc( wxDouble x, wxDouble y, wxDouble r, wxDouble startAngle, wxDouble endAngle, bool clockwise );
 275     void AddArc( const wxPoint2DDouble& c, wxDouble r, wxDouble startAngle, wxDouble endAngle, bool clockwise);
 276
 277     //
 278     // These are convenience functions which - if not available natively will be assembled
 279     // using the primitives from above
 280     //
 281
 282     // adds a quadratic Bezier curve from the current point, using a control point and an end point
 283     virtual void AddQuadCurveToPoint( wxDouble cx, wxDouble cy, wxDouble x, wxDouble y );
 284
 285     // appends a rectangle as a new closed subpath
 286     virtual void AddRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h );
 287
 288     // appends an ellipsis as a new closed subpath fitting the passed rectangle
 289     virtual void AddCircle( wxDouble x, wxDouble y, wxDouble r );
 290
 291     // appends 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)
 292     virtual void AddArcToPoint( wxDouble x1, wxDouble y1 , wxDouble x2, wxDouble y2, wxDouble r );
 293
 294     // appends an ellipse
 295     virtual void AddEllipse( wxDouble x, wxDouble y, wxDouble w, wxDouble h);
 296
 297     // appends a rounded rectangle
 298     virtual void AddRoundedRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h, wxDouble radius);
 299
 300     // returns the native path
 301     virtual void * GetNativePath() const;
 302
 303     // give the native path returned by GetNativePath() back (there might be some deallocations necessary)
 304     virtual void UnGetNativePath(void *p)const;
 305
 306     // transforms each point of this path by the matrix
 307     virtual void Transform( const wxGraphicsMatrix& matrix );
 308
 309     // gets the bounding box enclosing all points (possibly including control points)
 310     virtual void GetBox(wxDouble *x, wxDouble *y, wxDouble *w, wxDouble *h)const;
 311     wxRect2DDouble GetBox()const;
 312
 313     virtual bool Contains( wxDouble x, wxDouble y, wxPolygonFillMode fillStyle = wxODDEVEN_RULE)const;
 314     bool Contains( const wxPoint2DDouble& c, wxPolygonFillMode fillStyle = wxODDEVEN_RULE)const;
 315
 316     const wxGraphicsPathData* GetPathData() const
 317     { return (const wxGraphicsPathData*) GetRefData(); }
 318     wxGraphicsPathData* GetPathData()
 319     { return (wxGraphicsPathData*) GetRefData(); }
 320
 321 private:
 322     DECLARE_DYNAMIC_CLASS(wxGraphicsPath)
 323 };
 324
 325 extern WXDLLIMPEXP_DATA_CORE(wxGraphicsPath) wxNullGraphicsPath;
 326
 327
 328 // Describes a single gradient stop.
 329 class wxGraphicsGradientStop
 330 {
 331 public:
 332     wxGraphicsGradientStop(wxColour col = wxTransparentColour,
 333                            float pos = 0.)
 334         : m_col(col),
 335           m_pos(pos)
 336     {
 337     }
 338
 339     // default copy ctor, assignment operator and dtor are ok
 340
 341     const wxColour& GetColour() const { return m_col; }
 342     void SetColour(const wxColour& col) { m_col = col; }
 343
 344     float GetPosition() const { return m_pos; }
 345     void SetPosition(float pos)
 346     {
 347         wxASSERT_MSG( pos >= 0 && pos <= 1, "invalid gradient stop position" );
 348
 349         m_pos = pos;
 350     }
 351
 352 private:
 353     // The colour of this gradient band.
 354     wxColour m_col;
 355
 356     // Its starting position: 0 is the beginning and 1 is the end.
 357     float m_pos;
 358 };
 359
 360 // A collection of gradient stops ordered by their positions (from lowest to
 361 // highest). The first stop (index 0, position 0.0) is always the starting
 362 // colour and the last one (index GetCount() - 1, position 1.0) is the end
 363 // colour.
 364 class WXDLLIMPEXP_CORE wxGraphicsGradientStops
 365 {
 366 public:
 367     wxGraphicsGradientStops(wxColour startCol = wxTransparentColour,
 368                             wxColour endCol = wxTransparentColour)
 369     {
 370         // we can't use Add() here as it relies on having start/end stops as
 371         // first/last array elements so do it manually
 372         m_stops.push_back(wxGraphicsGradientStop(startCol, 0.f));
 373         m_stops.push_back(wxGraphicsGradientStop(endCol, 1.f));
 374     }
 375
 376     // default copy ctor, assignment operator and dtor are ok for this class
 377
 378
 379     // Add a stop in correct order.
 380     void Add(const wxGraphicsGradientStop& stop);
 381     void Add(wxColour col, float pos) { Add(wxGraphicsGradientStop(col, pos)); }
 382
 383     // Get the number of stops.
 384     unsigned GetCount() const { return m_stops.size(); }
 385
 386     // Return the stop at the given index (which must be valid).
 387     wxGraphicsGradientStop Item(unsigned n) const { return m_stops.at(n); }
 388
 389     // Get/set start and end colours.
 390     void SetStartColour(wxColour col)
 391         { m_stops[0].SetColour(col); }
 392     wxColour GetStartColour() const
 393         { return m_stops[0].GetColour(); }
 394     void SetEndColour(wxColour col)
 395         { m_stops[m_stops.size() - 1].SetColour(col); }
 396     wxColour GetEndColour() const
 397         { return m_stops[m_stops.size() - 1].GetColour(); }
 398
 399 private:
 400     // All the stops stored in ascending order of positions.
 401     wxVector<wxGraphicsGradientStop> m_stops;
 402 };
 403
 404 class WXDLLIMPEXP_CORE wxGraphicsContext : public wxGraphicsObject
 405 {
 406 public:
 407     wxGraphicsContext(wxGraphicsRenderer* renderer);
 408
 409     virtual ~wxGraphicsContext();
 410
 411     static wxGraphicsContext* Create( const wxWindowDC& dc);
 412     static wxGraphicsContext * Create( const wxMemoryDC& dc);
 413 #if wxUSE_PRINTING_ARCHITECTURE
 414     static wxGraphicsContext * Create( const wxPrinterDC& dc);
 415 #endif
 416 #ifdef __WXMSW__
 417 #if wxUSE_ENH_METAFILE
 418     static wxGraphicsContext * Create( const wxEnhMetaFileDC& dc);
 419 #endif
 420 #endif
 421
 422     static wxGraphicsContext* CreateFromNative( void * context );
 423
 424     static wxGraphicsContext* CreateFromNativeWindow( void * window );
 425
 426     static wxGraphicsContext* Create( wxWindow* window );
 427
 428     // create a context that can be used for measuring texts only, no drawing allowed
 429     static wxGraphicsContext * Create();
 430
 431     // begin a new document (relevant only for printing / pdf etc) if there is a progress dialog, message will be shown
 432     virtual bool StartDoc( const wxString& message );
 433
 434     // done with that document (relevant only for printing / pdf etc)
 435     virtual void EndDoc();
 436
 437     // opens a new page  (relevant only for printing / pdf etc) with the given size in points
 438     // (if both are null the default page size will be used)
 439     virtual void StartPage( wxDouble width = 0, wxDouble height = 0 );
 440
 441     // ends the current page  (relevant only for printing / pdf etc)
 442     virtual void EndPage();
 443
 444     // make sure that the current content of this context is immediately visible
 445     virtual void Flush();
 446
 447     wxGraphicsPath CreatePath() const;
 448
 449     virtual wxGraphicsPen CreatePen(const wxPen& pen) const;
 450
 451     virtual wxGraphicsBrush CreateBrush(const wxBrush& brush ) const;
 452
 453     // sets the brush to a linear gradient, starting at (x1,y1) and ending at
 454     // (x2,y2) with the given boundary colours or the specified stops
 455     wxGraphicsBrush
 456     CreateLinearGradientBrush(wxDouble x1, wxDouble y1,
 457                               wxDouble x2, wxDouble y2,
 458                               const wxColour& c1, const wxColour& c2) const;
 459     wxGraphicsBrush
 460     CreateLinearGradientBrush(wxDouble x1, wxDouble y1,
 461                               wxDouble x2, wxDouble y2,
 462                               const wxGraphicsGradientStops& stops) const;
 463
 464     // sets the brush to a radial gradient originating at (xo,yc) and ending
 465     // on a circle around (xc,yc) with the given radius; the colours may be
 466     // specified by just the two extremes or the full array of gradient stops
 467     wxGraphicsBrush
 468     CreateRadialGradientBrush(wxDouble xo, wxDouble yo,
 469                               wxDouble xc, wxDouble yc, wxDouble radius,
 470                               const wxColour& oColor, const wxColour& cColor) const;
 471
 472     wxGraphicsBrush
 473     CreateRadialGradientBrush(wxDouble xo, wxDouble yo,
 474                               wxDouble xc, wxDouble yc, wxDouble radius,
 475                               const wxGraphicsGradientStops& stops) const;
 476
 477     // sets the font
 478     virtual wxGraphicsFont CreateFont( const wxFont &font , const wxColour &col = *wxBLACK ) const;
 479
 480     // create a native bitmap representation
 481     virtual wxGraphicsBitmap CreateBitmap( const wxBitmap &bitmap ) const;
 482
 483     // create a native bitmap representation
 484     virtual wxGraphicsBitmap CreateSubBitmap( const wxGraphicsBitmap &bitmap, wxDouble x, wxDouble y, wxDouble w, wxDouble h  ) const;
 485
 486     // create a 'native' matrix corresponding to these values
 487     virtual wxGraphicsMatrix CreateMatrix( wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0,
 488         wxDouble tx=0.0, wxDouble ty=0.0) const;
 489
 490     // push the current state of the context, ie the transformation matrix on a stack
 491     virtual void PushState() = 0;
 492
 493     // pops a stored state from the stack
 494     virtual void PopState() = 0;
 495
 496     // clips drawings to the region intersected with the current clipping region
 497     virtual void Clip( const wxRegion &region ) = 0;
 498
 499     // clips drawings to the rect intersected with the current clipping region
 500     virtual void Clip( wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
 501
 502     // resets the clipping to original extent
 503     virtual void ResetClip() = 0;
 504
 505     // returns the native context
 506     virtual void * GetNativeContext() = 0;
 507
 508     // returns the current shape antialiasing mode
 509     virtual wxAntialiasMode GetAntialiasMode() const { return m_antialias; }
 510
 511     // sets the antialiasing mode, returns true if it supported
 512     virtual bool SetAntialiasMode(wxAntialiasMode antialias) = 0;
 513
 514     // returns the current interpolation quality
 515     virtual wxInterpolationQuality GetInterpolationQuality() const { return m_interpolation; }
 516
 517     // sets the interpolation quality, returns true if it supported
 518     virtual bool SetInterpolationQuality(wxInterpolationQuality interpolation) = 0;
 519
 520     // returns the current compositing operator
 521     virtual wxCompositionMode GetCompositionMode() const { return m_composition; }
 522
 523     // sets the compositing operator, returns true if it supported
 524     virtual bool SetCompositionMode(wxCompositionMode op) = 0;
 525
 526     // returns the size of the graphics context in device coordinates
 527     void GetSize(wxDouble* width, wxDouble* height)
 528     {
 529         if ( width )
 530             *width = m_width;
 531         if ( height )
 532             *height = m_height;
 533     }
 534
 535     // returns the resolution of the graphics context in device points per inch
 536     virtual void GetDPI( wxDouble* dpiX, wxDouble* dpiY);
 537
 538 #if 0
 539     // sets the current alpha on this context
 540     virtual void SetAlpha( wxDouble alpha );
 541
 542     // returns the alpha on this context
 543     virtual wxDouble GetAlpha() const;
 544 #endif
 545
 546     // all rendering is done into a fully transparent temporary context
 547     virtual void BeginLayer(wxDouble opacity) = 0;
 548
 549     // composites back the drawings into the context with the opacity given at
 550     // the BeginLayer call
 551     virtual void EndLayer() = 0;
 552
 553     //
 554     // transformation : changes the current transformation matrix CTM of the context
 555     //
 556
 557     // translate
 558     virtual void Translate( wxDouble dx , wxDouble dy ) = 0;
 559
 560     // scale
 561     virtual void Scale( wxDouble xScale , wxDouble yScale ) = 0;
 562
 563     // rotate (radians)
 564     virtual void Rotate( wxDouble angle ) = 0;
 565
 566     // concatenates this transform with the current transform of this context
 567     virtual void ConcatTransform( const wxGraphicsMatrix& matrix ) = 0;
 568
 569     // sets the transform of this context
 570     virtual void SetTransform( const wxGraphicsMatrix& matrix ) = 0;
 571
 572     // gets the matrix of this context
 573     virtual wxGraphicsMatrix GetTransform() const = 0;
 574     //
 575     // setting the paint
 576     //
 577
 578     // sets the pen
 579     virtual void SetPen( const wxGraphicsPen& pen );
 580
 581     void SetPen( const wxPen& pen );
 582
 583     // sets the brush for filling
 584     virtual void SetBrush( const wxGraphicsBrush& brush );
 585
 586     void SetBrush( const wxBrush& brush );
 587
 588     // sets the font
 589     virtual void SetFont( const wxGraphicsFont& font );
 590
 591     void SetFont( const wxFont& font, const wxColour& colour );
 592
 593
 594     // strokes along a path with the current pen
 595     virtual void StrokePath( const wxGraphicsPath& path ) = 0;
 596
 597     // fills a path with the current brush
 598     virtual void FillPath( const wxGraphicsPath& path, wxPolygonFillMode fillStyle = wxODDEVEN_RULE ) = 0;
 599
 600     // draws a path by first filling and then stroking
 601     virtual void DrawPath( const wxGraphicsPath& path, wxPolygonFillMode fillStyle = wxODDEVEN_RULE );
 602
 603     //
 604     // text
 605     //
 606
 607     void DrawText( const wxString &str, wxDouble x, wxDouble y )
 608         { DoDrawText(str, x, y); }
 609
 610     void DrawText( const wxString &str, wxDouble x, wxDouble y, wxDouble angle )
 611         { DoDrawRotatedText(str, x, y, angle); }
 612
 613     void DrawText( const wxString &str, wxDouble x, wxDouble y,
 614                    const wxGraphicsBrush& backgroundBrush )
 615         { DoDrawFilledText(str, x, y, backgroundBrush); }
 616
 617     void DrawText( const wxString &str, wxDouble x, wxDouble y,
 618                    wxDouble angle, const wxGraphicsBrush& backgroundBrush )
 619         { DoDrawRotatedFilledText(str, x, y, angle, backgroundBrush); }
 620
 621
 622     virtual void GetTextExtent( const wxString &text, wxDouble *width, wxDouble *height,
 623         wxDouble *descent = NULL, wxDouble *externalLeading = NULL ) const  = 0;
 624
 625     virtual void GetPartialTextExtents(const wxString& text, wxArrayDouble& widths) const = 0;
 626
 627     //
 628     // image support
 629     //
 630
 631     virtual void DrawBitmap( const wxGraphicsBitmap &bmp, wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
 632
 633     virtual void DrawBitmap( const wxBitmap &bmp, wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
 634
 635     virtual void DrawIcon( const wxIcon &icon, wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
 636
 637     //
 638     // convenience methods
 639     //
 640
 641     // strokes a single line
 642     virtual void StrokeLine( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2);
 643
 644     // stroke lines connecting each of the points
 645     virtual void StrokeLines( size_t n, const wxPoint2DDouble *points);
 646
 647     // stroke disconnected lines from begin to end points
 648     virtual void StrokeLines( size_t n, const wxPoint2DDouble *beginPoints, const wxPoint2DDouble *endPoints);
 649
 650     // draws a polygon
 651     virtual void DrawLines( size_t n, const wxPoint2DDouble *points, wxPolygonFillMode fillStyle = wxODDEVEN_RULE );
 652
 653     // draws a rectangle
 654     virtual void DrawRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h);
 655
 656     // draws an ellipse
 657     virtual void DrawEllipse( wxDouble x, wxDouble y, wxDouble w, wxDouble h);
 658
 659     // draws a rounded rectangle
 660     virtual void DrawRoundedRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h, wxDouble radius);
 661
 662      // wrappers using wxPoint2DDouble TODO
 663
 664     // helper to determine if a 0.5 offset should be applied for the drawing operation
 665     virtual bool ShouldOffset() const { return false; }
 666
 667     // indicates whether the context should try to offset for pixel boundaries, this only makes sense on
 668     // bitmap devices like screen, by default this is turned off
 669     virtual void EnableOffset(bool enable = true);
 670
 671     void DisableOffset() { EnableOffset(false); }
 672     bool OffsetEnabled() { return m_enableOffset; }
 673
 674 protected:
 675     // These fields must be initialized in the derived class ctors.
 676     wxDouble m_width,
 677              m_height;
 678
 679     wxGraphicsPen m_pen;
 680     wxGraphicsBrush m_brush;
 681     wxGraphicsFont m_font;
 682     wxAntialiasMode m_antialias;
 683     wxCompositionMode m_composition;
 684     wxInterpolationQuality m_interpolation;
 685     bool m_enableOffset;
 686
 687 protected:
 688     // implementations of overloaded public functions: we use different names
 689     // for them to avoid the virtual function hiding problems in the derived
 690     // classes
 691     virtual void DoDrawText(const wxString& str, wxDouble x, wxDouble y) = 0;
 692     virtual void DoDrawRotatedText(const wxString& str, wxDouble x, wxDouble y,
 693                                    wxDouble angle);
 694     virtual void DoDrawFilledText(const wxString& str, wxDouble x, wxDouble y,
 695                                   const wxGraphicsBrush& backgroundBrush);
 696     virtual void DoDrawRotatedFilledText(const wxString& str,
 697                                          wxDouble x, wxDouble y,
 698                                          wxDouble angle,
 699                                          const wxGraphicsBrush& backgroundBrush);
 700
 701     wxDECLARE_NO_COPY_CLASS(wxGraphicsContext);
 702     DECLARE_ABSTRACT_CLASS(wxGraphicsContext)
 703 };
 704
 705 #if 0
 706
 707 //
 708 // A graphics figure allows to cache path, pen etc creations, also will be a basis for layering/grouping elements
 709 //
 710
 711 class WXDLLIMPEXP_CORE wxGraphicsFigure : public wxGraphicsObject
 712 {
 713 public:
 714     wxGraphicsFigure(wxGraphicsRenderer* renderer);
 715
 716     virtual ~wxGraphicsFigure();
 717
 718     void SetPath( wxGraphicsMatrix* matrix );
 719
 720     void SetMatrix( wxGraphicsPath* path);
 721
 722     // draws this object on the context
 723     virtual void Draw( wxGraphicsContext* cg );
 724
 725     // returns the path of this object
 726     wxGraphicsPath* GetPath() { return m_path; }
 727
 728     // returns the transformation matrix of this object, may be null if there is no transformation necessary
 729     wxGraphicsMatrix* GetMatrix() { return m_matrix; }
 730
 731 private:
 732     wxGraphicsMatrix* m_matrix;
 733     wxGraphicsPath* m_path;
 734
 735     DECLARE_DYNAMIC_CLASS(wxGraphicsFigure)
 736 };
 737
 738 #endif
 739
 740 //
 741 // The graphics renderer is the instance corresponding to the rendering engine used, eg there is ONE core graphics renderer
 742 // instance on OSX. This instance is pointed back to by all objects created by it. Therefore you can create eg additional
 743 // paths at any point from a given matrix etc.
 744 //
 745
 746 class WXDLLIMPEXP_CORE wxGraphicsRenderer : public wxObject
 747 {
 748 public:
 749     wxGraphicsRenderer() {}
 750
 751     virtual ~wxGraphicsRenderer() {}
 752
 753     static wxGraphicsRenderer* GetDefaultRenderer();
 754
 755     static wxGraphicsRenderer* GetCairoRenderer();
 756     // Context
 757
 758     virtual wxGraphicsContext * CreateContext( const wxWindowDC& dc) = 0;
 759     virtual wxGraphicsContext * CreateContext( const wxMemoryDC& dc) = 0;
 760 #if wxUSE_PRINTING_ARCHITECTURE
 761     virtual wxGraphicsContext * CreateContext( const wxPrinterDC& dc) = 0;
 762 #endif
 763 #ifdef __WXMSW__
 764 #if wxUSE_ENH_METAFILE
 765     virtual wxGraphicsContext * CreateContext( const wxEnhMetaFileDC& dc) = 0;
 766 #endif
 767 #endif
 768
 769     virtual wxGraphicsContext * CreateContextFromNativeContext( void * context ) = 0;
 770
 771     virtual wxGraphicsContext * CreateContextFromNativeWindow( void * window ) = 0;
 772
 773     virtual wxGraphicsContext * CreateContext( wxWindow* window ) = 0;
 774
 775     // create a context that can be used for measuring texts only, no drawing allowed
 776     virtual wxGraphicsContext * CreateMeasuringContext() = 0;
 777
 778     // Path
 779
 780     virtual wxGraphicsPath CreatePath() = 0;
 781
 782     // Matrix
 783
 784     virtual wxGraphicsMatrix CreateMatrix( wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0,
 785         wxDouble tx=0.0, wxDouble ty=0.0) = 0;
 786
 787     // Paints
 788
 789     virtual wxGraphicsPen CreatePen(const wxPen& pen) = 0;
 790
 791     virtual wxGraphicsBrush CreateBrush(const wxBrush& brush ) = 0;
 792
 793     // Gradient brush creation functions may not honour all the stops specified
 794     // stops and use just its boundary colours (this is currently the case
 795     // under OS X)
 796     virtual wxGraphicsBrush
 797     CreateLinearGradientBrush(wxDouble x1, wxDouble y1,
 798                               wxDouble x2, wxDouble y2,
 799                               const wxGraphicsGradientStops& stops) = 0;
 800
 801     virtual wxGraphicsBrush
 802     CreateRadialGradientBrush(wxDouble xo, wxDouble yo,
 803                               wxDouble xc, wxDouble yc,
 804                               wxDouble radius,
 805                               const wxGraphicsGradientStops& stops) = 0;
 806
 807     // sets the font
 808     virtual wxGraphicsFont CreateFont( const wxFont &font , const wxColour &col = *wxBLACK ) = 0;
 809
 810     // create a native bitmap representation
 811     virtual wxGraphicsBitmap CreateBitmap( const wxBitmap &bitmap ) = 0;
 812
 813     // create a graphics bitmap from a native bitmap
 814     virtual wxGraphicsBitmap CreateBitmapFromNativeBitmap( void* bitmap ) = 0;
 815
 816     // create a subimage from a native image representation
 817     virtual wxGraphicsBitmap CreateSubBitmap( const wxGraphicsBitmap &bitmap, wxDouble x, wxDouble y, wxDouble w, wxDouble h  ) = 0;
 818
 819 private:
 820     wxDECLARE_NO_COPY_CLASS(wxGraphicsRenderer);
 821     DECLARE_ABSTRACT_CLASS(wxGraphicsRenderer)
 822 };
 823
 824 #endif
 825
 826 #endif // _WX_GRAPHICS_H_