xref: /trunk/main/canvas/source/directx/dx_canvashelper.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef _DXCANVAS_CANVASHELPER_HXX_
29*cdf0e10cSrcweir #define _DXCANVAS_CANVASHELPER_HXX_
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <com/sun/star/rendering/XCanvas.hpp>
32*cdf0e10cSrcweir 
33*cdf0e10cSrcweir #include <basegfx/vector/b2isize.hxx>
34*cdf0e10cSrcweir #include <basegfx/vector/b2dsize.hxx>
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir #include "dx_graphicsprovider.hxx"
37*cdf0e10cSrcweir #include "dx_gdiplususer.hxx"
38*cdf0e10cSrcweir #include "dx_impltools.hxx"
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir #include <boost/utility.hpp>
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir namespace dxcanvas
44*cdf0e10cSrcweir {
45*cdf0e10cSrcweir     /** Helper class for basic canvas functionality. Also offers
46*cdf0e10cSrcweir         optional backbuffer painting, when providing it with a second
47*cdf0e10cSrcweir         HDC to render into.
48*cdf0e10cSrcweir      */
49*cdf0e10cSrcweir     class CanvasHelper : private ::boost::noncopyable
50*cdf0e10cSrcweir     {
51*cdf0e10cSrcweir     public:
52*cdf0e10cSrcweir         CanvasHelper();
53*cdf0e10cSrcweir 
54*cdf0e10cSrcweir         /// Release all references
55*cdf0e10cSrcweir         void disposing();
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir         /** Initialize canvas helper
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir             This method late-initializes the canvas helper, providing
60*cdf0e10cSrcweir             it with the necessary device and output objects. Note that
61*cdf0e10cSrcweir             the CanvasHelper does <em>not</em> take ownership of the
62*cdf0e10cSrcweir             passed rDevice reference, nor does it perform any
63*cdf0e10cSrcweir             reference counting. Thus, to prevent the reference counted
64*cdf0e10cSrcweir             SpriteCanvas object from deletion, the user of this class
65*cdf0e10cSrcweir             is responsible for holding ref-counted references itself!
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir             @param rDevice
68*cdf0e10cSrcweir             Reference device this canvas is associated with
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir          */
71*cdf0e10cSrcweir         void setDevice( com::sun::star::rendering::XGraphicDevice& rDevice );
72*cdf0e10cSrcweir 
73*cdf0e10cSrcweir         /** Set the target for rendering operations
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir             @param rTarget
76*cdf0e10cSrcweir             Render target
77*cdf0e10cSrcweir          */
78*cdf0e10cSrcweir         void setTarget( const GraphicsProviderSharedPtr& rTarget );
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir         /** Set the target for rendering operations
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir             @param rTarget
83*cdf0e10cSrcweir             Render target
84*cdf0e10cSrcweir 
85*cdf0e10cSrcweir             @param rOutputOffset
86*cdf0e10cSrcweir             Output offset in pixel
87*cdf0e10cSrcweir          */
88*cdf0e10cSrcweir         void setTarget( const GraphicsProviderSharedPtr& rTarget,
89*cdf0e10cSrcweir                         const ::basegfx::B2ISize&        rOutputOffset );
90*cdf0e10cSrcweir 
91*cdf0e10cSrcweir 
92*cdf0e10cSrcweir         // CanvasHelper functionality
93*cdf0e10cSrcweir         // ==========================
94*cdf0e10cSrcweir 
95*cdf0e10cSrcweir         // XCanvas (only providing, not implementing the
96*cdf0e10cSrcweir         // interface. Also note subtle method parameter differences)
97*cdf0e10cSrcweir         void clear();
98*cdf0e10cSrcweir         void drawPoint( const ::com::sun::star::rendering::XCanvas*     pCanvas,
99*cdf0e10cSrcweir                         const ::com::sun::star::geometry::RealPoint2D&  aPoint,
100*cdf0e10cSrcweir                         const ::com::sun::star::rendering::ViewState&   viewState,
101*cdf0e10cSrcweir                         const ::com::sun::star::rendering::RenderState& renderState );
102*cdf0e10cSrcweir         void drawLine( const ::com::sun::star::rendering::XCanvas*      pCanvas,
103*cdf0e10cSrcweir                        const ::com::sun::star::geometry::RealPoint2D&   aStartPoint,
104*cdf0e10cSrcweir                        const ::com::sun::star::geometry::RealPoint2D&   aEndPoint,
105*cdf0e10cSrcweir                        const ::com::sun::star::rendering::ViewState&    viewState,
106*cdf0e10cSrcweir                        const ::com::sun::star::rendering::RenderState&  renderState );
107*cdf0e10cSrcweir         void drawBezier( const ::com::sun::star::rendering::XCanvas*            pCanvas,
108*cdf0e10cSrcweir                          const ::com::sun::star::geometry::RealBezierSegment2D& aBezierSegment,
109*cdf0e10cSrcweir                          const ::com::sun::star::geometry::RealPoint2D&         aEndPoint,
110*cdf0e10cSrcweir                          const ::com::sun::star::rendering::ViewState&          viewState,
111*cdf0e10cSrcweir                          const ::com::sun::star::rendering::RenderState&        renderState );
112*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
113*cdf0e10cSrcweir             drawPolyPolygon( const ::com::sun::star::rendering::XCanvas*            pCanvas,
114*cdf0e10cSrcweir                              const ::com::sun::star::uno::Reference<
115*cdf0e10cSrcweir                                     ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
116*cdf0e10cSrcweir                              const ::com::sun::star::rendering::ViewState&          viewState,
117*cdf0e10cSrcweir                              const ::com::sun::star::rendering::RenderState&        renderState );
118*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
119*cdf0e10cSrcweir             strokePolyPolygon( const ::com::sun::star::rendering::XCanvas*          pCanvas,
120*cdf0e10cSrcweir                                const ::com::sun::star::uno::Reference<
121*cdf0e10cSrcweir                                     ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
122*cdf0e10cSrcweir                                const ::com::sun::star::rendering::ViewState&        viewState,
123*cdf0e10cSrcweir                                const ::com::sun::star::rendering::RenderState&      renderState,
124*cdf0e10cSrcweir                                const ::com::sun::star::rendering::StrokeAttributes& strokeAttributes );
125*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
126*cdf0e10cSrcweir             strokeTexturedPolyPolygon( const ::com::sun::star::rendering::XCanvas*          pCanvas,
127*cdf0e10cSrcweir                                        const ::com::sun::star::uno::Reference<
128*cdf0e10cSrcweir                                             ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
129*cdf0e10cSrcweir                                        const ::com::sun::star::rendering::ViewState&        viewState,
130*cdf0e10cSrcweir                                        const ::com::sun::star::rendering::RenderState&      renderState,
131*cdf0e10cSrcweir                                        const ::com::sun::star::uno::Sequence<
132*cdf0e10cSrcweir                                             ::com::sun::star::rendering::Texture >&         textures,
133*cdf0e10cSrcweir                                        const ::com::sun::star::rendering::StrokeAttributes& strokeAttributes );
134*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
135*cdf0e10cSrcweir             strokeTextureMappedPolyPolygon( const ::com::sun::star::rendering::XCanvas*             pCanvas,
136*cdf0e10cSrcweir                                             const ::com::sun::star::uno::Reference<
137*cdf0e10cSrcweir                                                     ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
138*cdf0e10cSrcweir                                             const ::com::sun::star::rendering::ViewState&           viewState,
139*cdf0e10cSrcweir                                             const ::com::sun::star::rendering::RenderState&         renderState,
140*cdf0e10cSrcweir                                             const ::com::sun::star::uno::Sequence<
141*cdf0e10cSrcweir                                                     ::com::sun::star::rendering::Texture >&         textures,
142*cdf0e10cSrcweir                                             const ::com::sun::star::uno::Reference<
143*cdf0e10cSrcweir                                                     ::com::sun::star::geometry::XMapping2D >&       xMapping,
144*cdf0e10cSrcweir                                             const ::com::sun::star::rendering::StrokeAttributes&    strokeAttributes );
145*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XPolyPolygon2D >
146*cdf0e10cSrcweir             queryStrokeShapes( const ::com::sun::star::rendering::XCanvas*          pCanvas,
147*cdf0e10cSrcweir                                const ::com::sun::star::uno::Reference<
148*cdf0e10cSrcweir                                     ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
149*cdf0e10cSrcweir                                const ::com::sun::star::rendering::ViewState&        viewState,
150*cdf0e10cSrcweir                                const ::com::sun::star::rendering::RenderState&      renderState,
151*cdf0e10cSrcweir                                const ::com::sun::star::rendering::StrokeAttributes& strokeAttributes );
152*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
153*cdf0e10cSrcweir             fillPolyPolygon( const ::com::sun::star::rendering::XCanvas*            pCanvas,
154*cdf0e10cSrcweir                              const ::com::sun::star::uno::Reference<
155*cdf0e10cSrcweir                                     ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
156*cdf0e10cSrcweir                              const ::com::sun::star::rendering::ViewState&          viewState,
157*cdf0e10cSrcweir                              const ::com::sun::star::rendering::RenderState&        renderState );
158*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
159*cdf0e10cSrcweir             fillTexturedPolyPolygon( const ::com::sun::star::rendering::XCanvas*            pCanvas,
160*cdf0e10cSrcweir                                      const ::com::sun::star::uno::Reference<
161*cdf0e10cSrcweir                                             ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
162*cdf0e10cSrcweir                                      const ::com::sun::star::rendering::ViewState&          viewState,
163*cdf0e10cSrcweir                                      const ::com::sun::star::rendering::RenderState&        renderState,
164*cdf0e10cSrcweir                                      const ::com::sun::star::uno::Sequence<
165*cdf0e10cSrcweir                                             ::com::sun::star::rendering::Texture >&         textures );
166*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
167*cdf0e10cSrcweir             fillTextureMappedPolyPolygon( const ::com::sun::star::rendering::XCanvas*           pCanvas,
168*cdf0e10cSrcweir                                           const ::com::sun::star::uno::Reference<
169*cdf0e10cSrcweir                                                 ::com::sun::star::rendering::XPolyPolygon2D >&  xPolyPolygon,
170*cdf0e10cSrcweir                                           const ::com::sun::star::rendering::ViewState&         viewState,
171*cdf0e10cSrcweir                                           const ::com::sun::star::rendering::RenderState&       renderState,
172*cdf0e10cSrcweir                                           const ::com::sun::star::uno::Sequence<
173*cdf0e10cSrcweir                                                 ::com::sun::star::rendering::Texture >&         textures,
174*cdf0e10cSrcweir                                           const ::com::sun::star::uno::Reference<
175*cdf0e10cSrcweir                                                 ::com::sun::star::geometry::XMapping2D >&       xMapping );
176*cdf0e10cSrcweir 
177*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCanvasFont > SAL_CALL
178*cdf0e10cSrcweir             createFont( const ::com::sun::star::rendering::XCanvas*             pCanvas,
179*cdf0e10cSrcweir                         const ::com::sun::star::rendering::FontRequest&         fontRequest,
180*cdf0e10cSrcweir                         const ::com::sun::star::uno::Sequence<
181*cdf0e10cSrcweir                                 ::com::sun::star::beans::PropertyValue >&       extraFontProperties,
182*cdf0e10cSrcweir                         const ::com::sun::star::geometry::Matrix2D&             fontMatrix );
183*cdf0e10cSrcweir 
184*cdf0e10cSrcweir         ::com::sun::star::uno::Sequence< ::com::sun::star::rendering::FontInfo >
185*cdf0e10cSrcweir             queryAvailableFonts( const ::com::sun::star::rendering::XCanvas*        pCanvas,
186*cdf0e10cSrcweir                                  const ::com::sun::star::rendering::FontInfo&       aFilter,
187*cdf0e10cSrcweir                                  const ::com::sun::star::uno::Sequence<
188*cdf0e10cSrcweir                                         ::com::sun::star::beans::PropertyValue >&   aFontProperties );
189*cdf0e10cSrcweir 
190*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
191*cdf0e10cSrcweir             drawText( const ::com::sun::star::rendering::XCanvas*           pCanvas,
192*cdf0e10cSrcweir                       const ::com::sun::star::rendering::StringContext&     text,
193*cdf0e10cSrcweir                       const ::com::sun::star::uno::Reference<
194*cdf0e10cSrcweir                             ::com::sun::star::rendering::XCanvasFont >&     xFont,
195*cdf0e10cSrcweir                       const ::com::sun::star::rendering::ViewState&         viewState,
196*cdf0e10cSrcweir                       const ::com::sun::star::rendering::RenderState&       renderState,
197*cdf0e10cSrcweir                       sal_Int8                                              textDirection );
198*cdf0e10cSrcweir 
199*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
200*cdf0e10cSrcweir             drawTextLayout( const ::com::sun::star::rendering::XCanvas*     pCanvas,
201*cdf0e10cSrcweir                             const ::com::sun::star::uno::Reference<
202*cdf0e10cSrcweir                                 ::com::sun::star::rendering::XTextLayout >& layoutetText,
203*cdf0e10cSrcweir                             const ::com::sun::star::rendering::ViewState&   viewState,
204*cdf0e10cSrcweir                             const ::com::sun::star::rendering::RenderState& renderState );
205*cdf0e10cSrcweir 
206*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
207*cdf0e10cSrcweir             drawBitmap( const ::com::sun::star::rendering::XCanvas*     pCanvas,
208*cdf0e10cSrcweir                         const ::com::sun::star::uno::Reference<
209*cdf0e10cSrcweir                                 ::com::sun::star::rendering::XBitmap >& xBitmap,
210*cdf0e10cSrcweir                         const ::com::sun::star::rendering::ViewState&   viewState,
211*cdf0e10cSrcweir                         const ::com::sun::star::rendering::RenderState& renderState );
212*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive >
213*cdf0e10cSrcweir             drawBitmapModulated( const ::com::sun::star::rendering::XCanvas*        pCanvas,
214*cdf0e10cSrcweir                                  const ::com::sun::star::uno::Reference<
215*cdf0e10cSrcweir                                         ::com::sun::star::rendering::XBitmap >&     xBitmap,
216*cdf0e10cSrcweir                                  const ::com::sun::star::rendering::ViewState&      viewState,
217*cdf0e10cSrcweir                                  const ::com::sun::star::rendering::RenderState&    renderState );
218*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XGraphicDevice >
219*cdf0e10cSrcweir             getDevice();
220*cdf0e10cSrcweir 
221*cdf0e10cSrcweir         // Flush drawing queue to screen
222*cdf0e10cSrcweir         void                    flush() const;
223*cdf0e10cSrcweir 
224*cdf0e10cSrcweir         /** Called from XCanvas base classes, to notify that content
225*cdf0e10cSrcweir             is _about_ to change
226*cdf0e10cSrcweir         */
227*cdf0e10cSrcweir         void modifying() {}
228*cdf0e10cSrcweir 
229*cdf0e10cSrcweir     protected:
230*cdf0e10cSrcweir         /// Refcounted global GDI+ state container
231*cdf0e10cSrcweir         GDIPlusUserSharedPtr            mpGdiPlusUser;
232*cdf0e10cSrcweir 
233*cdf0e10cSrcweir         /** Phyical output device
234*cdf0e10cSrcweir 
235*cdf0e10cSrcweir             Deliberately not a refcounted reference, because of
236*cdf0e10cSrcweir             potential circular references for spritecanvas.
237*cdf0e10cSrcweir          */
238*cdf0e10cSrcweir         com::sun::star::rendering::XGraphicDevice* mpDevice;
239*cdf0e10cSrcweir 
240*cdf0e10cSrcweir         /// Provides the Gdiplus::Graphics to render into
241*cdf0e10cSrcweir         GraphicsProviderSharedPtr                  mpGraphicsProvider;
242*cdf0e10cSrcweir 
243*cdf0e10cSrcweir         bool needOutput() const { return mpGraphicsProvider.get() != NULL; };
244*cdf0e10cSrcweir 
245*cdf0e10cSrcweir         // returns transparency of color
246*cdf0e10cSrcweir         void setupGraphicsState( GraphicsSharedPtr&                              rGraphics,
247*cdf0e10cSrcweir                                  const ::com::sun::star::rendering::ViewState&   viewState,
248*cdf0e10cSrcweir                                  const ::com::sun::star::rendering::RenderState& renderState );
249*cdf0e10cSrcweir 
250*cdf0e10cSrcweir         Gdiplus::CompositingMode    calcCompositingMode( sal_Int8 nMode );
251*cdf0e10cSrcweir 
252*cdf0e10cSrcweir         /// Current (transformation-independent) output buffer offset
253*cdf0e10cSrcweir         ::basegfx::B2ISize              maOutputOffset;
254*cdf0e10cSrcweir     };
255*cdf0e10cSrcweir }
256*cdf0e10cSrcweir 
257*cdf0e10cSrcweir #endif /* _DXCANVAS_CANVASHELPER_HXX_ */
258