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