summaryrefslogtreecommitdiff
path: root/slideshow/source/engine/animationnodes/basenode.hxx
blob: 9895abc451193b42b450e2978bd8237ac27c9180 (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
/*************************************************************************
 *
 *  $RCSfile: basenode.hxx,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: rt $ $Date: 2005-03-30 08:06:41 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef _SLIDESHOW_BASENODE_HXX
#define _SLIDESHOW_BASENODE_HXX

#include <animationnode.hxx>
#include <slideshowcontext.hxx>
#include <shapesubset.hxx>

#include <vector>

namespace presentation
{
    namespace internal
    {
        typedef int StateTransitionTable[17];

        /** Context for every node.

            Besides the global AnimationNodeFactory::Context data,
            this struct also contains the current DocTree subset
            for this node. If start and end index of the
            DocTreeNode are equal, the node should use the
            complete shape.
        */
        struct NodeContext
        {
            NodeContext( const SlideShowContext& rContext ) :
                maContext( rContext ),
                mpMasterShapeSubset(),
                mnStartDelay(0.0),
                mbIsIndependentSubset( true )
            {
            }

            void dispose() { maContext.dispose(); }

            /// Context as passed to createAnimationNode()
            SlideShowContext        maContext;

            /// Shape to be used (provided by parent, e.g. for iterations)
            ShapeSubsetSharedPtr    mpMasterShapeSubset;

            /// Additional delay to node begin (to offset iterate effects)
            double                  mnStartDelay;

            /// When true, subset must be created during slide initialization
            bool                    mbIsIndependentSubset;
        };

        class BaseContainerNode;

        /** This interface extends AnimationNode with some
            file-private accessor methods.
        */
        class BaseNode : public AnimationNode
        {
        public:
            BaseNode( const ::com::sun::star::uno::Reference<
                          ::com::sun::star::animations::XAnimationNode >&   xNode,
                      const ::boost::shared_ptr< BaseContainerNode >&       rParent,
                      const NodeContext&                                    rContext );

            // Disposable interface
            // --------------------

            virtual void dispose();

            // Implemented subset of AnimationNode interface
            // ---------------------------------------------
            virtual ::com::sun::star::uno::Reference<
                ::com::sun::star::animations::XAnimationNode > getXAnimationNode() const;

            virtual bool init();
            virtual bool resolve();
            virtual bool activate();
            virtual void deactivate();
            virtual void end();
            virtual NodeState getState() const;
            virtual bool registerDeactivatingListener( const AnimationNodeSharedPtr& rNotifee );

            /** Provide the node with a shared_ptr to itself.

                Since implementation has to create objects which need
                a shared_ptr to this node, and a pointee cannot
                retrieve a shared_ptr to itself internally, have to
                set that from the outside.
             */
            virtual void setSelf( const ::boost::shared_ptr< BaseNode >& rSelf );

            /** Get the default fill mode.

                If this node's default mode is AnimationFill::DEFAULT,
                this method recursively calls the parent node.
             */
            virtual sal_Int16 getFillDefaultMode() const;

            /** Get the default restart mode

                If this node's default mode is
                AnimationRestart::DEFAULT, this method recursively
                calls the parent node.
             */
            virtual sal_Int16 getRestartDefaultMode() const;

            /// Get the node's restart mode
            virtual sal_Int16 getRestartMode();

            /// Get the node's fill mode
            virtual sal_Int16 getFillMode();

            /** Notify a fired user event to this node

                This method differs from a plain activate(), in that
                it is able to also activate a yet unresolved node. If
                a node cannot be simply activated, this method issues
                a requestResolveOnChildren() on the parent node.
             */
            virtual void notifyUserEvent();

#if defined(VERBOSE) && defined(DBG_UTIL)
            virtual void showState() const;
            virtual const char* getDescription() const;
            void showTreeFromWithin() const;
#endif

            const ::boost::shared_ptr< BaseContainerNode >&     getParentNode() const { return mpParent; }

        protected:
            /** Schedule event that activates the node, once it is resolved

                You can override this method in derived
                classes. AnimateBaseNode does it to implement its
                fixed delay
            */
            virtual void scheduleActivationEvent();

            /** Schedule event that deactivates the node, once it is active

                You can override this method in derived
                classes.
            */
            virtual void scheduleDeactivationEvent() const;

            // inline accessors
            // ----------------

            const SlideShowContext&                             getContext() const { return maContext; }
            const ::boost::shared_ptr< BaseNode >&              getSelf() const { return mpSelf; }
            const ::com::sun::star::uno::Reference<
                ::com::sun::star::animations::XAnimationNode >& getXNode() const { return mxNode; }

        protected:
            SlideShowContext                                    maContext;

        private:
            typedef ::std::vector< AnimationNodeSharedPtr >     ListenerVector;

            ListenerVector                                      maDeactivatingListeners;
            ::com::sun::star::uno::Reference<
                ::com::sun::star::animations::XAnimationNode >  mxNode;
            ::boost::shared_ptr< BaseContainerNode >            mpParent;
            ::boost::shared_ptr< BaseNode >                     mpSelf;
            const int*                                          mpStateTransitionTable;
            const double                                        mnStartDelay;
            AnimationNode::NodeState                            meCurrState;
            const bool                                          mbIsMainSequenceRootNode;
        };

        typedef ::boost::shared_ptr< BaseNode > BaseNodeSharedPtr;
    }
}

#endif /* _SLIDESHOW_BASENODE_HXX */