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
|
/* -*- 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_BASE_SPRITECANVASBASE_HXX
#define INCLUDED_CANVAS_BASE_SPRITECANVASBASE_HXX
#include <rtl/ref.hxx>
#include <com/sun/star/rendering/XSpriteCanvas.hpp>
#include <com/sun/star/rendering/InterpolationMode.hpp>
#include <canvas/base/integerbitmapbase.hxx>
#include <canvas/spriteredrawmanager.hxx>
namespace canvas
{
/** Helper template to handle XIntegerBitmap method forwarding to
BitmapCanvasHelper
Use this helper to handle the XIntegerBitmap part of your
implementation.
@tpl Base
Base class to use, most probably one of the
WeakComponentImplHelperN templates with the appropriate
interfaces. At least XSpriteCanvas and SpriteSurface 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 CanvasHelper
Canvas helper implementation for the backend in question
@tpl Mutex
Lock strategy to use. Defaults to using the
OBaseMutex-provided lock. Every time 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 CanvasBase for further contractual requirements towards
the CanvasHelper type, and some examples.
*/
template< class Base,
class CanvasHelper,
class Mutex=::osl::MutexGuard,
class UnambiguousBase = css::uno::XInterface > class SpriteCanvasBase :
public IntegerBitmapBase< BitmapCanvasBase<Base, CanvasHelper, Mutex, UnambiguousBase> >
{
public:
typedef IntegerBitmapBase< BitmapCanvasBase<Base, CanvasHelper, Mutex, UnambiguousBase> > BaseType;
typedef ::rtl::Reference< SpriteCanvasBase > Reference;
SpriteCanvasBase() :
maRedrawManager()
{
}
virtual void disposeThis() override
{
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
maRedrawManager.disposing();
// pass on to base class
BaseType::disposeThis();
}
// XSpriteCanvas
virtual css::uno::Reference< css::rendering::XAnimatedSprite > SAL_CALL createSpriteFromAnimation( const css::uno::Reference< css::rendering::XAnimation >& animation ) throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException) override
{
tools::verifyArgs(animation,
BOOST_CURRENT_FUNCTION,
static_cast< typename BaseType::UnambiguousBaseType* >(this));
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
return BaseType::maCanvasHelper.createSpriteFromAnimation(animation);
}
virtual css::uno::Reference< css::rendering::XAnimatedSprite > SAL_CALL createSpriteFromBitmaps( const css::uno::Sequence< css::uno::Reference< css::rendering::XBitmap > >& animationBitmaps,
sal_Int8 interpolationMode ) throw (css::lang::IllegalArgumentException,
css::rendering::VolatileContentDestroyedException,
css::uno::RuntimeException) override
{
tools::verifyArgs(animationBitmaps,
BOOST_CURRENT_FUNCTION,
static_cast< typename BaseType::UnambiguousBaseType* >(this));
tools::verifyRange( interpolationMode,
css::rendering::InterpolationMode::NEAREST_NEIGHBOR,
css::rendering::InterpolationMode::BEZIERSPLINE4 );
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
return BaseType::maCanvasHelper.createSpriteFromBitmaps(animationBitmaps, interpolationMode);
}
virtual css::uno::Reference< css::rendering::XCustomSprite > SAL_CALL createCustomSprite( const css::geometry::RealSize2D& spriteSize ) throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException) override
{
tools::verifySpriteSize(spriteSize,
BOOST_CURRENT_FUNCTION,
static_cast< typename BaseType::UnambiguousBaseType* >(this));
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
return BaseType::maCanvasHelper.createCustomSprite(spriteSize);
}
virtual css::uno::Reference< css::rendering::XSprite > SAL_CALL createClonedSprite( const css::uno::Reference< css::rendering::XSprite >& original ) throw (css::lang::IllegalArgumentException,
css::uno::RuntimeException) override
{
tools::verifyArgs(original,
BOOST_CURRENT_FUNCTION,
static_cast< typename BaseType::UnambiguousBaseType* >(this));
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
return BaseType::maCanvasHelper.createClonedSprite(original);
}
// SpriteSurface
virtual void showSprite( const Sprite::Reference& rSprite ) override
{
OSL_ASSERT( rSprite.is() );
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
maRedrawManager.showSprite( rSprite );
}
virtual void hideSprite( const Sprite::Reference& rSprite ) override
{
OSL_ASSERT( rSprite.is() );
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
maRedrawManager.hideSprite( rSprite );
}
virtual void moveSprite( const Sprite::Reference& rSprite,
const ::basegfx::B2DPoint& rOldPos,
const ::basegfx::B2DPoint& rNewPos,
const ::basegfx::B2DVector& rSpriteSize ) override
{
OSL_ASSERT( rSprite.is() );
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
maRedrawManager.moveSprite( rSprite, rOldPos, rNewPos, rSpriteSize );
}
virtual void updateSprite( const Sprite::Reference& rSprite,
const ::basegfx::B2DPoint& rPos,
const ::basegfx::B2DRange& rUpdateArea ) override
{
OSL_ASSERT( rSprite.is() );
typename BaseType::MutexType aGuard( BaseType::m_aMutex );
maRedrawManager.updateSprite( rSprite, rPos, rUpdateArea );
}
protected:
SpriteRedrawManager maRedrawManager;
};
}
#endif // INCLUDED_CANVAS_BASE_SPRITECANVASBASE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|