kotovalexarian-likes-github/ruby-opencv
1
0
Fork 0
mirror of https://github.com/ruby-opencv/ruby-opencv synced 2023-03-27 23:22:12 -04:00
Code Releases Activity

add documents of CvConvexityDefect

Browse source
This commit is contained in:
ser1zw 2012-05-31 02:58:54 +09:00
parent 9f890573db
commit c04f68978d
3 changed files with 35 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

77
ext/opencv/cvconvexitydefect.cpp
View file

@ -11,15 +11,7 @@
/*
* Document-class: OpenCV::CvConvexityDefect
*
* Convexity.
* C structure is here.
* typedef struct CvConvexityDefect {
* CvPoint* start;
* CvPoint* end;
* CvPoint* depth_point;
* float depth;
* } CvConvexityDefect;
*
* Convexity defect
*/
__NAMESPACE_BEGIN_OPENCV
__NAMESPACE_BEGIN_CVCONVEXITYDEFECT
@ -32,30 +24,10 @@ rb_class()
return rb_klass;
}
void
define_ruby_class()
{
if (rb_klass)
return;
/*
* opencv = rb_define_module("OpenCV");
*
* note: this comment is used by rdoc.
*/
VALUE opencv = rb_module_opencv();
rb_klass = rb_define_class_under(opencv, "CvConvexityDefect", rb_cObject);
rb_define_method(rb_klass, "start", RUBY_METHOD_FUNC(rb_start), 0);
rb_define_method(rb_klass, "end", RUBY_METHOD_FUNC(rb_end), 0);
rb_define_method(rb_klass, "depth_point", RUBY_METHOD_FUNC(rb_depth_point), 0);
rb_define_method(rb_klass, "depth", RUBY_METHOD_FUNC(rb_depth), 0);
}
/*
* call-seq:
* start -> cvpoint
*
* Return start point as CvPoint.
* Returns the point of the contour where the defect begins
* @overload start
* @return [CvPoint] Start point of the contour
*/
VALUE
rb_start(VALUE self)
@ -64,10 +36,9 @@ rb_start(VALUE self)
}
/*
* call-seq:
* end -> cvpoint
*
* Return end point as CvPoint.
* Returns the point of the contour where the defect ends
* @overload end
* @return [CvPoint] End point of the contour
*/
VALUE
rb_end(VALUE self)
@ -76,10 +47,9 @@ rb_end(VALUE self)
}
/*
* call-seq:
* depth_point -> cvpoint
*
* Return depth point as CvPoint.
* Returns the farthest from the convex hull point within the defect
* @overload depth_point
* @return [CvPoint] The farthest from the convex hull point within the defect
*/
VALUE
rb_depth_point(VALUE self)
@ -88,10 +58,9 @@ rb_depth_point(VALUE self)
}
/*
* call-seq:
* depth -> float
*
* Return depth.
* Returns distance between the farthest point and the convex hull
* @overload depth
* @return [Number] Distance between the farthest point and the convex hull
*/
VALUE
rb_depth(VALUE self)
@ -99,5 +68,25 @@ rb_depth(VALUE self)
return rb_float_new(CVCONVEXITYDEFECT(self)->depth);
}
void
init_ruby_class()
{
#if 0
// For documentation using YARD
VALUE opencv = rb_define_module("OpenCV");
#endif
if (rb_klass)
return;
VALUE opencv = rb_module_opencv();
rb_klass = rb_define_class_under(opencv, "CvConvexityDefect", rb_cObject);
rb_define_method(rb_klass, "start", RUBY_METHOD_FUNC(rb_start), 0);
rb_define_method(rb_klass, "end", RUBY_METHOD_FUNC(rb_end), 0);
rb_define_method(rb_klass, "depth_point", RUBY_METHOD_FUNC(rb_depth_point), 0);
rb_define_method(rb_klass, "depth", RUBY_METHOD_FUNC(rb_depth), 0);
}
__NAMESPACE_END_CVCONVEXITYDEFECT
__NAMESPACE_END_OPENCV

2
ext/opencv/cvconvexitydefect.h
View file

@ -20,7 +20,7 @@ __NAMESPACE_BEGIN_CVCONVEXITYDEFECT
VALUE rb_class();
void define_ruby_class();
void init_ruby_class();
VALUE rb_start(VALUE self);
VALUE rb_end(VALUE self);

2
ext/opencv/opencv.cpp
View file

@ -662,7 +662,7 @@ extern "C" {
mOpenCV::cIplConvKernel::define_ruby_class();
mOpenCV::cCvMoments::define_ruby_class();
mOpenCV::cCvHuMoments::define_ruby_class();
mOpenCV::cCvConvexityDefect::define_ruby_class();
mOpenCV::cCvConvexityDefect::init_ruby_class();
mOpenCV::cCvSURFPoint::define_ruby_class();
mOpenCV::cCvSURFParams::define_ruby_class();