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 #if wxUSE_GRAPHICS_CONTEXT
  16
  17 #include "wx/geometry.h"
  18 #include "wx/dynarray.h"
  19
  20 class WXDLLIMPEXP_CORE wxWindowDC;
  21 class WXDLLIMPEXP_CORE wxGraphicsContext;
  22 class WXDLLIMPEXP_CORE wxGraphicsPath;
  23 class WXDLLIMPEXP_CORE wxGraphicsMatrix;
  24 class WXDLLIMPEXP_CORE wxGraphicsFigure;
  25 class WXDLLIMPEXP_CORE wxGraphicsRenderer;
  26 class WXDLLIMPEXP_CORE wxGraphicsPen;
  27 class WXDLLIMPEXP_CORE wxGraphicsBrush;
  28 class WXDLLIMPEXP_CORE wxGraphicsFont;
  29
  30 /*
  31  * notes about the graphics context apis
  32  *
  33  * angles : are measured in radians, 0.0 being in direction of positiv x axis, PI/2 being
  34  * in direction of positive y axis.
  35  */
  36
  37 // Base class of all objects used for drawing in the new graphics API, the always point back to their
  38 // originating rendering engine, there is no dynamic unloading of a renderer currently allowed,
  39 // these references are not counted
  40
  41 class WXDLLIMPEXP_CORE wxGraphicsObject : public wxObject
  42 {
  43 public :
  44         wxGraphicsObject( wxGraphicsRenderer* renderer = NULL ) : m_renderer(renderer) {}
  45
  46         wxGraphicsObject( const wxGraphicsObject& obj ) : m_renderer(obj.GetRenderer()) {}
  47
  48         virtual ~wxGraphicsObject() {}
  49
  50         wxGraphicsRenderer* GetRenderer() const { return m_renderer ; }
  51 protected :
  52         wxGraphicsRenderer* m_renderer;
  53         DECLARE_DYNAMIC_CLASS(wxGraphicsObject);
  54 } ;
  55
  56 class WXDLLIMPEXP_CORE wxGraphicsPen : public wxGraphicsObject
  57 {
  58 public :
  59     wxGraphicsPen(wxGraphicsRenderer* renderer) : wxGraphicsObject(renderer) {}
  60     virtual ~wxGraphicsPen() {}
  61     virtual void Apply( wxGraphicsContext* context) = 0;
  62     virtual wxDouble GetWidth() = 0;
  63 private :
  64     DECLARE_NO_COPY_CLASS(wxGraphicsPen)
  65     DECLARE_ABSTRACT_CLASS(wxGraphicsPen)
  66 } ;
  67
  68 class WXDLLIMPEXP_CORE wxGraphicsBrush : public wxGraphicsObject
  69 {
  70 public :
  71     wxGraphicsBrush(wxGraphicsRenderer* renderer) : wxGraphicsObject(renderer) {}
  72     virtual ~wxGraphicsBrush() {}
  73     virtual void Apply( wxGraphicsContext* context) = 0;
  74 private :
  75     DECLARE_NO_COPY_CLASS(wxGraphicsBrush)
  76     DECLARE_ABSTRACT_CLASS(wxGraphicsBrush)
  77 } ;
  78
  79 class WXDLLIMPEXP_CORE wxGraphicsFont : public wxGraphicsObject
  80 {
  81 public :
  82     wxGraphicsFont(wxGraphicsRenderer* renderer) : wxGraphicsObject(renderer) {}
  83     virtual ~wxGraphicsFont() {}
  84     virtual void Apply( wxGraphicsContext* context) = 0;
  85 private :
  86     DECLARE_NO_COPY_CLASS(wxGraphicsFont)
  87     DECLARE_ABSTRACT_CLASS(wxGraphicsFont)
  88 } ;
  89
  90 class WXDLLIMPEXP_CORE wxGraphicsPath : public wxGraphicsObject
  91 {
  92 public :
  93     wxGraphicsPath(wxGraphicsRenderer* renderer) : wxGraphicsObject(renderer) {}
  94     virtual ~wxGraphicsPath() {}
  95
  96     virtual wxGraphicsPath *Clone() const = 0;
  97
  98     //
  99     // These are the path primitives from which everything else can be constructed
 100     //
 101
 102     // begins a new subpath at (x,y)
 103     virtual void MoveToPoint( wxDouble x, wxDouble y ) = 0;
 104     void MoveToPoint( const wxPoint2DDouble& p);
 105
 106     // adds a straight line from the current point to (x,y)
 107     virtual void AddLineToPoint( wxDouble x, wxDouble y ) = 0;
 108     void AddLineToPoint( const wxPoint2DDouble& p);
 109
 110     // adds a cubic Bezier curve from the current point, using two control points and an end point
 111     virtual void AddCurveToPoint( wxDouble cx1, wxDouble cy1, wxDouble cx2, wxDouble cy2, wxDouble x, wxDouble y ) = 0;
 112     void AddCurveToPoint( const wxPoint2DDouble& c1, const wxPoint2DDouble& c2, const wxPoint2DDouble& e);
 113
 114         // adds another path
 115         virtual void AddPath( const wxGraphicsPath* path ) =0;
 116
 117     // closes the current sub-path
 118     virtual void CloseSubpath() = 0;
 119
 120     // gets the last point of the current path, (0,0) if not yet set
 121     virtual void GetCurrentPoint( wxDouble& x, wxDouble&y) = 0;
 122     wxPoint2DDouble GetCurrentPoint();
 123
 124     // adds an arc of a circle centering at (x,y) with radius (r) from startAngle to endAngle
 125     virtual void AddArc( wxDouble x, wxDouble y, wxDouble r, wxDouble startAngle, wxDouble endAngle, bool clockwise ) = 0;
 126         void AddArc( const wxPoint2DDouble& c, wxDouble r, wxDouble startAngle, wxDouble endAngle, bool clockwise);
 127
 128     //
 129     // These are convenience functions which - if not available natively will be assembled
 130     // using the primitives from above
 131     //
 132
 133     // adds a quadratic Bezier curve from the current point, using a control point and an end point
 134     virtual void AddQuadCurveToPoint( wxDouble cx, wxDouble cy, wxDouble x, wxDouble y );
 135
 136     // appends a rectangle as a new closed subpath
 137     virtual void AddRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h );
 138
 139     // appends an ellipsis as a new closed subpath fitting the passed rectangle
 140     virtual void AddCircle( wxDouble x, wxDouble y, wxDouble r );
 141
 142     // draws a an arc to two tangents connecting (current) to (x1,y1) and (x1,y1) to (x2,y2), also a straight line from (current) to (x1,y1)
 143     virtual void AddArcToPoint( wxDouble x1, wxDouble y1 , wxDouble x2, wxDouble y2, wxDouble r ) ;
 144
 145         // returns the native path
 146         virtual void * GetNativePath() const = 0;
 147
 148         // give the native path returned by GetNativePath() back (there might be some deallocations necessary)
 149         virtual void UnGetNativePath(void *p) = 0;
 150
 151         // transforms each point of this path by the matrix
 152         virtual void Transform( wxGraphicsMatrix* matrix ) =0;
 153
 154         // gets the bounding box enclosing all points (possibly including control points)
 155         virtual void GetBox(wxDouble *x, wxDouble *y, wxDouble *w, wxDouble *h) =0;
 156         wxRect2DDouble GetBox();
 157
 158         virtual bool Contains( wxDouble x, wxDouble y, int fillStyle = wxWINDING_RULE) =0;
 159         bool Contains( const wxPoint2DDouble& c, int fillStyle = wxWINDING_RULE);
 160
 161     DECLARE_NO_COPY_CLASS(wxGraphicsPath)
 162     DECLARE_ABSTRACT_CLASS(wxGraphicsPath)
 163 };
 164
 165 class WXDLLIMPEXP_CORE wxGraphicsMatrix : public wxGraphicsObject
 166 {
 167 public :
 168         wxGraphicsMatrix(wxGraphicsRenderer* renderer) : wxGraphicsObject(renderer) {}
 169
 170         virtual ~wxGraphicsMatrix() {}
 171
 172     virtual wxGraphicsMatrix *Clone() const = 0;
 173
 174         // concatenates the matrix
 175         virtual void Concat( const wxGraphicsMatrix *t ) = 0;
 176         void Concat( const wxGraphicsMatrix &t ) { Concat( &t ); }
 177
 178         // copies the passed in matrix
 179         virtual void Copy( const wxGraphicsMatrix *t )  = 0;
 180         void Copy( const wxGraphicsMatrix &t ) { Copy( &t ); }
 181
 182         // sets the matrix to the respective values
 183         virtual void Set(wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0,
 184                 wxDouble tx=0.0, wxDouble ty=0.0) = 0;
 185
 186         // makes this the inverse matrix
 187         virtual void Invert() = 0;
 188
 189         // returns true if the elements of the transformation matrix are equal ?
 190     virtual bool IsEqual( const wxGraphicsMatrix* t) const  = 0;
 191         bool IsEqual( const wxGraphicsMatrix& t) const { return IsEqual( &t ); }
 192
 193         // return true if this is the identity matrix
 194         virtual bool IsIdentity()  = 0;
 195
 196     //
 197     // transformation
 198     //
 199
 200     // add the translation to this matrix
 201     virtual void Translate( wxDouble dx , wxDouble dy ) = 0;
 202
 203     // add the scale to this matrix
 204     virtual void Scale( wxDouble xScale , wxDouble yScale ) = 0;
 205
 206     // add the rotation to this matrix (radians)
 207     virtual void Rotate( wxDouble angle ) = 0;
 208
 209     //
 210     // apply the transforms
 211     //
 212
 213         // applies that matrix to the point
 214         virtual void TransformPoint( wxDouble *x, wxDouble *y ) = 0;
 215
 216         // applies the matrix except for translations
 217         virtual void TransformDistance( wxDouble *dx, wxDouble *dy ) =0;
 218
 219         // returns the native representation
 220         virtual void * GetNativeMatrix() const = 0;
 221
 222     DECLARE_NO_COPY_CLASS(wxGraphicsMatrix)
 223     DECLARE_ABSTRACT_CLASS(wxGraphicsMatrix)
 224 } ;
 225
 226 class WXDLLIMPEXP_CORE wxGraphicsContext : public wxGraphicsObject
 227 {
 228 public:
 229     wxGraphicsContext(wxGraphicsRenderer* renderer);
 230
 231     virtual ~wxGraphicsContext();
 232
 233     static wxGraphicsContext* Create( const wxWindowDC& dc) ;
 234
 235     static wxGraphicsContext* CreateFromNative( void * context ) ;
 236
 237     static wxGraphicsContext* CreateFromNativeWindow( void * window ) ;
 238
 239     static wxGraphicsContext* Create( wxWindow* window ) ;
 240
 241     wxGraphicsPath * CreatePath();
 242
 243     virtual wxGraphicsPen* CreatePen(const wxPen& pen);
 244
 245     virtual wxGraphicsBrush* CreateBrush(const wxBrush& brush );
 246
 247     // sets the brush to a linear gradient, starting at (x1,y1) with color c1 to (x2,y2) with color c2
 248     virtual wxGraphicsBrush* CreateLinearGradientBrush( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2,
 249         const wxColour&c1, const wxColour&c2);
 250
 251     // sets the brush to a radial gradient originating at (xo,yc) with color oColor and ends on a circle around (xc,yc)
 252     // with radius r and color cColor
 253     virtual wxGraphicsBrush* CreateRadialGradientBrush( wxDouble xo, wxDouble yo, wxDouble xc, wxDouble yc, wxDouble radius,
 254         const wxColour &oColor, const wxColour &cColor);
 255
 256     // sets the font
 257     virtual wxGraphicsFont* CreateFont( const wxFont &font , const wxColour &col = *wxBLACK );
 258
 259         // create a 'native' matrix corresponding to these values
 260         virtual wxGraphicsMatrix* CreateMatrix( wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0,
 261                 wxDouble tx=0.0, wxDouble ty=0.0);
 262
 263     // push the current state of the context, ie the transformation matrix on a stack
 264     virtual void PushState() = 0;
 265
 266     // pops a stored state from the stack
 267     virtual void PopState() = 0;
 268
 269     // clips drawings to the region, combined to current clipping region
 270     virtual void Clip( const wxRegion &region ) = 0;
 271
 272     // clips drawings to the rect
 273     virtual void Clip( wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
 274
 275         // resets the clipping to original extent
 276         virtual void ResetClip() = 0 ;
 277
 278         // returns the native context
 279         virtual void * GetNativeContext() = 0;
 280
 281     //
 282     // transformation : changes the current transformation matrix CTM of the context
 283     //
 284
 285     // translate
 286     virtual void Translate( wxDouble dx , wxDouble dy ) = 0;
 287
 288     // scale
 289     virtual void Scale( wxDouble xScale , wxDouble yScale ) = 0;
 290
 291     // rotate (radians)
 292     virtual void Rotate( wxDouble angle ) = 0;
 293
 294         // concatenates this transform with the current transform of this context
 295         virtual void ConcatTransform( const wxGraphicsMatrix* matrix ) = 0;
 296
 297         // sets the transform of this context
 298         virtual void SetTransform( const wxGraphicsMatrix* matrix ) = 0;
 299
 300         // gets the matrix of this context
 301         virtual void GetTransform( wxGraphicsMatrix* matrix ) = 0;
 302     //
 303     // setting the paint
 304     //
 305
 306     // sets the pen
 307     virtual void SetPen( wxGraphicsPen* pen , bool release = true );
 308
 309     void SetPen( const wxPen& pen );
 310
 311     // sets the brush for filling
 312     virtual void SetBrush( wxGraphicsBrush* brush , bool release = true );
 313
 314     void SetBrush( const wxBrush& brush );
 315
 316     // sets the font
 317     virtual void SetFont( wxGraphicsFont* font, bool release = true );
 318
 319     void SetFont( const wxFont& font, const wxColour& colour );
 320
 321     // strokes along a path with the current pen
 322     virtual void StrokePath( const wxGraphicsPath *path ) = 0;
 323
 324     // fills a path with the current brush
 325     virtual void FillPath( const wxGraphicsPath *path, int fillStyle = wxWINDING_RULE ) = 0;
 326
 327     // draws a path by first filling and then stroking
 328     virtual void DrawPath( const wxGraphicsPath *path, int fillStyle = wxWINDING_RULE );
 329
 330     //
 331     // text
 332     //
 333
 334     virtual void DrawText( const wxString &str, wxDouble x, wxDouble y ) = 0;
 335
 336     virtual void DrawText( const wxString &str, wxDouble x, wxDouble y, wxDouble angle );
 337
 338     virtual void GetTextExtent( const wxString &text, wxDouble *width, wxDouble *height,
 339         wxDouble *descent, wxDouble *externalLeading ) const  = 0;
 340
 341     virtual void GetPartialTextExtents(const wxString& text, wxArrayDouble& widths) const = 0;
 342
 343     //
 344     // image support
 345     //
 346
 347     virtual void DrawBitmap( const wxBitmap &bmp, wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
 348
 349     virtual void DrawIcon( const wxIcon &icon, wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
 350
 351     //
 352     // convenience methods
 353     //
 354
 355     // strokes a single line
 356     virtual void StrokeLine( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2);
 357
 358     // stroke lines connecting each of the points
 359     virtual void StrokeLines( size_t n, const wxPoint2DDouble *points);
 360
 361     // stroke disconnected lines from begin to end points
 362     virtual void StrokeLines( size_t n, const wxPoint2DDouble *beginPoints, const wxPoint2DDouble *endPoints);
 363
 364     // draws a polygon
 365     virtual void DrawLines( size_t n, const wxPoint2DDouble *points, int fillStyle = wxWINDING_RULE );
 366
 367     // draws a polygon
 368     virtual void DrawRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h);
 369
 370     // draws an ellipse
 371     virtual void DrawEllipse( wxDouble x, wxDouble y, wxDouble w, wxDouble h);
 372
 373     // draws a rounded rectangle
 374     virtual void DrawRoundedRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h, wxDouble radius);
 375
 376      // wrappers using wxPoint2DDouble TODO
 377
 378     // helper to determine if a 0.5 offset should be applied for the drawing operation
 379     virtual bool ShouldOffset() const { return false; }
 380
 381 protected :
 382
 383     wxGraphicsPen* m_pen;
 384     bool m_releasePen;
 385     wxGraphicsBrush* m_brush;
 386     bool m_releaseBrush;
 387     wxGraphicsFont* m_font;
 388     bool m_releaseFont;
 389
 390 private :
 391     DECLARE_NO_COPY_CLASS(wxGraphicsContext)
 392     DECLARE_ABSTRACT_CLASS(wxGraphicsContext)
 393 };
 394
 395 #if 0
 396
 397 //
 398 // A graphics figure allows to cache path, pen etc creations, also will be a basis for layering/grouping elements
 399 //
 400
 401 class WXDLLIMPEXP_CORE wxGraphicsFigure : public wxGraphicsObject
 402 {
 403 public :
 404         wxGraphicsFigure(wxGraphicsRenderer* renderer) ;
 405
 406         virtual ~wxGraphicsFigure() ;
 407
 408         void SetPath( wxGraphicsMatrix* matrix );
 409
 410         void SetMatrix( wxGraphicsPath* path);
 411
 412         // draws this object on the context
 413         virtual void Draw( wxGraphicsContext* cg );
 414
 415         // returns the path of this object
 416         wxGraphicsPath* GetPath() { return m_path; }
 417
 418         // returns the transformation matrix of this object, may be null if there is no transformation necessary
 419         wxGraphicsMatrix* GetMatrix() { return m_matrix; }
 420
 421 private :
 422         wxGraphicsMatrix* m_matrix;
 423         wxGraphicsPath* m_path;
 424
 425     DECLARE_DYNAMIC_CLASS(wxGraphicsFigure)
 426 } ;
 427
 428 #endif
 429
 430 //
 431 // The graphics renderer is the instance corresponding to the rendering engine used, eg there is ONE core graphics renderer
 432 // instance on OSX. This instance is pointed back to by all objects created by it. Therefore you can create eg additional
 433 // paths at any point from a given matrix etc.
 434 //
 435
 436 class WXDLLIMPEXP_CORE wxGraphicsRenderer : public wxObject
 437 {
 438 public :
 439     wxGraphicsRenderer() {}
 440
 441     virtual ~wxGraphicsRenderer() {}
 442
 443         static wxGraphicsRenderer* GetDefaultRenderer();
 444
 445         // Context
 446
 447         virtual wxGraphicsContext * CreateContext( const wxWindowDC& dc) = 0 ;
 448
 449         virtual wxGraphicsContext * CreateContextFromNativeContext( void * context ) = 0;
 450
 451         virtual wxGraphicsContext * CreateContextFromNativeWindow( void * window ) = 0;
 452
 453         virtual wxGraphicsContext * CreateContext( wxWindow* window ) = 0;
 454
 455         // Path
 456
 457     virtual wxGraphicsPath * CreatePath() = 0;
 458
 459         // Matrix
 460
 461         virtual wxGraphicsMatrix * CreateMatrix( wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0,
 462                 wxDouble tx=0.0, wxDouble ty=0.0) = 0;
 463
 464     // Paints
 465
 466     virtual wxGraphicsPen* CreatePen(const wxPen& pen) = 0 ;
 467
 468     virtual wxGraphicsBrush* CreateBrush(const wxBrush& brush ) = 0 ;
 469
 470     // sets the brush to a linear gradient, starting at (x1,y1) with color c1 to (x2,y2) with color c2
 471     virtual wxGraphicsBrush* CreateLinearGradientBrush( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2,
 472         const wxColour&c1, const wxColour&c2) = 0;
 473
 474     // sets the brush to a radial gradient originating at (xo,yc) with color oColor and ends on a circle around (xc,yc)
 475     // with radius r and color cColor
 476     virtual wxGraphicsBrush* CreateRadialGradientBrush( wxDouble xo, wxDouble yo, wxDouble xc, wxDouble yc, wxDouble radius,
 477         const wxColour &oColor, const wxColour &cColor) = 0;
 478
 479    // sets the font
 480     virtual wxGraphicsFont* CreateFont( const wxFont &font , const wxColour &col = *wxBLACK ) = 0;
 481
 482 private :
 483         DECLARE_NO_COPY_CLASS(wxGraphicsRenderer)
 484     DECLARE_ABSTRACT_CLASS(wxGraphicsRenderer)
 485 } ;
 486
 487 #endif
 488
 489 #endif // _WX_GRAPHICS_H_