/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#ifndef INCLUDED_DRAWINGLAYER_ANIMATION_ANIMATIONTIMING_HXX
#define INCLUDED_DRAWINGLAYER_ANIMATION_ANIMATIONTIMING_HXX

#include <drawinglayer/drawinglayerdllapi.h>
#include <vector>

//////////////////////////////////////////////////////////////////////////////

namespace drawinglayer
{
	namespace animation
	{
		//////////////////////////////////////////////////////////////////////////////

		class DRAWINGLAYER_DLLPUBLIC AnimationEntry
		{
		private:
			AnimationEntry(const AnimationEntry&);
			AnimationEntry& operator=(const AnimationEntry& rCandidate);

		public:
			AnimationEntry();
			virtual ~AnimationEntry();
			virtual AnimationEntry* clone() const = 0;

			virtual bool operator==(const AnimationEntry& rCandidate) const = 0;
			virtual double getDuration() const = 0;
			virtual double getStateAtTime(double fTime) const = 0;
			virtual double getNextEventTime(double fTime) const = 0;
		};

		//////////////////////////////////////////////////////////////////////////////

		class DRAWINGLAYER_DLLPUBLIC AnimationEntryFixed : public AnimationEntry
		{
		protected:
			double										mfDuration;
			double										mfState;

		public:
			AnimationEntryFixed(double fDuration, double fState = 0.0);
			virtual ~AnimationEntryFixed();
			virtual AnimationEntry* clone() const;

			virtual bool operator==(const AnimationEntry& rCandidate) const;
			virtual double getDuration() const;
			virtual double getStateAtTime(double fTime) const;
			virtual double getNextEventTime(double fTime) const;
		};

		//////////////////////////////////////////////////////////////////////////////

		class DRAWINGLAYER_DLLPUBLIC AnimationEntryLinear : public AnimationEntry
		{
		protected:
			double										mfDuration;
			double										mfFrequency;
			double										mfStart;
			double										mfStop;

		public:
			AnimationEntryLinear(double fDuration, double fFrequency = 250.0, double fStart = 0.0, double fStop = 1.0);
			virtual ~AnimationEntryLinear();
			virtual AnimationEntry* clone() const;

			virtual bool operator==(const AnimationEntry& rCandidate) const;
			virtual double getDuration() const;
			virtual double getStateAtTime(double fTime) const;
			virtual double getNextEventTime(double fTime) const;
		};

		//////////////////////////////////////////////////////////////////////////////

		class DRAWINGLAYER_DLLPUBLIC AnimationEntryList : public AnimationEntry
		{
		protected:
			double										mfDuration;
			::std::vector< AnimationEntry* >			maEntries;

			// helpers
			sal_uInt32 impGetIndexAtTime(double fTime, double &rfAddedTime) const;

		public:
			AnimationEntryList();
			virtual ~AnimationEntryList();
			virtual AnimationEntry* clone() const;

			virtual bool operator==(const AnimationEntry& rCandidate) const;
			void append(const AnimationEntry& rCandidate);
			virtual double getDuration() const;
			virtual double getStateAtTime(double fTime) const;
			virtual double getNextEventTime(double fTime) const;
		};

		//////////////////////////////////////////////////////////////////////////////

		class DRAWINGLAYER_DLLPUBLIC AnimationEntryLoop : public AnimationEntryList
		{
		protected:
			sal_uInt32									mnRepeat;

		public:
			AnimationEntryLoop(sal_uInt32 nRepeat = 0xffffffff);
			virtual ~AnimationEntryLoop();
			virtual AnimationEntry* clone() const;

			virtual bool operator==(const AnimationEntry& rCandidate) const;
			virtual double getDuration() const;
			virtual double getStateAtTime(double fTime) const;
			virtual double getNextEventTime(double fTime) const;
		};

		//////////////////////////////////////////////////////////////////////////////
	} // end of namespace animation
} // end of namespace drawinglayer

//////////////////////////////////////////////////////////////////////////////

#endif //INCLUDED_DRAWINGLAYER_ANIMATION_ANIMATIONTIMING_HXX

// eof