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