- Main Page
- Modules
- Namespaces
- Classes
- Files
- Related Pages

# First Steps

This small example shows:

- How to declare your type `MyMesh`,
- How to add vertices and faces to a mesh,
- How to write a mesh using the IO functions.

For each program the first step is to define your type `MyMesh`. OpenMesh supports general polygonal meshes (faces are polygons with varying number of vertices) as well as specialized triangle meshes (all faces are triangles). In this example we want to build a cube from six quadrangles, therefore we choose the polygonal mesh.

OpenMesh also supports different mesh kernels, specifying how all the vertices, edges, and faces are stored internally (see also Mesh Kernels). However, the storage must provide an array like interface. For the tutorial we use the supplied ArrayKernel. The predefined combinations of TriMesh/PolyMesh and the kernel are contained in `OpenMesh/Core/Mesh/Types/`, we use the `PolyMesh_ArrayKernelT`.

    #include <OpenMesh/Core/Mesh/Types/PolyMesh_ArrayKernelT.hh>
    typedef OpenMesh::PolyMesh_ArrayKernelT<>  MyMesh;

The mesh could further be parameterized by a so called Traits class, but this will be topic of one of the next examples, so we use no template parameter here.

Now since we have declared our type `MyMesh`, we only have to add 8 vertices and 6 quadrangles to build a cube. Adding a vertex is done using the `add_vertex` method. It gets a coordinate and returns a handle to the inserted vertex. We store all handles in an array, since we need them for specifying the faces.

      vhandle[0] = mesh.add_vertex(MyMesh::Point(-1, -1,  1));
      vhandle[1] = mesh.add_vertex(MyMesh::Point( 1, -1,  1));
      vhandle[2] = mesh.add_vertex(MyMesh::Point( 1,  1,  1));
      vhandle[3] = mesh.add_vertex(MyMesh::Point(-1,  1,  1));

In order to add a face to the mesh, we have to build a vector holding the handles to the face's vertices. This vector is passed to the `add_face` method. The following block will create a face from the first four vertices:

      std::vector<MyMesh::VertexHandle>  face_vhandles;

      face_vhandles.clear();
      face_vhandles.push_back(vhandle[0]);
      face_vhandles.push_back(vhandle[1]);
      face_vhandles.push_back(vhandle[2]);
      face_vhandles.push_back(vhandle[3]);
      mesh.add_face(face_vhandles);

The orientation of the face is defined by the order in which the vertices are given: If you look at the frontfacing side of the polygon, then the vertices are in counter-clockwise order.

After creating all of the six faces, we want to write the resulting mesh to standard output. OpenMesh provides some basic input/output methods in the namespace OpenMesh::IO:

        if ( !OpenMesh::IO::write_mesh(mesh, "output.off") )

To use the IO facility of OpenMesh make sure that the include MeshIO.hh is included first.

    #include <OpenMesh/Core/IO/MeshIO.hh>
    #include <OpenMesh/Core/Mesh/Types/PolyMesh_ArrayKernelT.hh>

The complete source looks like this:

    //=============================================================================
    //
    //                               OpenMesh
    //      Copyright (C) 2001-2005 by Computer Graphics Group, RWTH Aachen
    //                           www.openmesh.org
    //
    //-----------------------------------------------------------------------------
    //
    //                                License
    //
    //   This library is free software; you can redistribute it and/or modify it
    //   under the terms of the GNU Library General Public License as published
    //   by the Free Software Foundation, version 2.
    //
    //   This library is distributed in the hope that it will be useful, but
    //   WITHOUT ANY WARRANTY; without even the implied warranty of
    //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    //   Library General Public License for more details.
    //
    //   You should have received a copy of the GNU Library General Public
    //   License along with this library; if not, write to the Free Software
    //   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
    //
    //-----------------------------------------------------------------------------
    //
    //   $Revision: 1.2 $
    //   $Date: 2005-12-21 14:05:30 $
    //
    //=============================================================================

    #include <iostream>
    // -------------------- OpenMesh
    #include <OpenMesh/Core/IO/MeshIO.hh>
    #include <OpenMesh/Core/Mesh/Types/PolyMesh_ArrayKernelT.hh>

    // ----------------------------------------------------------------------------

    typedef OpenMesh::PolyMesh_ArrayKernelT<>  MyMesh;

    // ----------------------------------------------------------------------------
    // Build a simple cube and write it to std::cout

    int main()
    {
      MyMesh mesh;

      // generate vertices

      MyMesh::VertexHandle vhandle[8];

      vhandle[0] = mesh.add_vertex(MyMesh::Point(-1, -1,  1));
      vhandle[1] = mesh.add_vertex(MyMesh::Point( 1, -1,  1));
      vhandle[2] = mesh.add_vertex(MyMesh::Point( 1,  1,  1));
      vhandle[3] = mesh.add_vertex(MyMesh::Point(-1,  1,  1));
      vhandle[4] = mesh.add_vertex(MyMesh::Point(-1, -1, -1));
      vhandle[5] = mesh.add_vertex(MyMesh::Point( 1, -1, -1));
      vhandle[6] = mesh.add_vertex(MyMesh::Point( 1,  1, -1));
      vhandle[7] = mesh.add_vertex(MyMesh::Point(-1,  1, -1));

      // generate (quadrilateral) faces

      std::vector<MyMesh::VertexHandle>  face_vhandles;

      face_vhandles.clear();
      face_vhandles.push_back(vhandle[0]);
      face_vhandles.push_back(vhandle[1]);
      face_vhandles.push_back(vhandle[2]);
      face_vhandles.push_back(vhandle[3]);
      mesh.add_face(face_vhandles);

      face_vhandles.clear();
      face_vhandles.push_back(vhandle[7]);
      face_vhandles.push_back(vhandle[6]);
      face_vhandles.push_back(vhandle[5]);
      face_vhandles.push_back(vhandle[4]);
      mesh.add_face(face_vhandles);

      face_vhandles.clear();
      face_vhandles.push_back(vhandle[1]);
      face_vhandles.push_back(vhandle[0]);
      face_vhandles.push_back(vhandle[4]);
      face_vhandles.push_back(vhandle[5]);
      mesh.add_face(face_vhandles);

      face_vhandles.clear();
      face_vhandles.push_back(vhandle[2]);
      face_vhandles.push_back(vhandle[1]);
      face_vhandles.push_back(vhandle[5]);
      face_vhandles.push_back(vhandle[6]);
      mesh.add_face(face_vhandles);

      face_vhandles.clear();
      face_vhandles.push_back(vhandle[3]);
      face_vhandles.push_back(vhandle[2]);
      face_vhandles.push_back(vhandle[6]);
      face_vhandles.push_back(vhandle[7]);
      mesh.add_face(face_vhandles);

      face_vhandles.clear();
      face_vhandles.push_back(vhandle[0]);
      face_vhandles.push_back(vhandle[3]);
      face_vhandles.push_back(vhandle[7]);
      face_vhandles.push_back(vhandle[4]);
      mesh.add_face(face_vhandles);

      // write mesh to output.obj
      try
      {
        if ( !OpenMesh::IO::write_mesh(mesh, "output.off") )
        {
          std::cerr << "Cannot write mesh to file 'output.off'" << std::endl;
          return 1;
        }
      }
      catch( std::exception& x )
      {
        std::cerr << x.what() << std::endl;
        return 1;
      }

      return 0;
    }