tutorial_03.docu 3.65 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1 2 3
/** \page tutorial_03 Using (custom) properties

This examples shows:
4
- How to add and remove custom properties
Jan Möbius's avatar
Jan Möbius committed
5 6 7 8 9 10 11 12 13
- How to get and set the value of a custom property

In the last example we computed the barycenter of each vertex'
neighborhood and stored it in an array. It would be more convenient
and less error-prone if we could store this data in the mesh and
let %OpenMesh manage the data.
It would be even more helpful if we could attach such properties
dynamically to the mesh.

14 15 16 17
Custom properties can be conveniently created and attached to meshes with the following functions:
- makeTemporaryProperty() creates a property that is temporary to the current scope.
- getOrMakeProperty() is used for creating and accessing permanent named properties on a mesh.
- getProperty() is used for accessing an existing permanent named property on a mesh.
Jan Möbius's avatar
Jan Möbius committed
18

19 20 21 22 23 24 25 26
All three functions take two template arguments:
- First, the type of the mesh element that the property is attached to (i.e. OpenMesh::VertexHandle, OpenMesh::HalfedgeHandle, OpenMesh::EdgeHandle, or OpenMesh::FaceHandle).
- Second, the type of the property value that is attached to each element (e.g., \p int, \p double, etc.).

All three functions return a handle object (of type PropertyManager) that manages the lifetime of the property and provides read / write access to its values.

In this example, we will store the \c cog value (see previous example) in a vertex property instead of keeping it in a separate array.
To do so, we first add a (temporary) property of the desired element type (OpenMesh::VertexHandle) and value type (\c %MyMesh::Point) to the mesh:
Jan Möbius's avatar
Jan Möbius committed
27 28

\dontinclude 03-properties/smooth.cc
29
\skipline makeTemporaryProperty
Jan Möbius's avatar
Jan Möbius committed
30

31 32
Enough memory is allocated to hold as many values of \c %MyMesh::Point as there are vertices.
All insert and delete operations on the mesh are synchronized with the attached properties.
Jan Möbius's avatar
Jan Möbius committed
33

34
Once the property is created, we can use it to compute the centers of the neighborhood of each vertex:
Jan Möbius's avatar
Jan Möbius committed
35

36 37
\skipline mesh.vertices
\until cog[vv] /= valence
Jan Möbius's avatar
Jan Möbius committed
38 39
\until }

40
Finally, we set the new position for each vertex:
Jan Möbius's avatar
Jan Möbius committed
41

42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
\skipline mesh.vertices
\until mesh.point
\until }

---

Since we chose to use makeTemporaryProperty(), the created property is automatically removed from the mesh as soon as we leave the scope of the associated handle variable \c cog.

If, instead, a property is desired to survive its local scope, it should be created with using getOrMakeProperty(). In that case, the property must be given a name that can later be used to retrieve the property. For example:

\code
    auto face_area = OpenMesh::makeTemporaryProperty<OpenMesh::FaceHandle, double>(mesh, 'face_area');
\endcode

At a later time, we can use the getProperty() function to obtain a handle to a property that was previously created by refering to its name:
\code
    try {
        auto face_area = OpenMesh::getProperty<OpenMesh::FaceHandle, double>(mesh, 'face_area');
        // Use the face_area property.
    }
    catch (const std::runtime_error& e) {
        // Property not found. Handle the error here.
    }
\endcode

---

The functions makeTemporaryProperty(), getOrMakeProperty(), and getProperty() are the convenient high-level interface for creating and accessing mesh properties.

Beneath these convenience functions, there is also a low-level property interface where handle and property lifetime must be managed manually. This interface is accessed through a mesh's add_property(), remove_property(), and property() functions and several property handle classes (OpenMesh::VPropHandleT, OpenMesh::HPropHandleT, OpenMesh::EPropHandleT, OpenMesh::FPropHandleT, OpenMesh::MPropHandleT).

---
Jan Möbius's avatar
Jan Möbius committed
74

75
Below is the complete source code:
Jan Möbius's avatar
Jan Möbius committed
76 77 78

\include 03-properties/smooth.cc

79
*/