slideshow/source/engine/shapes/intrinsicanimationactivity.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SLIDESHOW_SOURCE_ENGINE_SHAPES_INTRINSICANIMATIONACTIVITY_HXX
  21 #define INCLUDED_SLIDESHOW_SOURCE_ENGINE_SHAPES_INTRINSICANIMATIONACTIVITY_HXX
  22
  23 #include "wakeupevent.hxx"
  24 #include "activity.hxx"
  25 #include "slideshowcontext.hxx"
  26 #include "drawshape.hxx"
  27 #include "tools.hxx"
  28
  29 /* Definition of IntrinsicAnimationActivity class */
  30
  31 namespace slideshow
  32 {
  33     namespace internal
  34     {
  35         /** Create an IntrinsicAnimationActivity.
  36
  37             This is an Activity interface implementation for intrinsic
  38             shape animations. Intrinsic shape animations are
  39             animations directly within a shape, e.g. drawing layer
  40             animations, or GIF animations.
  41
  42             @param rContext
  43             Common slideshow objects
  44
  45             @param rDrawShape
  46             Shape to control the intrinsic animation for
  47
  48             @param rWakeupEvent
  49             Externally generated wakeup event, to set this
  50             activity to sleep during inter-frame intervals. Must
  51             come from the outside, since wakeup event and this
  52             object have mutual references to each other.
  53
  54             @param rTimeouts
  55             Vector of timeout values, to wait before the next
  56             frame is shown.
  57         */
  58         ActivitySharedPtr createIntrinsicAnimationActivity(
  59             const SlideShowContext&         rContext,
  60             const DrawShapeSharedPtr&       rDrawShape,
  61             const WakeupEventSharedPtr&     rWakeupEvent,
  62             const ::std::vector<double>&    rTimeouts,
  63             ::std::size_t                   nNumLoops,
  64             CycleMode                       eCycleMode );
  65     }
  66 }
  67
  68 #endif // INCLUDED_SLIDESHOW_SOURCE_ENGINE_SHAPES_INTRINSICANIMATIONACTIVITY_HXX
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */