Commit 92cbb304 authored by Isaak Lim's avatar Isaak Lim

fixed Skeleton doxygen warning

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@15042 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 93328a85
......@@ -47,6 +47,16 @@
//-----------------------------------------------------------------------------
/**
* @brief Constructor - Creates a new animation consisting of a single pose
*
* The animation will hold a single frame, made up by a copy of the given pose. After this call returns the
* pose given by \e _pose is no longer needed and independent from this instance.
*
* You can use this operation to clone the reference pose as new instance, then modify the pose.
*
* @param _pose This pose will make up the only frame in this new animation
*/
template<class PointT>
FrameAnimationT<PointT>::FrameAnimationT(const PoseT<PointT> &_pose) :
skeleton_(_pose.skeleton_)
......@@ -56,6 +66,10 @@ FrameAnimationT<PointT>::FrameAnimationT(const PoseT<PointT> &_pose) :
//-----------------------------------------------------------------------------
/** \brief Constructor - Creates a new empty animation
*
* @param _skeleton The skeleton that will hold this animation
*/
template<class PointT>
FrameAnimationT<PointT>::FrameAnimationT(Skeleton* _skeleton) :
skeleton_(_skeleton)
......@@ -64,6 +78,15 @@ FrameAnimationT<PointT>::FrameAnimationT(Skeleton* _skeleton) :
//-----------------------------------------------------------------------------
/**
* @brief Constructor - Creates a new animation with the given number of frames
*
* The poses in the given number of frames will all hold identity matrices for all joints. Make sure you write
* data to the poses before you use it.
*
* @param _skeleton The skeleton that will hold this animation
* @param _iNumFrames The number of frames for this animation
*/
template<class PointT>
FrameAnimationT<PointT>::FrameAnimationT(Skeleton* _skeleton, unsigned int _iNumFrames) :
skeleton_(_skeleton)
......@@ -74,6 +97,14 @@ FrameAnimationT<PointT>::FrameAnimationT(Skeleton* _skeleton, unsigned int _iNum
//-----------------------------------------------------------------------------
/**
* @brief Copy constructor
*
* This animation will copy all frames from the given animation. After the call returns they are completely
* independent.
*
* @param _other The animation to copy from
*/
template<class PointT>
FrameAnimationT<PointT>::FrameAnimationT(const FrameAnimationT<PointT> &_other) :
AnimationT<PointT>(),
......
......@@ -58,43 +58,12 @@ class FrameAnimationT : public AnimationT<PointT>
typedef PoseT<PointT> Pose;
public:
/**
* @brief Constructor - Creates a new animation consisting of a single pose
*
* The animation will hold a single frame, made up by a copy of the given pose. After this call returns the
* pose given by \e _pose is no longer needed and independent from this instance.
*
* You can use this operation to clone the reference pose as new instance, then modify the pose.
*
* @param _pose This pose will make up the only frame in this new animation
*/
FrameAnimationT(const Pose &_pose);
FrameAnimationT(const PoseT<PointT> &_pose);
/** \brief Constructor - Creates a new empty animation
*
* @param _skeleton The skeleton that will hold this animation
*/
FrameAnimationT(Skeleton* _skeleton);
/**
* @brief Constructor - Creates a new animation with the given number of frames
*
* The poses in the given number of frames will all hold identity matrices for all joints. Make sure you write
* data to the poses before you use it.
*
* @param _skeleton The skeleton that will hold this animation
* @param _iNumFrames The number of frames for this animation
*/
FrameAnimationT(Skeleton* _skeleton, unsigned int _iNumFrames);
/**
* @brief Copy constructor
*
* This animation will copy all frames from the given animation. After the call returns they are completely
* independent.
*
* @param _other The animation to copy from
*/
FrameAnimationT(const FrameAnimationT<PointT> &_other);
virtual ~FrameAnimationT();
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment