slideshow/source/engine/shapes/intrinsicanimationactivity.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: intrinsicanimationactivity.hxx,v $
  10  * $Revision: 1.3 $
  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
  31 #ifndef INCLUDED_SLIDESHOW_INTRINSICANIMATIONACTIVITY_HXX
  32 #define INCLUDED_SLIDESHOW_INTRINSICANIMATIONACTIVITY_HXX
  33
  34 #include "wakeupevent.hxx"
  35 #include "activity.hxx"
  36 #include "slideshowcontext.hxx"
  37 #include "drawshape.hxx"
  38 #include "tools.hxx"
  39
  40 /* Definition of IntrinsicAnimationActivity class */
  41
  42 namespace slideshow
  43 {
  44     namespace internal
  45     {
  46         /** Create an IntrinsicAnimationActivity.
  47
  48             This is an Activity interface implementation for intrinsic
  49             shape animations. Intrinsic shape animations are
  50             animations directly within a shape, e.g. drawing layer
  51             animations, or GIF animations.
  52
  53             @param rContext
  54             Common slideshow objects
  55
  56             @param rDrawShape
  57             Shape to control the intrinsic animation for
  58
  59             @param rWakeupEvent
  60             Externally generated wakeup event, to set this
  61             activity to sleep during inter-frame intervals. Must
  62             come frome the outside, since wakeup event and this
  63             object have mutual references to each other.
  64
  65             @param rTimeouts
  66             Vector of timeout values, to wait before the next
  67             frame is shown.
  68         */
  69         ActivitySharedPtr createIntrinsicAnimationActivity(
  70             const SlideShowContext&             rContext,
  71             const DrawShapeSharedPtr&           rDrawShape,
  72             const WakeupEventSharedPtr&         rWakeupEvent,
  73             const ::std::vector<double>&        rTimeouts,
  74             ::std::size_t                   nNumLoops,
  75             CycleMode                       eCycleMode );
  76     }
  77 }
  78
  79 #endif /* INCLUDED_SLIDESHOW_INTRINSICANIMATIONACTIVITY_HXX */