Commit 563dff9a authored by Jan Möbius's avatar Jan Möbius
Browse files

Basic description for triangular and polygonal mesh datatype

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@10908 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 480bfd39
/** \page polyMeshType Poly Mesh
/** \page polyMeshType Polygonal Mesh
\image html type_poly_thumb.png
*/
\section type_PolyMesh_info Datatype Information
OpenFlipper includes a datatype for polygonal Meshes. The datastructure used to represent the
Mesh is \ref OpenMeshDoc "OpenMesh". %OpenMesh is a generic and efficient data structure for
representing and manipulating polygonal meshes. You can directly use it inside of OpenFlipper.\n
The basic object type for handling polygonal meshes is the PolyMeshObject. This object manages
rendering and data storage of a polygonal %OpenMesh.\n
To get the actual mesh you can call the PolyMeshObject::mesh() function which returns a pointer
to the %OpenMesh structure, which can be directly manipulated with the functions described in
the \ref OpenMeshDoc "OpenMesh Documentation".\n
Note: If you know that you only work on triangular meshes, use the \ref triMeshType "Triangular Mesh datatype".\n
*/
......@@ -140,8 +140,8 @@ TriMeshObject* triMeshObject( BaseObjectData* _object );
/** \brief Get an TriMeshObject from the given id If possible
*
* @param _objectId Id of the requested Object. If the content is a volume, a
* a TriMeshObject is returned. Otherwise a NULL pointer is returned.
* @param _objectId Id of the requested Object.
* @return If the content is a volume, a pointer to the TriMeshObject is returned, otherwise a NULL pointer.
*/
DLLEXPORT
TriMeshObject* triMeshObject( int _objectId );
......
/** \page triMeshType Triangular Mesh
/**
\page triMeshType Triangular Mesh
\image html type_triangle_thumb.png
\section type_TriMesh_info Datatype Information
OpenFlipper includes a datatype for triangular Meshes. The datastructure used to represent the
Mesh is \ref OpenMeshDoc "OpenMesh". %OpenMesh is a generic and efficient data structure for
representing and manipulating polygonal meshes. You can directly use it inside of OpenFlipper.\n
The basic object type for handling triangular meshes is the TriMeshObject. This object manages
rendering and data storage of a triangular %OpenMesh.\n
To get the actual mesh you can call the TriMeshObject::mesh() function which returns a pointer
to the %OpenMesh structure, which can be directly manipulated with the functions described in
the \ref OpenMeshDoc "OpenMesh Documentation".\n
*/
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