1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef INCLUDED_SLIDESHOW_INTERPOLATION_HXX 25*b1cdbd2cSJim Jagielski #define INCLUDED_SLIDESHOW_INTERPOLATION_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <basegfx/tools/lerp.hxx> 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski namespace basegfx 30*b1cdbd2cSJim Jagielski { 31*b1cdbd2cSJim Jagielski namespace tools 32*b1cdbd2cSJim Jagielski { 33*b1cdbd2cSJim Jagielski // Interpolator specializations 34*b1cdbd2cSJim Jagielski // ============================ 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski // NOTE: generic lerp is included from lerp.hxx. Following 37*b1cdbd2cSJim Jagielski // are some specializations for various 38*b1cdbd2cSJim Jagielski // not-straight-forward-interpolatable types 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski /// Specialization for RGBColor, to employ color-specific interpolator lerp(const::slideshow::internal::RGBColor & rFrom,const::slideshow::internal::RGBColor & rTo,double t)41*b1cdbd2cSJim Jagielski template<> ::slideshow::internal::RGBColor lerp< ::slideshow::internal::RGBColor >( 42*b1cdbd2cSJim Jagielski const ::slideshow::internal::RGBColor& rFrom, 43*b1cdbd2cSJim Jagielski const ::slideshow::internal::RGBColor& rTo, 44*b1cdbd2cSJim Jagielski double t ) 45*b1cdbd2cSJim Jagielski { 46*b1cdbd2cSJim Jagielski return interpolate( rFrom, rTo, t ); 47*b1cdbd2cSJim Jagielski } 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski /// Specialization also for sal_Int16, although this code should not be called lerp(const sal_Int16 &,const sal_Int16 & rTo,double)50*b1cdbd2cSJim Jagielski template<> sal_Int16 lerp< sal_Int16 >( const sal_Int16&, 51*b1cdbd2cSJim Jagielski const sal_Int16& rTo, 52*b1cdbd2cSJim Jagielski double ) 53*b1cdbd2cSJim Jagielski { 54*b1cdbd2cSJim Jagielski OSL_ENSURE( false, 55*b1cdbd2cSJim Jagielski "lerp<sal_Int16> called" ); 56*b1cdbd2cSJim Jagielski return rTo; 57*b1cdbd2cSJim Jagielski } 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski /// Specialization also for string, although this code should not be called lerp(const::rtl::OUString &,const::rtl::OUString & rTo,double)60*b1cdbd2cSJim Jagielski template<> ::rtl::OUString lerp< ::rtl::OUString >( const ::rtl::OUString&, 61*b1cdbd2cSJim Jagielski const ::rtl::OUString& rTo, 62*b1cdbd2cSJim Jagielski double ) 63*b1cdbd2cSJim Jagielski { 64*b1cdbd2cSJim Jagielski OSL_ENSURE( false, 65*b1cdbd2cSJim Jagielski "lerp<::rtl::OUString> called" ); 66*b1cdbd2cSJim Jagielski return rTo; 67*b1cdbd2cSJim Jagielski } 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski /// Specialization also for bool, although this code should not be called lerp(const bool &,const bool & rTo,double)70*b1cdbd2cSJim Jagielski template<> bool lerp< bool >( const bool&, 71*b1cdbd2cSJim Jagielski const bool& rTo, 72*b1cdbd2cSJim Jagielski double ) 73*b1cdbd2cSJim Jagielski { 74*b1cdbd2cSJim Jagielski OSL_ENSURE( false, 75*b1cdbd2cSJim Jagielski "lerp<bool> called" ); 76*b1cdbd2cSJim Jagielski return rTo; 77*b1cdbd2cSJim Jagielski } 78*b1cdbd2cSJim Jagielski } 79*b1cdbd2cSJim Jagielski } 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski namespace slideshow 82*b1cdbd2cSJim Jagielski { 83*b1cdbd2cSJim Jagielski namespace internal 84*b1cdbd2cSJim Jagielski { 85*b1cdbd2cSJim Jagielski template< typename ValueType > struct Interpolator 86*b1cdbd2cSJim Jagielski { operator ()slideshow::internal::Interpolator87*b1cdbd2cSJim Jagielski ValueType operator()( const ValueType& rFrom, 88*b1cdbd2cSJim Jagielski const ValueType& rTo, 89*b1cdbd2cSJim Jagielski double t ) const 90*b1cdbd2cSJim Jagielski { 91*b1cdbd2cSJim Jagielski return basegfx::tools::lerp( rFrom, rTo, t ); 92*b1cdbd2cSJim Jagielski } 93*b1cdbd2cSJim Jagielski }; 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski /// Specialization for HSLColor, to employ color-specific interpolator 96*b1cdbd2cSJim Jagielski template<> struct Interpolator< HSLColor > 97*b1cdbd2cSJim Jagielski { Interpolatorslideshow::internal::Interpolator98*b1cdbd2cSJim Jagielski Interpolator( bool bCCW ) : 99*b1cdbd2cSJim Jagielski mbCCW( bCCW ) 100*b1cdbd2cSJim Jagielski { 101*b1cdbd2cSJim Jagielski } 102*b1cdbd2cSJim Jagielski operator ()slideshow::internal::Interpolator103*b1cdbd2cSJim Jagielski HSLColor operator()( const HSLColor& rFrom, 104*b1cdbd2cSJim Jagielski const HSLColor& rTo, 105*b1cdbd2cSJim Jagielski double t ) const 106*b1cdbd2cSJim Jagielski { 107*b1cdbd2cSJim Jagielski return interpolate( rFrom, rTo, t, mbCCW ); 108*b1cdbd2cSJim Jagielski } 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski private: 111*b1cdbd2cSJim Jagielski /// When true: interpolate counter-clockwise 112*b1cdbd2cSJim Jagielski const bool mbCCW; 113*b1cdbd2cSJim Jagielski }; 114*b1cdbd2cSJim Jagielski 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski /** Generic linear interpolator 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski @tpl ValueType 119*b1cdbd2cSJim Jagielski Must have operator+ and operator* defined, and should 120*b1cdbd2cSJim Jagielski have value semantics. 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski @param rInterpolator 123*b1cdbd2cSJim Jagielski Interpolator to use for lerp 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski @param nFrame 126*b1cdbd2cSJim Jagielski Must be in the [0,nTotalFrames) range 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski @param nTotalFrames 129*b1cdbd2cSJim Jagielski Total number of frames. Should be greater than zero. 130*b1cdbd2cSJim Jagielski */ lerp(const Interpolator<ValueType> & rInterpolator,const ValueType & rFrom,const ValueType & rTo,sal_uInt32 nFrame,::std::size_t nTotalFrames)131*b1cdbd2cSJim Jagielski template< typename ValueType > ValueType lerp( const Interpolator< ValueType >& rInterpolator, 132*b1cdbd2cSJim Jagielski const ValueType& rFrom, 133*b1cdbd2cSJim Jagielski const ValueType& rTo, 134*b1cdbd2cSJim Jagielski sal_uInt32 nFrame, 135*b1cdbd2cSJim Jagielski ::std::size_t nTotalFrames ) 136*b1cdbd2cSJim Jagielski { 137*b1cdbd2cSJim Jagielski // TODO(P1): There's a nice HAKMEM trick for that 138*b1cdbd2cSJim Jagielski // nTotalFrames > 1 condition below 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski // for 1 and 0 frame animations, always take end value 141*b1cdbd2cSJim Jagielski const double nFraction( nTotalFrames > 1 ? double(nFrame)/(nTotalFrames-1) : 1.0 ); 142*b1cdbd2cSJim Jagielski 143*b1cdbd2cSJim Jagielski return rInterpolator( rFrom, rTo, nFraction ); 144*b1cdbd2cSJim Jagielski } 145*b1cdbd2cSJim Jagielski 146*b1cdbd2cSJim Jagielski /// Specialization for non-interpolatable constants/enums lerp(const Interpolator<sal_Int16> &,const sal_Int16 & rFrom,const sal_Int16 & rTo,sal_uInt32 nFrame,::std::size_t nTotalFrames)147*b1cdbd2cSJim Jagielski template<> sal_Int16 lerp< sal_Int16 >( const Interpolator< sal_Int16 >& /*rInterpolator*/, 148*b1cdbd2cSJim Jagielski const sal_Int16& rFrom, 149*b1cdbd2cSJim Jagielski const sal_Int16& rTo, 150*b1cdbd2cSJim Jagielski sal_uInt32 nFrame, 151*b1cdbd2cSJim Jagielski ::std::size_t nTotalFrames ) 152*b1cdbd2cSJim Jagielski { 153*b1cdbd2cSJim Jagielski // until one half of the total frames are over, take from value. 154*b1cdbd2cSJim Jagielski // after that, take to value. 155*b1cdbd2cSJim Jagielski // For nFrames not divisable by 2, we prefer to over from, which 156*b1cdbd2cSJim Jagielski // also neatly yields to for 1 frame activities 157*b1cdbd2cSJim Jagielski return nFrame < nTotalFrames/2 ? rFrom : rTo; 158*b1cdbd2cSJim Jagielski } 159*b1cdbd2cSJim Jagielski 160*b1cdbd2cSJim Jagielski /// Specialization for non-interpolatable strings lerp(const Interpolator<::rtl::OUString> &,const::rtl::OUString & rFrom,const::rtl::OUString & rTo,sal_uInt32 nFrame,::std::size_t nTotalFrames)161*b1cdbd2cSJim Jagielski template<> ::rtl::OUString lerp< ::rtl::OUString >( const Interpolator< ::rtl::OUString >& /*rInterpolator*/, 162*b1cdbd2cSJim Jagielski const ::rtl::OUString& rFrom, 163*b1cdbd2cSJim Jagielski const ::rtl::OUString& rTo, 164*b1cdbd2cSJim Jagielski sal_uInt32 nFrame, 165*b1cdbd2cSJim Jagielski ::std::size_t nTotalFrames ) 166*b1cdbd2cSJim Jagielski { 167*b1cdbd2cSJim Jagielski // until one half of the total frames are over, take from value. 168*b1cdbd2cSJim Jagielski // after that, take to value. 169*b1cdbd2cSJim Jagielski // For nFrames not divisable by 2, we prefer to over from, which 170*b1cdbd2cSJim Jagielski // also neatly yields to for 1 frame activities 171*b1cdbd2cSJim Jagielski return nFrame < nTotalFrames/2 ? rFrom : rTo; 172*b1cdbd2cSJim Jagielski } 173*b1cdbd2cSJim Jagielski 174*b1cdbd2cSJim Jagielski /// Specialization for non-interpolatable bools lerp(const Interpolator<bool> &,const bool & bFrom,const bool & bTo,sal_uInt32 nFrame,::std::size_t nTotalFrames)175*b1cdbd2cSJim Jagielski template<> bool lerp< bool >( const Interpolator< bool >& /*rInterpolator*/, 176*b1cdbd2cSJim Jagielski const bool& bFrom, 177*b1cdbd2cSJim Jagielski const bool& bTo, 178*b1cdbd2cSJim Jagielski sal_uInt32 nFrame, 179*b1cdbd2cSJim Jagielski ::std::size_t nTotalFrames ) 180*b1cdbd2cSJim Jagielski { 181*b1cdbd2cSJim Jagielski // until one half of the total frames are over, take from value. 182*b1cdbd2cSJim Jagielski // after that, take to value. 183*b1cdbd2cSJim Jagielski // For nFrames not divisable by 2, we prefer to over from, which 184*b1cdbd2cSJim Jagielski // also neatly yields to for 1 frame activities 185*b1cdbd2cSJim Jagielski return nFrame < nTotalFrames/2 ? bFrom : bTo; 186*b1cdbd2cSJim Jagielski } 187*b1cdbd2cSJim Jagielski } 188*b1cdbd2cSJim Jagielski } 189*b1cdbd2cSJim Jagielski 190*b1cdbd2cSJim Jagielski #endif /* INCLUDED_SLIDESHOW_INTERPOLATION_HXX */ 191