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
|
/* -*- 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_CANVASCUSTOMSPRITEBASE_HXX
#define INCLUDED_CANVAS_CANVASCUSTOMSPRITEBASE_HXX
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/rendering/XCustomSprite.hpp>
#include <com/sun/star/rendering/XPolyPolygon2D.hpp>
#include <basegfx/point/b2dpoint.hxx>
#include <basegfx/vector/b2dvector.hxx>
#include <basegfx/range/b2drange.hxx>
#include <canvas/base/integerbitmapbase.hxx>
#include <canvas/base/sprite.hxx>
#include <boost/utility.hpp>
namespace canvas
{
/** Helper template to handle XCustomSprite method forwarding to
CanvasCustomSpriteHelper
Use this helper to handle the XCustomSprite part of your
implementation.
@tpl Base
Base class to use, most probably one of the
WeakComponentImplHelperN templates with the appropriate
interfaces. At least XCustomSprite and Sprite should be among
them (why else would you use this template, then?). Base class
must have an Base( const Mutex& ) constructor (like the
WeakComponentImplHelperN templates have).
@tpl SpriteHelper
Sprite helper implementation for the backend in question
@tpl CanvasHelper
Canvas helper implementation for the backend in question
@tpl Mutex
Lock strategy to use. Defaults to using the
OBaseMutex-provided lock. Everytime one of the methods is
entered, an object of type Mutex is created with m_aMutex as
the sole parameter, and destroyed again when the method scope
is left.
@tpl UnambiguousBase
Optional unambiguous base class for XInterface of Base. It's
sometimes necessary to specify this parameter, e.g. if Base
derives from multiple UNO interface (were each provides its
own version of XInterface, making the conversion ambiguous)
@see CanvasCustomSpriteHelper for further contractual
requirements towards the SpriteHelper type, and some examples.
*/
template< class Base,
class SpriteHelper,
class CanvasHelper,
class Mutex=::osl::MutexGuard,
class UnambiguousBase=::com::sun::star::uno::XInterface > class CanvasCustomSpriteBase :
public IntegerBitmapBase< Base, CanvasHelper, Mutex, UnambiguousBase >
{
public:
typedef IntegerBitmapBase< Base, CanvasHelper, Mutex, UnambiguousBase > BaseType;
typedef SpriteHelper SpriteHelperType;
CanvasCustomSpriteBase() :
maSpriteHelper()
{
}
/** Object is being disposed.
Called from the cppu helper base, to notify disposal of
this object. Already releases all internal references.
@derive when overriding this method in derived classes,
<em>always</em> call the base class' method!
*/
virtual void disposeThis()
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
maSpriteHelper.disposing();
// pass on to base class
BaseType::disposeThis();
}
// XCanvas: selectively override base's methods here, for opacity tracking
virtual void SAL_CALL clear() throw (::com::sun::star::uno::RuntimeException)
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
maSpriteHelper.clearingContent( this );
// and forward to base class, which handles the actual rendering
return BaseType::clear();
}
virtual ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCachedPrimitive > SAL_CALL
drawBitmap( const ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XBitmap >& xBitmap,
const ::com::sun::star::rendering::ViewState& viewState,
const ::com::sun::star::rendering::RenderState& renderState ) throw (::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::uno::RuntimeException)
{
tools::verifyArgs(xBitmap, viewState, renderState,
BOOST_CURRENT_FUNCTION,
static_cast< typename BaseType::UnambiguousBaseType* >(this));
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
maSpriteHelper.checkDrawBitmap( this, xBitmap, viewState, renderState );
// and forward to base class, which handles the actual rendering
return BaseType::drawBitmap( xBitmap,
viewState,
renderState );
}
// TODO(F3): If somebody uses the XIntegerBitmap methods to
// clear pixel (setting alpha != 1.0 there), or a compositing
// mode results in similar alpha, maSpriteHelper might
// errorneously report fully opaque sprites. Effectively, all
// render methods must be overridden here; or better,
// functionality provided at the baseclass.
// XSprite
virtual void SAL_CALL setAlpha( double alpha ) throw (::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::uno::RuntimeException)
{
tools::verifyRange( alpha, 0.0, 1.0 );
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
maSpriteHelper.setAlpha( this, alpha );
}
virtual void SAL_CALL move( const ::com::sun::star::geometry::RealPoint2D& aNewPos,
const ::com::sun::star::rendering::ViewState& viewState,
const ::com::sun::star::rendering::RenderState& renderState ) throw (::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::uno::RuntimeException)
{
tools::verifyArgs(aNewPos, viewState, renderState,
BOOST_CURRENT_FUNCTION,
static_cast< typename BaseType::UnambiguousBaseType* >(this));
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
maSpriteHelper.move( this, aNewPos, viewState, renderState );
}
virtual void SAL_CALL transform( const ::com::sun::star::geometry::AffineMatrix2D& aTransformation ) throw (::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::uno::RuntimeException)
{
tools::verifyArgs(aTransformation,
BOOST_CURRENT_FUNCTION,
static_cast< typename BaseType::UnambiguousBaseType* >(this));
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
maSpriteHelper.transform( this, aTransformation );
}
virtual void SAL_CALL clip( const ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XPolyPolygon2D >& aClip ) throw (::com::sun::star::uno::RuntimeException)
{
// NULL xClip explicitly allowed here (to clear clipping)
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
maSpriteHelper.clip( this, aClip );
}
virtual void SAL_CALL setPriority( double nPriority ) throw (::com::sun::star::uno::RuntimeException)
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
maSpriteHelper.setPriority( this, nPriority );
}
virtual void SAL_CALL show() throw (::com::sun::star::uno::RuntimeException)
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
maSpriteHelper.show( this );
}
virtual void SAL_CALL hide() throw (::com::sun::star::uno::RuntimeException)
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
maSpriteHelper.hide( this );
}
// XCustomSprite
virtual ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XCanvas > SAL_CALL
getContentCanvas() throw (::com::sun::star::uno::RuntimeException)
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
return this;
}
// Sprite
virtual bool isAreaUpdateOpaque( const ::basegfx::B2DRange& rUpdateArea ) const
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
return maSpriteHelper.isAreaUpdateOpaque( rUpdateArea );
}
virtual bool isContentChanged() const
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
return BaseType::mbSurfaceDirty;
}
virtual ::basegfx::B2DPoint getPosPixel() const
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
return maSpriteHelper.getPosPixel();
}
virtual ::basegfx::B2DVector getSizePixel() const
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
return maSpriteHelper.getSizePixel();
}
virtual ::basegfx::B2DRange getUpdateArea() const
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
return maSpriteHelper.getUpdateArea();
}
virtual double getPriority() const
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
return maSpriteHelper.getPriority();
}
protected:
SpriteHelperType maSpriteHelper;
};
}
#endif /* INCLUDED_CANVAS_CANVASCUSTOMSPRITEBASE_HXX */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
