slideshow/source/engine/activities/accumulation.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: accumulation.hxx,v $
  10  * $Revision: 1.6 $
  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_ACCUMULATION_HXX
  32 #define INCLUDED_SLIDESHOW_ACCUMULATION_HXX
  33
  34 #include <sal/types.h>
  35 #include <rtl/ustring.hxx>
  36
  37
  38 namespace slideshow
  39 {
  40     namespace internal
  41     {
  42         /** Generic accumulation.
  43
  44             This template handles value accumulation across repeated
  45             effect runs: returned is the end value times the repeat
  46             count, plus the current value.
  47
  48             @param rEndValue
  49             End value of the simple animation.
  50
  51             @param nRepeatCount
  52             Number of completed repeats (i.e. 0 during the first
  53             effect run)
  54
  55             @param rCurrValue
  56             Current animation value
  57          */
  58         template< typename ValueType > ValueType accumulate( const ValueType&   rEndValue,
  59                                                              sal_uInt32                 nRepeatCount,
  60                                                              const ValueType&   rCurrValue )
  61         {
  62             return nRepeatCount*rEndValue + rCurrValue;
  63         }
  64
  65         /// Specialization for non-addable enums/constant values
  66         template<> sal_Int16 accumulate< sal_Int16 >( const sal_Int16&,
  67                                                       sal_uInt32,
  68                                                       const sal_Int16&  rCurrValue )
  69         {
  70             // always return rCurrValue, it's forbidden to add enums/constant values...
  71             return rCurrValue;
  72         }
  73
  74         /// Specialization for non-addable strings
  75         template<> ::rtl::OUString accumulate< ::rtl::OUString >( const ::rtl::OUString&,
  76                                                                   sal_uInt32,
  77                                                                   const ::rtl::OUString&        rCurrValue )
  78         {
  79             // always return rCurrValue, it's impossible to add strings...
  80             return rCurrValue;
  81         }
  82
  83         /// Specialization for non-addable bools
  84         template<> bool accumulate< bool >( const bool&,
  85                                             sal_uInt32,
  86                                             const bool&         bCurrValue )
  87         {
  88             // always return bCurrValue, SMIL spec requires to ignore
  89             // cumulative behaviour for bools.
  90             return bCurrValue;
  91         }
  92     }
  93 }
  94
  95 #endif /* INCLUDED_SLIDESHOW_ACCUMULATION_HXX */