slideshow/source/inc/pairanimation.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_INC_PAIRANIMATION_HXX
  21 #define INCLUDED_SLIDESHOW_SOURCE_INC_PAIRANIMATION_HXX
  22
  23 #include "animation.hxx"
  24 #include <basegfx/tuple/b2dtuple.hxx>
  25
  26
  27 /* Definition of PairAnimation interface */
  28
  29 namespace slideshow
  30 {
  31     namespace internal
  32     {
  33         /** Interface defining a pair of numbers animation.
  34
  35             This interface is a specialization of the Animation
  36             interface, and is used to animate attributes representable
  37             by a pair of floating point values (e.g. a position or a
  38             size).
  39          */
  40         class PairAnimation : public Animation
  41         {
  42         public:
  43             typedef ::basegfx::B2DTuple ValueType;
  44
  45             /** Set the animation to the given value
  46
  47                 @param rValue
  48                 Current animation value.
  49              */
  50             virtual bool operator()( const ValueType& rValue ) = 0;
  51
  52             /** Request the underlying value for this animation.
  53
  54                 This is necessary for pure To or By animations, as the
  55                 Activity cannot determine a sensible start value
  56                 otherwise.
  57
  58                 @attention Note that you are only permitted to query
  59                 for the underlying value, if the animation has actually
  60                 been started (via start() call).
  61              */
  62             virtual ValueType getUnderlyingValue() const = 0;
  63         };
  64
  65         typedef ::boost::shared_ptr< PairAnimation > PairAnimationSharedPtr;
  66
  67     }
  68 }
  69
  70 #endif // INCLUDED_SLIDESHOW_SOURCE_INC_PAIRANIMATION_HXX
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */