OpenMesh
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
OMWriter.hh
1 /* ========================================================================= *
2  * *
3  * OpenMesh *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openmesh.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenMesh. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39  * *
40  * ========================================================================= */
41 
42 /*===========================================================================*\
43  * *
44  * $Revision$ *
45  * $Date$ *
46  * *
47 \*===========================================================================*/
48 
49 
50 //=============================================================================
51 //
52 // Implements a writer module for OM files
53 //
54 //=============================================================================
55 
56 
57 #ifndef __OMWRITER_HH__
58 #define __OMWRITER_HH__
59 
60 
61 //=== INCLUDES ================================================================
62 
63 
64 // STD C++
65 #include <iosfwd>
66 #include <string>
67 
68 // OpenMesh
69 #include <OpenMesh/Core/IO/BinaryHelper.hh>
70 #include <OpenMesh/Core/System/config.h>
71 #include <OpenMesh/Core/Utils/SingletonT.hh>
72 #include <OpenMesh/Core/IO/OMFormat.hh>
73 #include <OpenMesh/Core/IO/IOManager.hh>
74 #include <OpenMesh/Core/IO/writer/BaseWriter.hh>
75 
76 
77 //== NAMESPACES ===============================================================
78 
79 
80 namespace OpenMesh {
81 namespace IO {
82 
83 //=== FORWARDS ================================================================
84 
85 
86 class BaseExporter;
87 
88 
89 //=== IMPLEMENTATION ==========================================================
90 
91 
96 class OPENMESHDLLEXPORT _OMWriter_ : public BaseWriter
97 {
98 public:
99 
101  _OMWriter_();
102 
104  virtual ~_OMWriter_() {};
105 
106  std::string get_description() const
107  { return "OpenMesh Format"; }
108 
109  std::string get_extensions() const
110  { return "om"; }
111 
112  bool write(std::ostream&, BaseExporter&, Options, std::streamsize _precision = 6) const;
113 
114 
115 
116  size_t binary_size(BaseExporter& _be, Options _opt) const;
117 
118 
119 protected:
120 
121  static const OMFormat::uchar magic_[3];
122  static const OMFormat::uint8 version_;
123 
124  bool write(const std::string&, BaseExporter&, Options, std::streamsize _precision = 6) const;
125 
126  bool write_binary(std::ostream&, BaseExporter&, Options) const;
127 
128 
129  size_t store_binary_custom_chunk( std::ostream&, const BaseProperty&,
130  OMFormat::Chunk::Entity, bool) const;
131 };
132 
133 
134 //== TYPE DEFINITION ==========================================================
135 
136 
138 extern _OMWriter_ __OMWriterInstance;
139 OPENMESHDLLEXPORT _OMWriter_& OMWriter();
140 
141 
142 //=============================================================================
143 } // namespace IO
144 } // namespace OpenMesh
145 //=============================================================================
146 #endif
147 //=============================================================================
size_t binary_size(const Mesh &_mesh, const std::string &_ext, Options _opt=Options::Default)
Get binary size of data.
Definition: MeshIO.hh:260
Set options for reader/writer modules.
Definition: Options.hh:95
std::string get_extensions() const
Return file format's extension.
Definition: OMWriter.hh:109
Base class for all writer modules.
Definition: BaseWriter.hh:88
virtual ~_OMWriter_()
Destructor.
Definition: OMWriter.hh:104
_OMWriter_ __OMWriterInstance
Declare the single entity of the OM writer.
Definition: OMWriter.cc:81
Contains all the mesh ingredients like the polygonal mesh, the triangle mesh, different mesh kernels ...
Definition: MeshItems.hh:64
Implementation of the OM format writer.
Definition: OMWriter.hh:96
Base class for exporter modules.
Definition: BaseExporter.hh:89
std::string get_description() const
Return short description of the supported file format.
Definition: OMWriter.hh:106
Abstract class defining the basic interface of a dynamic property.
Definition: BaseProperty.hh:65

Project OpenMesh, ©  Computer Graphics Group, RWTH Aachen. Documentation generated using doxygen .