summaryrefslogtreecommitdiff
path: root/vcl/inc/vcl/animate.hxx
blob: b7b816c2b8222cc5a75003599281893a5c3a043e (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
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
/* -*- 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 _SV_ANIMATE_HXX
#define _SV_ANIMATE_HXX

#include <vcl/dllapi.h>
#include <vcl/timer.hxx>
#include <vcl/bitmapex.hxx>

// -----------
// - Defines -
// -----------

#define ANIMATION_TIMEOUT_ON_CLICK 2147483647L

// ---------
// - Enums -
// ---------

enum Disposal
{
    DISPOSE_NOT,
    DISPOSE_BACK,
    DISPOSE_FULL,
    DISPOSE_PREVIOUS 
};

enum CycleMode
{
    CYCLE_NOT,
    CYCLE_NORMAL,
    CYCLE_FALLBACK,
    CYCLE_REVERS,
    CYCLE_REVERS_FALLBACK
};

// -------------------
// - AnimationBitmap -
// -------------------

struct VCL_DLLPUBLIC AnimationBitmap
{
    BitmapEx	aBmpEx;
    Point		aPosPix;
    Size		aSizePix;
    long		nWait;
    Disposal	eDisposal;
    BOOL		bUserInput;

                AnimationBitmap() {}
                AnimationBitmap( const BitmapEx& rBmpEx, const Point& rPosPix,
                                 const Size& rSizePix, long _nWait = 0L,
                                 Disposal _eDisposal = DISPOSE_NOT ) :
                            aBmpEx		( rBmpEx ),
                            aPosPix		( rPosPix ),
                            aSizePix	( rSizePix ),
                            nWait		( _nWait ),
                            eDisposal	( _eDisposal ),
                            bUserInput	( FALSE ) {}

    BOOL		operator==( const AnimationBitmap& rAnimBmp ) const
                {
                    return( rAnimBmp.aBmpEx == aBmpEx &&
                            rAnimBmp.aPosPix == aPosPix &&
                            rAnimBmp.aSizePix == aSizePix &&
                            rAnimBmp.nWait == nWait &&
                            rAnimBmp.eDisposal == eDisposal &&
                            rAnimBmp.bUserInput == bUserInput );
                }

    BOOL		operator!=( const AnimationBitmap& rAnimBmp ) const { return !( *this == rAnimBmp ); }

    BOOL		IsEqual( const AnimationBitmap& rAnimBmp ) const
                {
                    return( rAnimBmp.aPosPix == aPosPix &&
                            rAnimBmp.aSizePix == aSizePix &&
                            rAnimBmp.nWait == nWait &&
                            rAnimBmp.eDisposal == eDisposal &&
                            rAnimBmp.bUserInput == bUserInput &&
                            rAnimBmp.aBmpEx.IsEqual( aBmpEx ) );
                }

    ULONG		GetChecksum() const;
};

// -------------------
// - AnimationBitmap -
// -------------------

struct AInfo
{
    Bitmap			aLastSaveBitmap;
    Bitmap			aBackBitmap;
    Rectangle		aClipRect;
    Size			aLastSaveSize;
    Point			aLastSavePoint;
    Point			aStartOrg;
    Size			aStartSize;
    OutputDevice*	pOutDev;
    void*			pViewData;
    long			nExtraData;
    BOOL			bWithSize;
    BOOL			bPause;

                    AInfo() : pOutDev( NULL ), 
                              pViewData( NULL ), 
                              nExtraData( 0L ),
                              bWithSize( FALSE ),
                              bPause( FALSE ) {}
};

// -------------------
// - AnimationBitmap -
// -------------------

class VCL_DLLPUBLIC Animation
{
    SAL_DLLPRIVATE static ULONG			mnAnimCount;

    List					maList;
    List					maAInfoList;
    Link					maNotifyLink;
    BitmapEx				maBitmapEx;
    Timer					maTimer;
    Size					maGlobalSize;
    List*					mpViewList;
    void*					mpExtraData;
    long					mnLoopCount;
    long					mnLoops;
    long					mnPos;
    Disposal				meLastDisposal;
    CycleMode				meCycleMode;
    BOOL					mbFirst;
    BOOL					mbIsInAnimation;
    BOOL					mbWithSize;
    BOOL					mbLoopTerminated;
    BOOL					mbIsWaiting;


    SAL_DLLPRIVATE void     ImplRestartTimer( ULONG nTimeout );
    DECL_DLLPRIVATE_LINK(   ImplTimeoutHdl, Timer* );

public:

    SAL_DLLPRIVATE static void  ImplIncAnimCount() { mnAnimCount++; }
    SAL_DLLPRIVATE static void  ImplDecAnimCount() { mnAnimCount--; }
    SAL_DLLPRIVATE ULONG        ImplGetCurPos() const { return mnPos; }


public:						
                            Animation();
                            Animation( const Animation& rAnimation );
                            ~Animation();

    Animation&				operator=( const Animation& rAnimation );
    BOOL					operator==( const Animation& rAnimation ) const;
    BOOL					operator!=( const Animation& rAnimation ) const { return !(*this==rAnimation); }

    BOOL					IsEqual( const Animation& rAnimation ) const;

    BOOL					IsEmpty() const;
    void					SetEmpty();

    void					Clear();

    BOOL					Start( OutputDevice* pOutDev, const Point& rDestPt, long nExtraData = 0, 
                                   OutputDevice* pFirstFrameOutDev = NULL );
    BOOL					Start( OutputDevice* pOutDev, const Point& rDestPt, const Size& rDestSz, long nExtraData = 0,
                                   OutputDevice* pFirstFrameOutDev = NULL );
    void					Stop( OutputDevice* pOutDev = NULL, long nExtraData = 0 );

    void					Draw( OutputDevice* pOutDev, const Point& rDestPt ) const;
    void					Draw( OutputDevice* pOutDev, const Point& rDestPt, const Size& rDestSz ) const;

    BOOL					IsInAnimation() const { return mbIsInAnimation; }
    BOOL					IsTransparent() const;
    BOOL					IsTerminated() const { return mbLoopTerminated; }

    const Size&				GetDisplaySizePixel() const { return maGlobalSize; }
    void					SetDisplaySizePixel( const Size& rSize ) { maGlobalSize = rSize; }

    const BitmapEx&			GetBitmapEx() const { return maBitmapEx; }
    void					SetBitmapEx( const BitmapEx& rBmpEx ) { maBitmapEx = rBmpEx; }

    ULONG					GetLoopCount() const { return mnLoopCount; }
    void					SetLoopCount( const ULONG nLoopCount );
    void					ResetLoopCount();

    void					SetCycleMode( CycleMode eMode );
    CycleMode				GetCycleMode() const { return meCycleMode; }

    void					SetNotifyHdl( const Link& rLink ) { maNotifyLink = rLink; }
    const Link&				GetNotifyHdl() const { return maNotifyLink; }

    USHORT					Count() const { return (USHORT) maList.Count(); }
    BOOL					Insert( const AnimationBitmap& rAnimationBitmap );
    const AnimationBitmap&	Get( USHORT nAnimation ) const;
    void					Replace( const AnimationBitmap& rNewAnimationBmp, USHORT nAnimation );

    List*					GetAInfoList() { return &maAInfoList; }
    ULONG					GetSizeBytes() const;
    ULONG					GetChecksum() const;

public:

    BOOL					Convert( BmpConversion eConversion );
    BOOL					ReduceColors( USHORT nNewColorCount, 
                                          BmpReduce eReduce = BMP_REDUCE_SIMPLE );
    BOOL					Invert();
    BOOL					Mirror( ULONG nMirrorFlags );
    BOOL					Dither( ULONG nDitherFlags = BMP_DITHER_MATRIX );
    BOOL					Adjust( short nLuminancePercent = 0,
                                    short nContrastPercent = 0,
                                    short nChannelRPercent = 0, 
                                    short nChannelGPercent = 0, 
                                    short nChannelBPercent = 0,
                                    double fGamma = 1.0,
                                    BOOL bInvert = FALSE );
    BOOL					Filter( BmpFilter eFilter, 
                                    const BmpFilterParam* pFilterParam = NULL,
                                    const Link* pProgress = NULL );

    friend VCL_DLLPUBLIC SvStream&		operator>>( SvStream& rIStream, Animation& rAnimation );
    friend VCL_DLLPUBLIC SvStream&		operator<<( SvStream& rOStream, const Animation& rAnimation );
};

#endif // _SV_ANIMATE_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */