Commit 589e5456 authored by Jan Möbius's avatar Jan Möbius
Browse files

Try to fix documentation errors

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@14814 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 7aca3901
......@@ -96,83 +96,98 @@ class InterpolationAnimationT : public AnimationT<PointT>
static const int FPS = 60;
public:
/**
* @name Frame access
* There is one pose per frame.
*/
//@{
//===========================================================================
/** @name Frame access
*
* There is one pose per frame.
* @{ */
//===========================================================================
virtual Pose* pose(unsigned int _iFrame);
virtual Pose* pose(unsigned int _iFrame, Pose* _reference);
inline unsigned int frameCount();
//@}
/**
* @name Synchronization
* Use these methods to keep the poses in sync with the number (and indices) of the joints.
*/
//@{
/** @} */
//===========================================================================
/** @name Synchronization
*
* Use these methods to keep the poses in sync with the number (and indices) of the joints.
* @{ */
//===========================================================================
virtual void insertJointAt(unsigned int _index);
virtual void removeJointAt(unsigned int _index);
//@}
/** @} */
/**
* @name Interpolators access
*/
//@{
// We use only interpolators with time as input.
//===========================================================================
/** @name Interpolators access
*
* We use only interpolators with time as input.
* @{ */
//===========================================================================
void addInterpolator(InterpolationT<double> *_interpolator);
Interpolator* interpolator(unsigned int _index);
unsigned int interpolatorCount();
//@}
/**
* @name InfluencedJoints access
*/
//@{
void addInfluencedJoint(int _joint) {
influencedJoints_.push_back(_joint);
}
bool isInfluenced(int _joint);
std::vector<int>& influencedJoints();
//@}
/**
* @name MatrixManipulator access
*/
//@{
MatrixManipulator* matrixManipulator() {
return matrixManipulator_;
}
//@}
Pose* getReference() {
return pose(0);
}
/** @} */
virtual void clearPoseCache() {
if (interpolatedPoses_.size() == 1 && interpolatedPoses_.find(0) != interpolatedPoses_.end())
return;
if (interpolatedPoses_.find(0) != interpolatedPoses_.end()) {
// Pose* frame0 = (interpolatedPoses_.find(0)->second);
if (interpolatedPoses_.size() > 1) {
typename std::map< unsigned int, Pose* >::iterator ip_it = interpolatedPoses_.begin();
++ip_it;
for ( ; ip_it != interpolatedPoses_.end(); ++ip_it) {
delete ip_it->second;
interpolatedPoses_.erase(ip_it);
}
}
// interpolatedPoses_.insert(std::pair<unsigned int, Pose>(0, frame0));
} else {
interpolatedPoses_.clear();
//===========================================================================
/** @name InfluencedJoints access
*
* @{ */
//===========================================================================
void addInfluencedJoint(int _joint)
{
influencedJoints_.push_back(_joint);
}
bool isInfluenced(int _joint);
std::vector<int>& influencedJoints();
/** @} */
//===========================================================================
/** @name MatrixManipulator access
*
* @{ */
//===========================================================================
MatrixManipulator* matrixManipulator() { return matrixManipulator_; }
/** @} */
Pose* getReference() { return pose(0); }
virtual void clearPoseCache()
{
if (interpolatedPoses_.size() == 1 && interpolatedPoses_.find(0) != interpolatedPoses_.end())
return;
if (interpolatedPoses_.find(0) != interpolatedPoses_.end()) {
// Pose* frame0 = (interpolatedPoses_.find(0)->second);
if (interpolatedPoses_.size() > 1) {
typename std::map<unsigned int, Pose*>::iterator ip_it = interpolatedPoses_.begin();
++ip_it;
for (; ip_it != interpolatedPoses_.end(); ++ip_it) {
delete ip_it->second;
interpolatedPoses_.erase(ip_it);
}
}
// interpolatedPoses_.insert(std::pair<unsigned int, Pose>(0, frame0));
} else {
interpolatedPoses_.clear();
}
}
};
//=============================================================================
......@@ -182,4 +197,4 @@ class InterpolationAnimationT : public AnimationT<PointT>
#endif
//=============================================================================
#endif //INTERPOLATIONANIMATIONT_HH
\ No newline at end of file
#endif //INTERPOLATIONANIMATIONT_HH
......@@ -47,8 +47,7 @@
//-----------------------------------------------------------------------------------------------------
/**
* @brief Copy constructor
/** \brief Copy constructor
*
* @param _other The animation to copy from
*/
......@@ -108,8 +107,8 @@ bool MultiInterpolationAnimationT<PointT>::getMaxInput(Scalar& _result) {
//-----------------------------------------------------------------------------------------------------
/**
* @brief Returns the number of frames that this animation can playback
/** \brief Returns the number of frames that this animation can playback
*
* Note that this is not simply the sum of all animations' frame counts, as they can (and most likely will) overlap.
*/
template<class PointT>
......
......@@ -79,11 +79,14 @@ class MultiInterpolationAnimationT : public InterpolationAnimationT<PointT>
using InterpolationAnimationT<PointT>::FPS;
public:
/**
* @name Frame access
* There is one pose per frame.
*/
//@{
//===========================================================================
/** @name Frame access
*
* There is one pose per frame.
*
* @{ */
//===========================================================================
/** \brief get a pose
*
......@@ -100,21 +103,23 @@ class MultiInterpolationAnimationT : public InterpolationAnimationT<PointT>
*/
virtual Pose *pose(unsigned int _iFrame, Pose* _reference);
virtual unsigned int frameCount();
//@}
/** @} */
/**
* @name Synchronization
* Use these methods to keep the poses in sync with the number (and indices) of the joints.
*/
//@{
//===========================================================================
/** @name Synchronization
*
* Use these methods to keep the poses in sync with the number (and indices) of the joints.
* @{ */
//===========================================================================
void insertJointAt(unsigned int _index) {};
void removeJointAt(unsigned int _index) {};
//@}
/** @} */
/**
* @name Animations access
*/
//@{
//===========================================================================
/** @name Animations access
*
* @{ */
//===========================================================================
void addInterpolationAnimation(InterpolationAnimationT<PointT> *_animation) {
interpolationAnimations_.push_back(_animation);
}
......@@ -123,8 +128,7 @@ class MultiInterpolationAnimationT : public InterpolationAnimationT<PointT>
}
InterpolationAnimationT<PointT>* animation(unsigned int _index );
//@}
/** @} */
virtual void clearPoseCache() {
for (uint i=0; i < interpolationAnimations_.size(); ++i) {
......
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