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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef INCLUDED_SLIDESHOW_VIEWLAYER_HXX
#define INCLUDED_SLIDESHOW_VIEWLAYER_HXX
#include <sal/config.h>
#include <boost/shared_ptr.hpp>
namespace basegfx
{
class B1DRange;
class B2DRange;
class B2DVector;
class B2DHomMatrix;
class B2DPolyPolygon;
}
namespace cppcanvas
{
class Canvas;
class CustomSprite;
}
/* Definition of ViewLayer interface */
namespace slideshow
{
namespace internal
{
class View;
class ViewLayer
{
public:
virtual ~ViewLayer() {}
/** Query whether layer displays on given view.
@return true, if this layer displays on the given
view.
*/
virtual bool isOnView(boost::shared_ptr<View> const& rView) const = 0;
/** Get the associated canvas of this layer.
The canvas returned by this method must not change, as
long as this object is alive.
*/
virtual boost::shared_ptr< cppcanvas::Canvas > getCanvas() const = 0;
/** Clear the clipped view layer area
This method clears the area inside the clip polygon,
if none is set, the transformed unit rectangle of the
view.
*/
virtual void clear() const = 0;
/** Clear the complete view
This method clears the full view area (not only the
transformed unit rectangle, or within the clip). If
this ViewLayer represents the background layer, the
whole XSlideShowView is cleared. If this ViewLayer is
implemented using sprites (i.e. one of the upper
layers), the sprite is cleared to fully transparent.
*/
virtual void clearAll() const = 0;
/** Create a sprite for this layer
@param rSpriteSizePixel
Sprite size in device pixel
@param nPriority
Sprite priority. This value determines the priority of
this sprite, relative to all other sprites of this
ViewLayer. The higher the priority, the closer to the
foreground the sprite will be.
@return the sprite, or NULL on failure (or if this
canvas does not support sprites).
*/
virtual boost::shared_ptr< cppcanvas::CustomSprite >
createSprite( const basegfx::B2DVector& rSpriteSizePixel,
double nPriority ) const = 0;
/** Set the layer priority range
This method influences the relative priority of this
layer, i.e. the z position in relation to other layers
on the parent view. The higher the priority range, the
further in front the layer resides.
@param rRange
Priority range, must be in the range [0,1]
*/
virtual void setPriority( const basegfx::B1DRange& rRange ) = 0;
/** Get the overall view transformation.
This method should <em>not</em> simply return the
underlying canvas' transformation, but rather provide
a layer above that. This enables clients of the
slideshow to set their own user space transformation
at the canvas, whilst the slideshow adds their
transformation on top of that. Concretely, this method
returns the user transform (implicitely calculated
from the setViewSize() method), combined with the view
transformation.
*/
virtual basegfx::B2DHomMatrix getTransformation() const = 0;
/** Get the overall view transformation.
Same transformation as with getTransformation(), only
that you can safely use this one to position sprites
on screen (no ViewLayer offsets included whatsoever).
*/
virtual basegfx::B2DHomMatrix getSpriteTransformation() const = 0;
/** Set clipping on this view layer.
@param rClip
Clip poly-polygon to set. The polygon is interpreted
in the user coordinate system, i.e. the view layer has
the size as given by setViewSize() on its
corresponding View.
*/
virtual void setClip( const basegfx::B2DPolyPolygon& rClip ) = 0;
/** Resize this view layer.
@param rArea
New area to cover. The area is interpreted in the user
coordinate system, i.e. relative to the size as given
by setViewSize() on the corresponding View.
@return true, if layer was actually resized (which
invalidates its content)
*/
virtual bool resize( const basegfx::B2DRange& rArea ) = 0;
};
typedef boost::shared_ptr< ViewLayer > ViewLayerSharedPtr;
}
}
#endif /* INCLUDED_SLIDESHOW_VIEWLAYER_HXX */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
