← Back to branch summary

~smspillaz/compiz-plugins-main/compiz-plugins-main.fix_939228

« back to all changes in this revision

Viewing changes to animation/include/animation/extensionplugin.h

  • Committer: Sam Spilsbury
  • Date: 2011-08-12 06:36:10 UTC
  • Revision ID: sam.spilsbury@canonical.com-20110812063610-8mcxo2xohctyp2ak
Sync - Remove Plugins

Show diffs side-by-side

added added

removed removed

Lines of Context:
animation/include/animation/extensionplugin.h
1
 
#ifndef ANIMATION_EXTENSIONPLUGIN_H
2
 
#define ANIMATION_EXTENSIONPLUGIN_H
3
 
#include "animation.h"
4
 
 
5
 
class ExtensionPluginInfo
6
 
{
7
 
public:
8
 
     ExtensionPluginInfo (const CompString &name,
9
 
                          unsigned int nEffects,
10
 
                          AnimEffect *effects,
11
 
                          CompOption::Vector *effectOptions,
12
 
                          unsigned int firstEffectOptionIndex);
13
 
     
14
 
     CompString name;
15
 
     unsigned int nEffects;
16
 
     AnimEffect *effects;
17
 
     
18
 
     /// Plugin options to be used in "effect options" strings.
19
 
     CompOption::Vector *effectOptions;
20
 
     
21
 
     /// Index of first effect option.
22
 
     unsigned int firstEffectOptionIndex;
23
 
     
24
 
     // More general and/or non-window functions (including functions that access
25
 
     // persistent animation data) to be overriden
26
 
     
27
 
     /// To be run at the beginning of glPaintOutput.
28
 
     virtual void prePaintOutput (CompOutput *output) {}
29
 
     
30
 
     /// To be run at the beginning of preparePaint.
31
 
     virtual void prePreparePaintGeneral () {}
32
 
     
33
 
     /// To be run at the end of preparePaint.
34
 
     virtual void postPreparePaintGeneral () {}
35
 
     
36
 
     /// To be run when a CompWindowNotifyRestack is handled.
37
 
     virtual void handleRestackNotify (AnimWindow *aw) {}
38
 
     
39
 
     /// To be run at the beginning of initiateOpenAnim.
40
 
     virtual void preInitiateOpenAnim (AnimWindow *aw) {}
41
 
     
42
 
     /// To be run at the beginning of initiateCloseAnim.
43
 
     virtual void preInitiateCloseAnim (AnimWindow *aw) {}
44
 
     
45
 
     /// To be run at the beginning of initiateMinimizeAnim.
46
 
     virtual void preInitiateMinimizeAnim (AnimWindow *aw) {}
47
 
     
48
 
     /// To be run at the beginning of initiateUnminimizeAnim.
49
 
     virtual void preInitiateUnminimizeAnim (AnimWindow *aw) {}
50
 
     
51
 
     /// Initializes plugin's persistent animation data for a window (if any).
52
 
     virtual void initPersistentData (AnimWindow *aw) {}
53
 
     
54
 
     /// Destroys plugin's persistent animation data for a window (if any).
55
 
     virtual void destroyPersistentData (AnimWindow *aw) {}
56
 
     
57
 
     /// To be run at the end of updateEventEffects.
58
 
     virtual void postUpdateEventEffects (AnimEvent e,
59
 
                                          bool forRandom) {}
60
 
                                          
61
 
    /// To be run after the startup countdown ends.
62
 
    virtual void postStartupCountdown () {}
63
 
 
64
 
    virtual bool paintShouldSkipWindow (CompWindow *w) { return false; }
65
 
 
66
 
    virtual void cleanUpAnimation (bool closing,
67
 
                                    bool destructing) {}
68
 
 
69
 
    virtual void processAllRestacks () {}
70
 
};
71
 
#endif