documentation extremity functions

This commit is contained in:
Amandinella 2015-03-09 16:07:42 +01:00
parent 8759555f47
commit 59d3a22cb0
1 changed files with 35 additions and 3 deletions

View File

@ -108,17 +108,49 @@ class Skeleton3D
////////////////////////////////////////////////////////////
/// \brief meshExtremities : compute the extremities as a mesh
///
/// \param the mesh and the circles associated to the splines
///
/// \param mesh the mesh
/// \param splines_circles the circles associated to the splines
/// \param profondeur the depth of the subdivision
////////////////////////////////////////////////////////////
void meshExtremities(geo::Mesh& mesh, std::vector<std::vector<geo::Circle<float>>> const& splines_circles, unsigned int profondeur) const;
////////////////////////////////////////////////////////////
/// \brief meshExtremity : compute one extremity
///
/// \param mesh the mesh
/// \param splines_circles the circles associated to the splines
/// \param profondeur the depth of the subdivision
/// \param extremity the extremity concerned
////////////////////////////////////////////////////////////
void meshExtremity(geo::Mesh& mesh, std::vector<std::vector<geo::Circle<float>>> const& splines_circles, unsigned int profondeur, std::pair<unsigned int,float> extremity) const;
///////////////////////////////////////////////////////////
/// \brief subdivision : subdivise all the segment along
/// the extremity
/// \param mesh the mesh
/// \param profondeur the depth of the subdivision
/// \param extremCircle the circle associated to the extremity
/// \param intersectionIndex the index of the intersection point
/// \param intersection the intersection point
/// \param center the center of the sphere
/// \param radius the radius of the sphere
/// \param t the time where is the extremity on the spline
//////////////////////////////////////////////////////////
void subdivision(geo::Mesh& mesh, unsigned int profondeur, geo::Circle<float> extremCircle, unsigned int intersectionIndex, geo::Vector3<float> intersection, geo::Vector3<float> center, float radius, float t) const;
/////////////////////////////////////////////////////////
/// \brief arcSubdivide : the subdivision on one segment
///
/// \param pt1 the first point on the segment
/// \param pt2 the second point on the segment
/// \param profondeur the depth of the subdivision
/// \param arc the segment [pt1 pt2] with the points inside
/// \param center the center of the sphere
/// \param radius the radius of the sphere
////////////////////////////////////////////////////////
void arcSubdivise(geo::Vector3<float> pt1, geo::Vector3<float> pt2, unsigned int profondeur, std::vector<geo::Vector3<float>>& arc, geo::Vector3<float> center, float radius) const;
geo::Mesh computeMesh(float pointsProportion = 10, unsigned int nbPointsPerCircle = 18u, unsigned int depth = 2, bool withExtremities=true, bool withJunctions=true) const;
geo::Mesh computeMesh(float pointsProportion = 10, unsigned int nbPointsPerCircle = 18u, unsigned int depth = 10, bool withExtremities=true, bool withJunctions=true) const;
template<typename... T>
friend std::ostream& operator<<(std::ostream& out, Skeleton3D<T...> const& s);