1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_CANVAS_SOURCE_VCL_CANVASHELPER_HXX
#define INCLUDED_CANVAS_SOURCE_VCL_CANVASHELPER_HXX
#include <com/sun/star/geometry/IntegerPoint2D.hpp>
#include <com/sun/star/geometry/IntegerRectangle2D.hpp>
#include <com/sun/star/rendering/IntegerBitmapLayout.hpp>
#include <com/sun/star/rendering/XCanvas.hpp>
#include "cachedbitmap.hxx"
#include "outdevprovider.hxx"
namespace vclcanvas
{
class SpriteCanvas;
/** Helper class for basic canvas functionality. Also offers
optional backbuffer painting, when providing it with a second
OutputDevice to render into.
*/
class CanvasHelper
{
public:
/** Create canvas helper
*/
CanvasHelper();
/// make noncopyable
CanvasHelper(const CanvasHelper&) = delete;
const CanvasHelper& operator=(const CanvasHelper&) = delete;
/// Release all references
void disposing();
/** Initialize canvas helper
This method late-initializes the canvas helper, providing
it with the necessary device and output objects. Note that
the CanvasHelper does <em>not</em> take ownership of the
passed rDevice reference, nor does it perform any
reference counting. Thus, to prevent the reference counted
SpriteCanvas object from deletion, the user of this class
is responsible for holding ref-counted references itself!
@param rDevice
Reference device this canvas is associated with
@param rOutDev
Set primary output device for this canvas. That's where
all content is output to.
@param bProtect
When true, all output operations preserve outdev
state. When false, outdev state might change at any time.
@param bHaveAlpha
When true, hasAlpha() will always return true, otherwise, false.
*/
void init( css::rendering::XGraphicDevice& rDevice,
const OutDevProviderSharedPtr& rOutDev,
bool bProtect,
bool bHaveAlpha );
/** Set primary output device
This changes the primary output device, where rendering is
sent to.
*/
void setOutDev( const OutDevProviderSharedPtr& rOutDev,
bool bProtect);
/** Set secondary output device
Used for sprites, to generate mask bitmap.
*/
void setBackgroundOutDev( const OutDevProviderSharedPtr& rOutDev );
// CanvasHelper functionality
// ==========================
// XCanvas (only providing, not implementing the
// interface. Also note subtle method parameter differences)
void clear();
void drawLine( const css::rendering::XCanvas* rCanvas,
const css::geometry::RealPoint2D& aStartPoint,
const css::geometry::RealPoint2D& aEndPoint,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState );
void drawBezier( const css::rendering::XCanvas* rCanvas,
const css::geometry::RealBezierSegment2D& aBezierSegment,
const css::geometry::RealPoint2D& aEndPoint,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState );
css::uno::Reference< css::rendering::XCachedPrimitive >
drawPolyPolygon( const css::rendering::XCanvas* rCanvas,
const css::uno::Reference<
css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState );
css::uno::Reference< css::rendering::XCachedPrimitive >
strokePolyPolygon( const css::rendering::XCanvas* rCanvas,
const css::uno::Reference<
css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::rendering::StrokeAttributes& strokeAttributes );
css::uno::Reference< css::rendering::XCachedPrimitive >
strokeTexturedPolyPolygon( const css::rendering::XCanvas* rCanvas,
const css::uno::Reference<
css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::uno::Sequence<
css::rendering::Texture >& textures,
const css::rendering::StrokeAttributes& strokeAttributes );
css::uno::Reference< css::rendering::XCachedPrimitive >
strokeTextureMappedPolyPolygon( const css::rendering::XCanvas* rCanvas,
const css::uno::Reference<
css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::uno::Sequence<
css::rendering::Texture >& textures,
const css::uno::Reference<
css::geometry::XMapping2D >& xMapping,
const css::rendering::StrokeAttributes& strokeAttributes );
css::uno::Reference< css::rendering::XPolyPolygon2D >
queryStrokeShapes( const css::rendering::XCanvas* rCanvas,
const css::uno::Reference<
css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::rendering::StrokeAttributes& strokeAttributes );
css::uno::Reference< css::rendering::XCachedPrimitive >
fillPolyPolygon( const css::rendering::XCanvas* rCanvas,
const css::uno::Reference<
css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState );
css::uno::Reference< css::rendering::XCachedPrimitive >
fillTexturedPolyPolygon( const css::rendering::XCanvas* rCanvas,
const css::uno::Reference<
css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::uno::Sequence<
css::rendering::Texture >& textures );
css::uno::Reference< css::rendering::XCachedPrimitive >
fillTextureMappedPolyPolygon( const css::rendering::XCanvas* rCanvas,
const css::uno::Reference<
css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::uno::Sequence<
css::rendering::Texture >& textures,
const css::uno::Reference<
css::geometry::XMapping2D >& xMapping );
css::uno::Reference< css::rendering::XCanvasFont >
createFont( const css::rendering::XCanvas* rCanvas,
const css::rendering::FontRequest& fontRequest,
const css::uno::Sequence<
css::beans::PropertyValue >& extraFontProperties,
const css::geometry::Matrix2D& fontMatrix );
css::uno::Sequence< css::rendering::FontInfo >
queryAvailableFonts( const css::rendering::XCanvas* rCanvas,
const css::rendering::FontInfo& aFilter,
const css::uno::Sequence<
css::beans::PropertyValue >& aFontProperties );
css::uno::Reference< css::rendering::XCachedPrimitive >
drawText( const css::rendering::XCanvas* rCanvas,
const css::rendering::StringContext& text,
const css::uno::Reference<
css::rendering::XCanvasFont >& xFont,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
sal_Int8 textDirection );
css::uno::Reference< css::rendering::XCachedPrimitive >
drawTextLayout( const css::rendering::XCanvas* rCanvas,
const css::uno::Reference<
css::rendering::XTextLayout >& laidOutText,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState );
css::uno::Reference< css::rendering::XCachedPrimitive >
drawBitmap( const css::rendering::XCanvas* rCanvas,
const css::uno::Reference<
css::rendering::XBitmap >& xBitmap,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState );
css::uno::Reference< css::rendering::XCachedPrimitive >
drawBitmapModulated( const css::rendering::XCanvas* rCanvas,
const css::uno::Reference<
css::rendering::XBitmap >& xBitmap,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState );
// cast away const, need to change refcount (as this is
// ~invisible to client code, still logically const)
css::uno::Reference< css::rendering::XGraphicDevice >
getDevice() { return css::uno::Reference< css::rendering::XGraphicDevice >(mpDevice); }
// BitmapCanvasHelper functionality
// ================================
css::geometry::IntegerSize2D getSize();
css::uno::Reference< css::rendering::XBitmap >
getScaledBitmap( const css::geometry::RealSize2D& newSize,
bool beFast );
css::uno::Sequence< sal_Int8 >
getData( css::rendering::IntegerBitmapLayout& bitmapLayout,
const css::geometry::IntegerRectangle2D& rect );
css::uno::Sequence< sal_Int8 >
getPixel( css::rendering::IntegerBitmapLayout& bitmapLayout,
const css::geometry::IntegerPoint2D& pos );
css::rendering::IntegerBitmapLayout getMemoryLayout();
/// Repaint a cached bitmap
bool repaint( const GraphicObjectSharedPtr& rGrf,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const ::Point& rPt,
const ::Size& rSz,
const GraphicAttr& rAttr ) const;
/** Flush drawing queue.
This only works for Window canvases, and ensures that all
pending render operations are flushed to the
driver/hardware.
*/
void flush() const;
enum ColorType
{
LINE_COLOR, FILL_COLOR, TEXT_COLOR, IGNORE_COLOR
};
// returns transparency of color
int setupOutDevState( const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
ColorType eColorType ) const;
bool hasAlpha() const { return mbHaveAlpha; }
protected:
/** Phyical output device
Deliberately not a refcounted reference, because of
potential circular references for spritecanvas.
*/
css::rendering::XGraphicDevice* mpDevice;
/// Rendering to this outdev preserves its state
OutDevProviderSharedPtr mpProtectedOutDevProvider;
/// Rendering to this outdev does not preserve its state
OutDevProviderSharedPtr mpOutDevProvider;
/// Rendering to this outdev does not preserve its state
OutDevProviderSharedPtr mp2ndOutDevProvider;
/// When true, content is able to represent alpha
bool mbHaveAlpha;
private:
css::uno::Reference< css::rendering::XCachedPrimitive >
implDrawBitmap( const css::rendering::XCanvas* rCanvas,
const css::uno::Reference<
css::rendering::XBitmap >& xBitmap,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
bool bModulateColors );
bool setupTextOutput( ::Point& o_rOutPos,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::uno::Reference< css::rendering::XCanvasFont >& xFont ) const;
};
}
#endif // INCLUDED_CANVAS_SOURCE_VCL_CANVASHELPER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|