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