anki-3d-engine/include/anki/resource/Animation.h

// Copyright (C) 2009-2015, Panagiotis Christopoulos Charitos.
// All rights reserved.
// Code licensed under the BSD License.
// http://www.anki3d.org/LICENSE

#ifndef ANKI_RESOURCE_ANIMATION_H
#define ANKI_RESOURCE_ANIMATION_H

#include "anki/Math.h"
#include "anki/resource/Common.h"
#include "anki/util/String.h"

namespace anki {

class XmlElement;

/// @addtogroup resource
/// @{

/// A keyframe 
template<typename T> 
class Key
{
	friend class Animation;

public:
	F32 getTime() const
	{
		return m_time;
	}

	const T& getValue() const
	{
		return m_value;
	}

private:
	F32 m_time;
	T m_value;
};

/// Animation channel
class AnimationChannel
{
public:
	ResourceString m_name;

	I32 m_boneIndex = -1; ///< For skeletal animations

	ResourceDArray<Key<Vec3>> m_positions;
	ResourceDArray<Key<Quat>> m_rotations;
	ResourceDArray<Key<F32>> m_scales;
	ResourceDArray<Key<F32>> m_cameraFovs;

	void destroy(ResourceAllocator<U8>& alloc)
	{
		m_name.destroy(alloc);
		m_positions.destroy(alloc);
		m_rotations.destroy(alloc);
		m_scales.destroy(alloc);
		m_cameraFovs.destroy(alloc);
	}
};

/// Animation consists of keyframe data
class Animation
{
public:
	Animation(ResourceAllocator<U8>& alloc);

	~Animation();

	ANKI_USE_RESULT Error load(
		const CString& filename, ResourceInitializer& init);

	/// Get a vector of all animation channels
	const ResourceDArray<AnimationChannel>& getChannels() const
	{
		return m_channels;
	}

	/// Get the duration of the animation in seconds
	F32 getDuration() const
	{
		return m_duration;
	}

	/// Get the time (in seconds) the animation should start
	F32 getStartingTime() const
	{
		return m_startTime;
	}

	/// The animation repeats
	Bool getRepeat() const
	{
		return m_repeat;
	}

	/// Get the interpolated data
	void interpolate(U channelIndex, F32 time, 
		Vec3& position, Quat& rotation, F32& scale) const;

private:
	ResourceAllocator<U8> m_alloc;
	ResourceDArray<AnimationChannel> m_channels;
	F32 m_duration;
	F32 m_startTime;
	Bool8 m_repeat;

	void loadInternal(const XmlElement& el, ResourceInitializer& init);
};
/// @}

} // end namespace anki

#endif