updated docs

This commit is contained in:
Davis King 2015-03-09 08:09:39 -04:00
parent 395a9a84f0
commit 15ac626ee8
2 changed files with 71 additions and 1 deletions

View File

@ -603,9 +603,13 @@
<item>vector</item>
<item>point</item>
<item>rotate_point</item>
<item>rotate_around_x</item>
<item>rotate_around_y</item>
<item>rotate_around_z</item>
<item>point_rotator</item>
<item>point_transform</item>
<item>point_transform_affine</item>
<item>point_transform_affine3d</item>
<item>find_affine_transform</item>
<item>find_similarity_transform</item>
<item>point_transform_projective</item>
@ -619,6 +623,7 @@
<item>shrink_rect</item>
<item>grow_rect</item>
<item>translate_rect</item>
<item>translate_point</item>
<item>resize_rect</item>
<item>resize_rect_width</item>
<item>resize_rect_height</item>
@ -1086,13 +1091,25 @@
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/point_transforms_abstract.h</spec_file>
<description>
This is an object that applies an affine transformation to a <a href="#vector">vector</a> or
This is an object that applies a 2D affine transformation to a <a href="#vector">vector</a> or
<a href="#point">point</a>. Note that you can use <a href="#find_affine_transform">find_affine_transform</a>
to easily create affine transforms from sets of point correspondences.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>point_transform_affine3d</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/point_transforms_abstract.h</spec_file>
<description>
This is an object that applies a 3D affine transformation to a <a href="#vector">vector</a>.
</description>
</component>
<!-- ************************************************************************* -->
<component>
@ -1163,6 +1180,54 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>rotate_around_x</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/point_transforms_abstract.h</spec_file>
<description>
This is a method for creating a <a href="#point_transform_affine3d">point_transform_affine3d</a>
that rotates points around the x-axis.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>rotate_around_y</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/point_transforms_abstract.h</spec_file>
<description>
This is a method for creating a <a href="#point_transform_affine3d">point_transform_affine3d</a>
that rotates points around the y-axis.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>rotate_around_z</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/point_transforms_abstract.h</spec_file>
<description>
This is a method for creating a <a href="#point_transform_affine3d">point_transform_affine3d</a>
that rotates points around the z-axis.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>translate_point</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/point_transforms_abstract.h</spec_file>
<description>
This is a method for creating a <a href="#point_transform_affine3d">point_transform_affine3d</a>
that just translates points.
</description>
</component>
<!-- ************************************************************************* -->
<component>

View File

@ -242,6 +242,11 @@
<term file="linear_algebra.html" name="point_rotator" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="point_transform" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="point_transform_affine" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="point_transform_affine3d" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="rotate_around_x" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="rotate_around_y" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="rotate_around_z" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="translate_point" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="find_affine_transform" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="find_similarity_transform" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="point_transform_projective" include="dlib/geometry.h"/>