renderer added, creating renderer specific pens etc for faster use

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@42427 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/graphics.h

@@ -17,7 +17,15 @@
 #include "wx/geometry.h"
 #include "wx/dynarray.h"
 
-class WXDLLEXPORT wxWindowDC;
+class WXDLLIMPEXP_CORE wxWindowDC;
+class WXDLLIMPEXP_CORE wxGraphicsContext;
+class WXDLLIMPEXP_CORE wxGraphicsPath;
+class WXDLLIMPEXP_CORE wxGraphicsMatrix;
+class WXDLLIMPEXP_CORE wxGraphicsFigure;
+class WXDLLIMPEXP_CORE wxGraphicsRenderer;
+class WXDLLIMPEXP_CORE wxGraphicsPen;
+class WXDLLIMPEXP_CORE wxGraphicsBrush;
+class WXDLLIMPEXP_CORE wxGraphicsFont;
 
 /*
  * notes about the graphics context apis
@@ -26,33 +34,96 @@ class WXDLLEXPORT wxWindowDC;
  * in direction of positive y axis.
  */
  
-class WXDLLEXPORT wxGraphicsPath : public wxObject
+// Base class of all objects used for drawing in the new graphics API, the always point back to their
+// originating rendering engine, there is no dynamic unloading of a renderer currently allowed, 
+// these references are not counted
+ 
+class WXDLLIMPEXP_CORE wxGraphicsObject : public wxObject
 {
 public :
-    wxGraphicsPath() {}
+	wxGraphicsObject( wxGraphicsRenderer* renderer = NULL ) : m_renderer(renderer) {}
+	
+	wxGraphicsObject( const wxGraphicsObject& obj ) : m_renderer(obj.GetRenderer()) {}
+	
+	virtual ~wxGraphicsObject() {}
+	
+	wxGraphicsRenderer* GetRenderer() const { return m_renderer ; }
+protected :
+	wxGraphicsRenderer* m_renderer;
+	DECLARE_DYNAMIC_CLASS(wxGraphicsObject);
+} ;
+
+class WXDLLIMPEXP_CORE wxGraphicsPen : public wxGraphicsObject
+{
+public :
+    wxGraphicsPen(wxGraphicsRenderer* renderer) : wxGraphicsObject(renderer) {}
+    virtual ~wxGraphicsPen() {}
+    virtual void Apply( wxGraphicsContext* context) = 0;
+    virtual wxDouble GetWidth() = 0;
+private :
+    DECLARE_NO_COPY_CLASS(wxGraphicsPen)
+    DECLARE_ABSTRACT_CLASS(wxGraphicsPen)
+} ;
+
+class WXDLLIMPEXP_CORE wxGraphicsBrush : public wxGraphicsObject
+{
+public :
+    wxGraphicsBrush(wxGraphicsRenderer* renderer) : wxGraphicsObject(renderer) {}
+    virtual ~wxGraphicsBrush() {}
+    virtual void Apply( wxGraphicsContext* context) = 0;
+private :
+    DECLARE_NO_COPY_CLASS(wxGraphicsBrush)
+    DECLARE_ABSTRACT_CLASS(wxGraphicsBrush)
+} ;
+
+class WXDLLIMPEXP_CORE wxGraphicsFont : public wxGraphicsObject
+{
+public :
+    wxGraphicsFont(wxGraphicsRenderer* renderer) : wxGraphicsObject(renderer) {}
+    virtual ~wxGraphicsFont() {}
+    virtual void Apply( wxGraphicsContext* context) = 0;
+private :
+    DECLARE_NO_COPY_CLASS(wxGraphicsFont)
+    DECLARE_ABSTRACT_CLASS(wxGraphicsFont)
+} ;
+
+class WXDLLIMPEXP_CORE wxGraphicsPath : public wxGraphicsObject
+{
+public :
+    wxGraphicsPath(wxGraphicsRenderer* renderer) : wxGraphicsObject(renderer) {}
     virtual ~wxGraphicsPath() {}
     
+    virtual wxGraphicsPath *Clone() const = 0;
+
     //
     // These are the path primitives from which everything else can be constructed
     //
 
     // begins a new subpath at (x,y)
     virtual void MoveToPoint( wxDouble x, wxDouble y ) = 0;
+    void MoveToPoint( const wxPoint2DDouble& p);
 
     // adds a straight line from the current point to (x,y) 
     virtual void AddLineToPoint( wxDouble x, wxDouble y ) = 0;
+    void AddLineToPoint( const wxPoint2DDouble& p);
 
     // adds a cubic Bezier curve from the current point, using two control points and an end point
     virtual void AddCurveToPoint( wxDouble cx1, wxDouble cy1, wxDouble cx2, wxDouble cy2, wxDouble x, wxDouble y ) = 0;
+    void AddCurveToPoint( const wxPoint2DDouble& c1, const wxPoint2DDouble& c2, const wxPoint2DDouble& e);
+	
+	// adds another path
+	virtual void AddPath( const wxGraphicsPath* path ) =0;
 
     // closes the current sub-path
     virtual void CloseSubpath() = 0;
 
     // gets the last point of the current path, (0,0) if not yet set
     virtual void GetCurrentPoint( wxDouble& x, wxDouble&y) = 0;
+    wxPoint2DDouble GetCurrentPoint();
 
     // adds an arc of a circle centering at (x,y) with radius (r) from startAngle to endAngle
     virtual void AddArc( wxDouble x, wxDouble y, wxDouble r, wxDouble startAngle, wxDouble endAngle, bool clockwise ) = 0;
+	void AddArc( const wxPoint2DDouble& c, wxDouble r, wxDouble startAngle, wxDouble endAngle, bool clockwise);
 
     //
     // These are convenience functions which - if not available natively will be assembled 
@@ -71,68 +142,93 @@ public :
     // 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)
     virtual void AddArcToPoint( wxDouble x1, wxDouble y1 , wxDouble x2, wxDouble y2, wxDouble r ) ;
 	
-    // wrappers using wxPoint2DDoubles
-
-    wxPoint2DDouble GetCurrentPoint();
-
-    void MoveToPoint( const wxPoint2DDouble& p);
-
-    void AddLineToPoint( const wxPoint2DDouble& p);
-
-    void AddCurveToPoint( const wxPoint2DDouble& c1, const wxPoint2DDouble& c2, const wxPoint2DDouble& e);
-
-    void AddArc( const wxPoint2DDouble& c, wxDouble r, wxDouble startAngle, wxDouble endAngle, bool clockwise);
-	
 	// returns the native path
 	virtual void * GetNativePath() const = 0;
 	
 	// give the native path returned by GetNativePath() back (there might be some deallocations necessary)
 	virtual void UnGetNativePath(void *p) = 0;
 	
+	// transforms each point of this path by the matrix
+	virtual void Transform( wxGraphicsMatrix* matrix ) =0;
+	
+	// gets the bounding box enclosing all points (possibly including control points)
+	virtual void GetBox(wxDouble *x, wxDouble *y, wxDouble *w, wxDouble *y) =0;
+	wxRect2DDouble GetBox();
+	
+	virtual bool Contains( wxDouble x, wxDouble y, int fillStyle = wxWINDING_RULE) =0;
+	bool Contains( const wxPoint2DDouble& c, int fillStyle = wxWINDING_RULE);
+	
     DECLARE_NO_COPY_CLASS(wxGraphicsPath)
     DECLARE_ABSTRACT_CLASS(wxGraphicsPath)
 };
 
-/*
+class WXDLLIMPEXP_CORE wxGraphicsMatrix : public wxGraphicsObject
-class WXDLLEXPORT wxGraphicsMatrix
 {
 public :
-	wxGraphicsMatrix() {}
+	wxGraphicsMatrix(wxGraphicsRenderer* renderer) : wxGraphicsObject(renderer) {}
 	
 	virtual ~wxGraphicsMatrix() {}
 	
-	wxGraphicsMatrix* Concat( const wxGraphicsMatrix *t ) const;
+    virtual wxGraphicsMatrix *Clone() const = 0;
 
-	// returns the inverse matrix
+	// concatenates the matrix
-	wxGraphicsMatrix* Invert() const;
+	virtual void Concat( const wxGraphicsMatrix *t ) = 0;
+	void Concat( const wxGraphicsMatrix &t ) { Concat( &t ); }
+	
+	// copies the passed in matrix
+	virtual void Copy( const wxGraphicsMatrix *t )  = 0;
+	void Copy( const wxGraphicsMatrix &t ) { Copy( &t ); }
+
+	// sets the matrix to the respective values
+	virtual void Set(wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0, 
+		wxDouble tx=0.0, wxDouble ty=0.0) = 0;
+
+	// makes this the inverse matrix
+	virtual void Invert() = 0;
 	
 	// returns true if the elements of the transformation matrix are equal ?
-    bool operator==(const wxGraphicsMatrix& t) const;
+    virtual bool IsEqual( const wxGraphicsMatrix* t) const  = 0;
+	bool IsEqual( const wxGraphicsMatrix& t) const { return IsEqual( &t ); }
 	
 	// return true if this is the identity matrix
-	bool IsIdentity();
+	virtual bool IsIdentity()  = 0;
 	
     //
     // transformation
     //
     
-    // translate
+    // add the translation to this matrix
     virtual void Translate( wxDouble dx , wxDouble dy ) = 0;
 
-    // scale
+    // add the scale to this matrix
     virtual void Scale( wxDouble xScale , wxDouble yScale ) = 0;
 
-    // rotate (radians)
+    // add the rotation to this matrix (radians)
     virtual void Rotate( wxDouble angle ) = 0;	
-} ;
-*/
 	
-class WXDLLEXPORT wxGraphicsContext : public wxObject
+    //
+    // apply the transforms
+    //
+	
+	// applies that matrix to the point
+	virtual void TransformPoint( wxDouble *x, wxDouble *y ) = 0;
+	
+	// applies the matrix except for translations
+	virtual void TransformDistance( wxDouble *dx, wxDouble *dy ) =0;
+	
+	// returns the native representation
+	virtual void * GetNativeMatrix() const = 0;
+	
+    DECLARE_NO_COPY_CLASS(wxGraphicsMatrix)
+    DECLARE_ABSTRACT_CLASS(wxGraphicsMatrix)
+} ;
+
+class WXDLLIMPEXP_CORE wxGraphicsContext : public wxGraphicsObject
 {
 public:
-    wxGraphicsContext() {}
+    wxGraphicsContext(wxGraphicsRenderer* renderer);
 
-    virtual ~wxGraphicsContext() {}
+    virtual ~wxGraphicsContext();
     
     static wxGraphicsContext* Create( const wxWindowDC& dc) ;
 	
@@ -143,14 +239,27 @@ public:
 #endif
     static wxGraphicsContext* Create( wxWindow* window ) ;
 
-    // creates a path instance that corresponds to the type of graphics context, ie GDIPlus, cairo, CoreGraphics ...
+    wxGraphicsPath * CreatePath();
-    virtual wxGraphicsPath * CreatePath() = 0;
+	
+    virtual wxGraphicsPen* CreatePen(const wxPen& pen);
+    
+    virtual wxGraphicsBrush* CreateBrush(const wxBrush& brush );
+    
+    // sets the brush to a linear gradient, starting at (x1,y1) with color c1 to (x2,y2) with color c2
+    virtual wxGraphicsBrush* CreateLinearGradientBrush( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2, 
+        const wxColour&c1, const wxColour&c2);
+
+    // sets the brush to a radial gradient originating at (xo,yc) with color oColor and ends on a circle around (xc,yc) 
+    // with radius r and color cColor
+    virtual wxGraphicsBrush* CreateRadialGradientBrush( wxDouble xo, wxDouble yo, wxDouble xc, wxDouble yc, wxDouble radius,
+        const wxColour &oColor, const wxColour &cColor);
+
+    // sets the font
+    virtual wxGraphicsFont* CreateFont( const wxFont &font , const wxColour &col = *wxBLACK );
 
-	/*
 	// create a 'native' matrix corresponding to these values
 	virtual wxGraphicsMatrix* CreateMatrix( wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0, 
-		wxDouble tx=0.0, wxDouble ty=0.0) = 0;
+		wxDouble tx=0.0, wxDouble ty=0.0);
-	*/
 	
     // push the current state of the context, ie the transformation matrix on a stack
     virtual void PushState() = 0;
@@ -183,30 +292,32 @@ public:
     // rotate (radians)
     virtual void Rotate( wxDouble angle ) = 0;
 	
+	// concatenates this transform with the current transform of this context
+	virtual void ConcatTransform( const wxGraphicsMatrix* matrix ) = 0;
+
+	// sets the transform of this context
+	virtual void SetTransform( const wxGraphicsMatrix* matrix ) = 0;
+
+	// gets the matrix of this context
+	virtual void GetTransform( wxGraphicsMatrix* matrix ) = 0;
     //
     // setting the paint
     //
     
-    // sets the pan
+    // sets the pen
-    virtual void SetPen( const wxPen &pen ) = 0;
+    virtual void SetPen( wxGraphicsPen* pen , bool release = true );
+    
+    void SetPen( const wxPen& pen );
 
     // sets the brush for filling
-    virtual void SetBrush( const wxBrush &brush ) = 0;
+    virtual void SetBrush( wxGraphicsBrush* brush , bool release = true );
     
-    // sets the brush to a linear gradient, starting at (x1,y1) with color c1 to (x2,y2) with color c2
+    void SetBrush( const wxBrush& brush );
-    virtual void SetLinearGradientBrush( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2, 
-        const wxColour&c1, const wxColour&c2) = 0;
-
-    // sets the brush to a radial gradient originating at (xo,yc) with color oColor and ends on a circle around (xc,yc) 
-    // with radius r and color cColor
-    virtual void SetRadialGradientBrush( wxDouble xo, wxDouble yo, wxDouble xc, wxDouble yc, wxDouble radius,
-        const wxColour &oColor, const wxColour &cColor) = 0;
 
     // sets the font
-    virtual void SetFont( const wxFont &font ) = 0;
+    virtual void SetFont( wxGraphicsFont* font, bool release = true );
     
-    // sets the text color
+    void SetFont( const wxFont& font, const wxColour& colour );
-    virtual void SetTextColour( const wxColour &col ) = 0;
     
     // strokes along a path with the current pen
     virtual void StrokePath( const wxGraphicsPath *path ) = 0;
@@ -263,16 +374,116 @@ public:
     // draws a rounded rectangle
     virtual void DrawRoundedRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h, wxDouble radius);
 
-    // wrappers using wxPoint2DDouble TODO
+     // wrappers using wxPoint2DDouble TODO
-
 
+protected :
     // helper to determine if a 0.5 offset should be applied for the drawing operation
     virtual bool ShouldOffset() const { return false; }
 
+    wxGraphicsPen* m_pen;
+    bool m_releasePen;
+    wxGraphicsBrush* m_brush;
+    bool m_releaseBrush;
+    wxGraphicsFont* m_font;
+    bool m_releaseFont;
+
+private :
     DECLARE_NO_COPY_CLASS(wxGraphicsContext)
     DECLARE_ABSTRACT_CLASS(wxGraphicsContext)
 };
 
+#if 0 
+
+//
+// A graphics figure allows to cache path, pen etc creations, also will be a basis for layering/grouping elements
+//
+
+class WXDLLIMPEXP_CORE wxGraphicsFigure : public wxGraphicsObject
+{
+public :
+	wxGraphicsFigure(wxGraphicsRenderer* renderer) ;
+		
+	virtual ~wxGraphicsFigure() ;
+	
+	void SetPath( wxGraphicsMatrix* matrix );
+	
+	void SetMatrix( wxGraphicsPath* path);
+
+	// draws this object on the context
+	virtual void Draw( wxGraphicsContext* cg );
+	
+	// returns the path of this object
+	wxGraphicsPath* GetPath() { return m_path; }
+	
+	// returns the transformation matrix of this object, may be null if there is no transformation necessary
+	wxGraphicsMatrix* GetMatrix() { return m_matrix; }
+	
+private :
+	wxGraphicsMatrix* m_matrix;
+	wxGraphicsPath* m_path;
+    
+    DECLARE_DYNAMIC_CLASS(wxGraphicsFigure)
+} ;
+  
+#endif  
+
+//
+// The graphics renderer is the instance corresponding to the rendering engine used, eg there is ONE core graphics renderer
+// instance on OSX. This instance is pointed back to by all objects created by it. Therefore you can create eg additional
+// paths at any point from a given matrix etc.
+//
+
+class WXDLLIMPEXP_CORE wxGraphicsRenderer : public wxObject
+{
+public :
+    wxGraphicsRenderer() {}
+
+    virtual ~wxGraphicsRenderer() {}
+
+	static wxGraphicsRenderer* GetDefaultRenderer();
+
+	// Context
+
+	virtual wxGraphicsContext * CreateContext( const wxWindowDC& dc) = 0 ;
+	
+	virtual wxGraphicsContext * CreateContextFromNativeContext( void * context ) = 0;
+
+	virtual wxGraphicsContext * CreateContextFromNativeWindow( void * window ) = 0;
+
+	virtual wxGraphicsContext * CreateContext( wxWindow* window ) = 0;
+
+	// Path
+	
+    virtual wxGraphicsPath * CreatePath() = 0;
+
+	// Matrix
+	
+	virtual wxGraphicsMatrix * CreateMatrix( wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0, 
+		wxDouble tx=0.0, wxDouble ty=0.0) = 0;
+        
+    // Paints
+    
+    virtual wxGraphicsPen* CreatePen(const wxPen& pen) = 0 ;
+    
+    virtual wxGraphicsBrush* CreateBrush(const wxBrush& brush ) = 0 ;
+    
+    // sets the brush to a linear gradient, starting at (x1,y1) with color c1 to (x2,y2) with color c2
+    virtual wxGraphicsBrush* CreateLinearGradientBrush( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2, 
+        const wxColour&c1, const wxColour&c2) = 0;
+
+    // sets the brush to a radial gradient originating at (xo,yc) with color oColor and ends on a circle around (xc,yc) 
+    // with radius r and color cColor
+    virtual wxGraphicsBrush* CreateRadialGradientBrush( wxDouble xo, wxDouble yo, wxDouble xc, wxDouble yc, wxDouble radius,
+        const wxColour &oColor, const wxColour &cColor) = 0;
+
+   // sets the font
+    virtual wxGraphicsFont* CreateFont( const wxFont &font , const wxColour &col = *wxBLACK ) = 0;
+    
+private :
+	DECLARE_NO_COPY_CLASS(wxGraphicsRenderer)
+    DECLARE_ABSTRACT_CLASS(wxGraphicsRenderer)
+} ;
+
 #endif
 
 #endif // _WX_GRAPHICS_H_