Commit 4e53e55a authored by Jan Möbius's avatar Jan Möbius
Browse files

Added Documentation for flyTo

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@2802 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 93bc5620
...@@ -308,7 +308,7 @@ ACG::GLState& glState(); ...@@ -308,7 +308,7 @@ ACG::GLState& glState();
/// Returns a QImage of the current View /// Returns a QImage of the current View
DLLEXPORT DLLEXPORT
void getCurrentViewImage(QImage& _image); void getCurrentViewImage(QImage& _image);
/// Get the root node /// Get the root node
DLLEXPORT DLLEXPORT
...@@ -366,26 +366,26 @@ DLLEXPORT ...@@ -366,26 +366,26 @@ DLLEXPORT
void setScenePos(const ACG::Vec3d& _center, double _radius); void setScenePos(const ACG::Vec3d& _center, double _radius);
/** \brief Set the scene position (Same as setScenePos(const ACG::Vec3d& _center, double _radius) ) /** \brief Set the scene position (Same as setScenePos(const ACG::Vec3d& _center, double _radius) )
* *
*/ */
DLLEXPORT DLLEXPORT
void setScenePos(const ACG::Vec3d& _center); void setScenePos(const ACG::Vec3d& _center);
/** \brief Get the current scene center /** \brief Get the current scene center
* *
*/ */
DLLEXPORT DLLEXPORT
const ACG::Vec3d& sceneCenter(); const ACG::Vec3d& sceneCenter();
/** \brief Returns the current scene radius from the examiner widget /** \brief Returns the current scene radius from the examiner widget
* *
* Returns the Radius of the scene * Returns the Radius of the scene
*/ */
DLLEXPORT DLLEXPORT
double sceneRadius(); double sceneRadius();
/** \brief Translate viewer pos by given vector /** \brief Translate viewer pos by given vector
* *
* Translates the scene by a given vector. ( This is only a view transformation and does not * Translates the scene by a given vector. ( This is only a view transformation and does not
* effect the scene center. To really translate the scene, use setScenePos ); * effect the scene center. To really translate the scene, use setScenePos );
* @param _vector translation * @param _vector translation
...@@ -394,15 +394,15 @@ DLLEXPORT ...@@ -394,15 +394,15 @@ DLLEXPORT
void translate( const ACG::Vec3d &_vector ); void translate( const ACG::Vec3d &_vector );
/** \brief Rotate Scene around axis /** \brief Rotate Scene around axis
* *
* Rotates the current scene. * Rotates the current scene.
* @param _axis Rotation axis * @param _axis Rotation axis
* @param _angle Rotation Angle * @param _angle Rotation Angle
* @param _center Rotation Center * @param _center Rotation Center
*/ */
DLLEXPORT DLLEXPORT
void rotate(const ACG::Vec3d& _axis, void rotate(const ACG::Vec3d& _axis,
double _angle, double _angle,
const ACG::Vec3d& _center); const ACG::Vec3d& _center);
...@@ -483,7 +483,11 @@ void mapToLocal( OpenMesh::Vec4f _color); ...@@ -483,7 +483,11 @@ void mapToLocal( OpenMesh::Vec4f _color);
* @{ */ * @{ */
//======================================= //=======================================
/// Fly to point and viewing direction (animated). /** Fly to point and viewing direction (animated).
* @param _position New viewer position ( the new eye point of the viewer )
* @param _center The new scene center ( the point we are looking at )
* @param _time Animation time in ms
*/
DLLEXPORT DLLEXPORT
void flyTo (const TriMesh::Point &_position, const TriMesh::Point &_center, double _time=1000.0); void flyTo (const TriMesh::Point &_position, const TriMesh::Point &_center, double _time=1000.0);
......
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