Commit 70469db9 authored by Jan Möbius's avatar Jan Möbius
Browse files

Another documentation update

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@15016 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 92608dc1
...@@ -193,13 +193,7 @@ void InterpolationAnimationT<PointT>::insertJointAt(unsigned int _index) ...@@ -193,13 +193,7 @@ void InterpolationAnimationT<PointT>::insertJointAt(unsigned int _index)
//----------------------------------------------------------------------------------------------------- //-----------------------------------------------------------------------------------------------------
/**
* @brief Called by the skeleton as a joint is deleted
*
* The call is dispatched to all poses stored in this animation. See BasePoseT::remove_at for more information.
*
* @param _index The index of the joint that is being deleted.
*/
template<class PointT> template<class PointT>
void InterpolationAnimationT<PointT>::removeJointAt(unsigned int _index) void InterpolationAnimationT<PointT>::removeJointAt(unsigned int _index)
{ {
......
...@@ -104,7 +104,20 @@ class InterpolationAnimationT : public AnimationT<PointT> ...@@ -104,7 +104,20 @@ class InterpolationAnimationT : public AnimationT<PointT>
* @{ */ * @{ */
//=========================================================================== //===========================================================================
/** \brief Returns a pointer to the pose calculated for the given frame
*
* @param _iFrame The frame number for which the pose should be calculated.
* This is always from 0..frames even if the animation starts with an input value other than 0.
*/
virtual Pose* pose(unsigned int _iFrame); virtual Pose* pose(unsigned int _iFrame);
/**
* @brief Returns a pointer to the pose calculated for the given frame
*
* @param _iFrame The frame number for which the pose should be calculated.
* This is always from 0..frames even if the animation starts with an input value other than 0.
* @param _reference Reference pose
*/
virtual Pose* pose(unsigned int _iFrame, Pose* _reference); virtual Pose* pose(unsigned int _iFrame, Pose* _reference);
/** /**
...@@ -129,6 +142,13 @@ class InterpolationAnimationT : public AnimationT<PointT> ...@@ -129,6 +142,13 @@ class InterpolationAnimationT : public AnimationT<PointT>
* @param _index The new joint is inserted at this position. Insert new joints at the end by passing SkeletonT::joints_.size as parameter. * @param _index The new joint is inserted at this position. Insert new joints at the end by passing SkeletonT::joints_.size as parameter.
*/ */
virtual void insertJointAt(unsigned int _index); virtual void insertJointAt(unsigned int _index);
/** \brief Called by the skeleton as a joint is deleted
*
* The call is dispatched to all poses stored in this animation. See BasePoseT::remove_at for more information.
*
* @param _index The index of the joint that is being deleted.
*/
virtual void removeJointAt(unsigned int _index); virtual void removeJointAt(unsigned int _index);
/** @} */ /** @} */
...@@ -140,8 +160,24 @@ class InterpolationAnimationT : public AnimationT<PointT> ...@@ -140,8 +160,24 @@ class InterpolationAnimationT : public AnimationT<PointT>
* We use only interpolators with time as input. * We use only interpolators with time as input.
* @{ */ * @{ */
//=========================================================================== //===========================================================================
/** \brief Add an interpolator
*
* @param _interpolator New interpolator
*/
void addInterpolator(InterpolationT<double> *_interpolator); void addInterpolator(InterpolationT<double> *_interpolator);
/** \brief Get the i-th interpolator
*
* @param _index Number of the interpolator
* @return Interpolator
*/
Interpolator* interpolator(unsigned int _index); Interpolator* interpolator(unsigned int _index);
/** \brief Get the number of interpolators
*
* @return Number of interpolators
*/
unsigned int interpolatorCount(); unsigned int interpolatorCount();
/** @} */ /** @} */
...@@ -168,6 +204,10 @@ class InterpolationAnimationT : public AnimationT<PointT> ...@@ -168,6 +204,10 @@ class InterpolationAnimationT : public AnimationT<PointT>
* @{ */ * @{ */
//=========================================================================== //===========================================================================
/** \brief Get the matrix manipulator
*
* @return MatrixManipulator
*/
MatrixManipulator* matrixManipulator() { return matrixManipulator_; } MatrixManipulator* matrixManipulator() { return matrixManipulator_; }
/** @} */ /** @} */
......
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