blob: 20819b514e709a8790e5c185f7629c7944509c1b (
plain)
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
|
/* -*- 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 SDEXT_PRESENTER_ANIMATION_HXX
#define SDEXT_PRESENTER_ANIMATION_HXX
#include <sal/types.h>
#include <boost/function.hpp>
#include <boost/noncopyable.hpp>
#include <boost/scoped_ptr.hpp>
#include <boost/shared_ptr.hpp>
#include <vector>
namespace sdext { namespace presenter {
/** Base class for animations handled by a PresenterAnimator object.
A PresenterAnimation objects basically states when it wants to be
started, how long it runs, and in what steps it wants to be called back
while running.
When a PresenterAnimation object is active/running its Run() method is
called back with increasing values between 0 and 1.
*/
class PresenterAnimation
: private ::boost::noncopyable
{
public:
/** Create a new PresenterAnimation object.
@param nStartDelay
The delay in ms (milliseconds) from this call until the new
object is to be activated.
@param nTotalDuration
The duration in ms the Run() method is to be called with
increasing values between 0 and 1.
@param nStepDuration
The duration between calls to Run(). This leads to approximately
nTotalDuration/nStepDuration calls to Run(). The exact duration
of each step may vary depending on system load an other influences.
*/
PresenterAnimation (
const sal_uInt64 nStartDelay,
const sal_uInt64 nTotalDuration,
const sal_uInt64 nStepDuration);
virtual ~PresenterAnimation (void);
/** Return the absolute start time in a system dependent format.
At about this time the Run() method will be called with a value of 0.
*/
sal_uInt64 GetStartTime (void);
/** Return the absolute end time in a system dependent format.
At about this time the Run() method will be called with a value of 1.
*/
sal_uInt64 GetEndTime (void);
/** Return the duration of each step in ms.
*/
sal_uInt64 GetStepDuration (void);
typedef ::boost::function<void(void)> Callback;
/** Add a callback that is executed after Run() is called for the last
time.
*/
void AddEndCallback (const Callback& rCallback);
/** Called with nProgress taking on values between 0 and 1.
@param nProgress
A value between 0 and 1.
@param nCurrentTime
Current time in a system dependent format.
*/
virtual void Run (const double nProgress, const sal_uInt64 nCurrentTime) = 0;
/** Called just before Run() is called for the first time to trigger the
callbacks registered via the <method>AddStartCallback()</method>.
*/
void RunStartCallbacks (void);
/** Called just after Run() is called for the last time to trigger the
callbacks registered via the <method>AddEndCallback()</method>.
*/
void RunEndCallbacks (void);
private:
const sal_uInt64 mnStartTime;
const sal_uInt64 mnTotalDuration;
const sal_uInt64 mnStepDuration;
::boost::scoped_ptr<std::vector<Callback> > mpStartCallbacks;
::boost::scoped_ptr<std::vector<Callback> > mpEndCallbacks;
};
sal_uInt64 GetCurrentTime (void);
inline sal_uInt32 GetSeconds (const sal_uInt64 nTime) { return sal_uInt32(nTime / 1000); }
inline sal_uInt32 GetNanoSeconds (const sal_uInt64 nTime) { return sal_uInt32((nTime % 1000) * 1000000); }
typedef ::boost::shared_ptr<PresenterAnimation> SharedPresenterAnimation;
} } // end of namespace ::sdext::presenter
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
