slideshow/source/engine/animationnodes/basenode.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: basenode.hxx,v $
  10  * $Revision: 1.13 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef INCLUDED_SLIDESHOW_BASENODE_HXX
  31 #define INCLUDED_SLIDESHOW_BASENODE_HXX
  32
  33 #include <canvas/debug.hxx>
  34 #include <tools/diagnose_ex.h>
  35 #include <osl/diagnose.hxx>
  36
  37 #include "event.hxx"
  38 #include "animationnode.hxx"
  39 #include "slideshowcontext.hxx"
  40 #include "shapesubset.hxx"
  41
  42 #include <boost/noncopyable.hpp>
  43 #include <vector>
  44
  45 namespace slideshow {
  46 namespace internal {
  47
  48 /** Context for every node.
  49
  50     Besides the global AnimationNodeFactory::Context data,
  51     this struct also contains the current DocTree subset
  52     for this node. If start and end index of the
  53     DocTreeNode are equal, the node should use the
  54     complete shape.
  55 */
  56 struct NodeContext
  57 {
  58     NodeContext( const SlideShowContext&                 rContext,
  59                  const ::basegfx::B2DVector&             rSlideSize )
  60         : maContext( rContext ),
  61           maSlideSize( rSlideSize ),
  62           mpMasterShapeSubset(),
  63           mnStartDelay(0.0),
  64           mbIsIndependentSubset( true )
  65         {}
  66
  67     void dispose()
  68     {
  69         maContext.dispose();
  70         mpMasterShapeSubset.reset();
  71     }
  72
  73     /// Context as passed to createAnimationNode()
  74     SlideShowContext                 maContext;
  75
  76     /// Size in user coordinate space of the corresponding slide
  77     ::basegfx::B2DVector             maSlideSize;
  78
  79     /// Shape to be used (provided by parent, e.g. for iterations)
  80     ShapeSubsetSharedPtr             mpMasterShapeSubset;
  81
  82     /// Additional delay to node begin (to offset iterate effects)
  83     double                           mnStartDelay;
  84
  85     /// When true, subset must be created during slide initialization
  86     bool                             mbIsIndependentSubset;
  87 };
  88
  89 class BaseContainerNode;
  90
  91 /** This interface extends AnimationNode with some
  92     file-private accessor methods.
  93 */
  94 class BaseNode : public AnimationNode,
  95                  protected ::osl::DebugBase<BaseNode>,
  96                  private ::boost::noncopyable
  97 {
  98 public:
  99     BaseNode( ::com::sun::star::uno::Reference<
 100               ::com::sun::star::animations::XAnimationNode> const& xNode,
 101               ::boost::shared_ptr<BaseContainerNode> const&        pParent,
 102               NodeContext const&                                   rContext );
 103
 104     /** Provide the node with a shared_ptr to itself.
 105
 106         Since implementation has to create objects which need
 107         a shared_ptr to this node, and a pointee cannot
 108         retrieve a shared_ptr to itself internally, have to
 109         set that from the outside.
 110     */
 111     void setSelf( const ::boost::shared_ptr< BaseNode >& rSelf );
 112
 113
 114 #if defined(VERBOSE) && defined(DBG_UTIL)
 115     virtual void showState() const;
 116     virtual const char* getDescription() const;
 117     void showTreeFromWithin() const;
 118 #endif
 119
 120     const ::boost::shared_ptr< BaseContainerNode >& getParentNode() const
 121         { return mpParent; }
 122
 123     // Disposable:
 124     virtual void dispose();
 125
 126     // AnimationNode:
 127     virtual bool init();
 128     virtual bool resolve();
 129     virtual bool activate();
 130     virtual void deactivate();
 131     virtual void end();
 132     virtual ::com::sun::star::uno::Reference<
 133         ::com::sun::star::animations::XAnimationNode> getXAnimationNode() const;
 134     virtual NodeState getState() const;
 135     virtual bool registerDeactivatingListener(
 136         const AnimationNodeSharedPtr& rNotifee );
 137     // nop:
 138     virtual void notifyDeactivating( const AnimationNodeSharedPtr& rNotifier );
 139
 140     bool isMainSequenceRootNode() const { return mbIsMainSequenceRootNode; }
 141
 142 protected:
 143     void scheduleDeactivationEvent( EventSharedPtr const& pEvent =
 144                                     EventSharedPtr() );
 145
 146     SlideShowContext const&                 getContext() const { return maContext; }
 147     ::boost::shared_ptr<BaseNode> const&    getSelf() const { return mpSelf; }
 148
 149     bool checkValidNode() const {
 150         ENSURE_OR_THROW( mpSelf, "no self ptr set!" );
 151         bool const bRet = (meCurrState != INVALID);
 152         OSL_ENSURE( bRet, "### INVALID node!" );
 153         return bRet;
 154     }
 155
 156 private:
 157     // all state affecting methods have "_st" counterparts being called at
 158     // derived classes when in state transistion: no-ops here at BaseNode...
 159     virtual bool init_st();
 160     virtual bool resolve_st();
 161     virtual void activate_st();
 162     virtual void deactivate_st( NodeState eDestState );
 163
 164 private:
 165     /// notifies
 166     /// - all registered deactivation listeners
 167     /// - single animation end (every node)
 168     /// - slide animations (if main sequence root node)
 169     void notifyEndListeners() const;
 170
 171     /// Get the node's restart mode
 172     sal_Int16 getRestartMode();
 173
 174     /** Get the default restart mode
 175
 176         If this node's default mode is
 177         AnimationRestart::DEFAULT, this method recursively
 178         calls the parent node.
 179     */
 180     sal_Int16 getRestartDefaultMode() const;
 181
 182     /// Get the node's fill mode
 183     sal_Int16 getFillMode();
 184
 185     /** Get the default fill mode.
 186
 187         If this node's default mode is AnimationFill::DEFAULT,
 188         this method recursively calls the parent node.
 189     */
 190     sal_Int16 getFillDefaultMode() const;
 191
 192     bool isTransition( NodeState eFromState, NodeState eToState,
 193                        bool debugAssert = true ) const {
 194         (void) debugAssert; // avoid warning
 195         bool const bRet =((mpStateTransitionTable[eFromState] & eToState) != 0);
 196         OSL_ENSURE( !debugAssert || bRet, "### state unreachable!" );
 197         return bRet;
 198     }
 199
 200     bool inStateOrTransition( int mask ) const {
 201         return ((meCurrState & mask) != 0 ||
 202                 (meCurrentStateTransition & mask) != 0);
 203     }
 204
 205     class StateTransition;
 206     friend class StateTransition;
 207
 208 private:
 209     SlideShowContext                                   maContext;
 210
 211     typedef ::std::vector< AnimationNodeSharedPtr >    ListenerVector;
 212
 213     ListenerVector                                     maDeactivatingListeners;
 214     ::com::sun::star::uno::Reference<
 215         ::com::sun::star::animations::XAnimationNode > mxAnimationNode;
 216     ::boost::shared_ptr< BaseContainerNode >           mpParent;
 217     ::boost::shared_ptr< BaseNode >                    mpSelf;
 218     const int*                                         mpStateTransitionTable;
 219     const double                                       mnStartDelay;
 220     NodeState                                          meCurrState;
 221     int                                                meCurrentStateTransition;
 222     EventSharedPtr                                     mpCurrentEvent;
 223     const bool                                         mbIsMainSequenceRootNode;
 224 };
 225
 226 typedef ::boost::shared_ptr< BaseNode > BaseNodeSharedPtr;
 227
 228 } // namespace internal
 229 } // namespace slideshow
 230
 231 #endif /* INCLUDED_SLIDESHOW_BASENODE_HXX */
 232