Commit 5c3950bb authored by Isaak Lim's avatar Isaak Lim

tried to fix some more Skeleton related doxygen warnings

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@15029 383ad7c9-94d9-4d36-a494-682f7c89f535
parent ef911d66
......@@ -102,7 +102,7 @@ class FrameAnimationT : public AnimationT<PointT>
*
* The call is dispatched to all poses stored in this animation. See BasePoseT<>::insert_at for more information.
*
* @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<>::jointCount as parameter.
*/
void insertJointAt(unsigned int _index);
......
......@@ -52,7 +52,7 @@
template<class PointT>
class InterpolationAnimationT : public AnimationT<PointT>
{
{
template<typename>
friend class SkeletonT;
......@@ -63,16 +63,16 @@ class InterpolationAnimationT : public AnimationT<PointT>
typedef InterpolationMatrixManipulatorT<Scalar> MatrixManipulator;
typedef InterpolationT<Scalar> Interpolator;
typedef std::vector<Scalar> TargetType;
public:
InterpolationAnimationT(const InterpolationAnimationT<PointT> &_other);
InterpolationAnimationT(Skeleton* _skeleton, MatrixManipulator *_matrixManipulator);
virtual ~InterpolationAnimationT();
virtual AnimationT<PointT>* copy();
virtual void updateFromGlobal(unsigned int _index);
virtual bool getMinInput(Scalar& _result);
virtual bool getMaxInput(Scalar& _result);
......@@ -91,7 +91,7 @@ class InterpolationAnimationT : public AnimationT<PointT>
std::map < unsigned int, Pose* > interpolatedPoses_;
unsigned int calcAbsoluteMaxForInterpolator(uint _index);
public:
static const int FPS = 60;
......@@ -139,20 +139,20 @@ class InterpolationAnimationT : public AnimationT<PointT>
*
* The call is dispatched to all poses stored in the animation. See BaseNode::insert_at for more information.
*
* @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<>::jointCount as parameter.
*/
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.
* 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);
/** @} */
//===========================================================================
/** @name Interpolators access
......
......@@ -64,11 +64,11 @@ class MultiInterpolationAnimationT : public InterpolationAnimationT<PointT>
MultiInterpolationAnimationT(const MultiInterpolationAnimationT<PointT> &_other);
MultiInterpolationAnimationT() : InterpolationAnimationT<PointT>(NULL, NULL), interpolationAnimations_() {}
MultiInterpolationAnimationT(const InterpolationAnimations& _interpolationAnimations) : interpolationAnimations_(_interpolationAnimations) {}
virtual AnimationT<PointT>* copy();
virtual void updateFromGlobal(unsigned int _index) {/*NOOP*/};
virtual bool getMinInput(Scalar& _result);
virtual bool getMaxInput(Scalar& _result);
......@@ -111,10 +111,23 @@ class MultiInterpolationAnimationT : public InterpolationAnimationT<PointT>
* Use these methods to keep the poses in sync with the number (and indices) of the joints.
* @{ */
//===========================================================================
/** \brief Called by the skeleton as a new joint is inserted
*
* The call is dispatched to all poses stored in the animation. See BaseNode::insert_at for more information.
*
* @param _index The new joint is inserted at this position. Insert new joints at the end by passing SkeletonT<>::joints_.size as parameter.
*/
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.
*/
void removeJointAt(unsigned int _index) {};
/** @} */
//===========================================================================
/** @name Animations access
*
......@@ -126,10 +139,10 @@ class MultiInterpolationAnimationT : public InterpolationAnimationT<PointT>
unsigned int animationCount() {
return interpolationAnimations_.size();
}
InterpolationAnimationT<PointT>* animation(unsigned int _index );
/** @} */
virtual void clearPoseCache() {
for (uint i=0; i < interpolationAnimations_.size(); ++i) {
interpolationAnimations_[i]->clearPoseCache();
......
......@@ -628,7 +628,7 @@ inline typename SkeletonT<PointT>::Joint *SkeletonT<PointT>::root()
*
* JointT<>::id_ is always equal to _index.
*
* @param _index The joints index, in the range [0, joints_.size)
* @param _index The joints index, in the range [0, SkeletonT<>::jointCount)
* @return Returns a pointer to the joint or 0 if the index does not exist.
*/
template<typename PointT>
......
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