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
|
/*************************************************************************
*
* 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 __com_sun_star_rendering_XAnimation_idl__
#define __com_sun_star_rendering_XAnimation_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_rendering_ViewState_idl__
#include <com/sun/star/rendering/ViewState.idl>
#endif
#ifndef __com_sun_star_rendering_AnimationAttributes_idl__
#include <com/sun/star/rendering/AnimationAttributes.idl>
#endif
#ifndef __com_sun_star_rendering_XCanvas_idl__
#include <com/sun/star/rendering/XCanvas.idl>
#endif
module com { module sun { module star { module rendering {
/* TODO: Have a property set here, to easily extend attributes? Think
that's advisable, because animations change the most. Implement
that with multiple inheritance interface types, please, not with
service description.
*/
/** This interface defines an animation sequence.<p>
This interface must be implemented by every animation object. It
is used by the <type>XCanvas</type> interface to render generic
animations.<p>
@since OOo 2.0
*/
interface XAnimation : ::com::sun::star::uno::XInterface
{
/** Render the animation content at time t into the specified
canvas.<p>
Note that it is perfectly legal to e.g. map t in a nonlinear
fashion to internal frames, for example to achieve
acceleration or decceleration effects. It is required that the
render method has const semantics, i.e. when called with the
same parameter set, identical output must be generated. This
is because e.g. a Sprite might decide arbitrarily to render an
animation once and cache the result, or repaint it via
XAnimation::render everytime.<p>
The rendered content, although, must be exactly the same for
identical viewState, canvas and t values. Or, for that
matters, must call the same canvas methods in the same order
with the same parameter sets, for identical viewState and t
values. Furthermore, when viewState has the identity
transformation set, rendered output must be contained in a
rectangle with upper left corner at (0,0) and width and height
given by the AnimationAttributes' untransformedSize
member. Any content exceeding this box might get clipped off.<p>
@param canvas
The target canvas to render this animation to.
@param viewState
The view state to be used when rendering this animation to the
target canvas. The view transformation matrix must not be
singular.
@param t
Time instant for which animation content is requested. The
range must always be [0,1], where 0 denotes the very beginning, and
1 the end of the animation sequence.
@throws <type>com::sun::star::lang::IllegalArgumentException</type>
if one of the passed parameters does not lie in the specified,
permissible range.
*/
void render( [in] XCanvas canvas, [in] ViewState viewState, [in] double t )
raises (com::sun::star::lang::IllegalArgumentException);
//-------------------------------------------------------------------------
/** Request the attribute information for this animation.<p>
This method returns the <type>AnimationAttributes</type>
structure, which defines more closely how to play this
animation.<p>
@returns the requested <type>AnimationAttributes</type>
structure.
*/
AnimationAttributes getAnimationAttributes();
};
}; }; }; };
#endif
|
