Developer Documentation

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
45 //=============================================================================
46 //
47 // Implements a writer module for OM files
48 //
49 //=============================================================================
50
51
52 #ifndef __OMWRITER_HH__
53 #define __OMWRITER_HH__
54
55
56 //=== INCLUDES ================================================================
57
58
59 // STD C++
60 #include <iosfwd>
61 #include <string>
62
63 // OpenMesh
64 #include <OpenMesh/Core/IO/BinaryHelper.hh>
65 #include <OpenMesh/Core/System/config.h>
66 #include <OpenMesh/Core/Utils/SingletonT.hh>
67 #include <OpenMesh/Core/IO/OMFormat.hh>
68 #include <OpenMesh/Core/IO/IOManager.hh>
69 #include <OpenMesh/Core/IO/writer/BaseWriter.hh>
70
71
72 //== NAMESPACES ===============================================================
73
74
75 namespace OpenMesh {
76 namespace IO {
77
78 //=== FORWARDS ================================================================
79
80
81 class BaseExporter;
82
83
84 //=== IMPLEMENTATION ==========================================================
85
86
91 class OPENMESHDLLEXPORT _OMWriter_ : public BaseWriter
92 {
93 public:
94
96 _OMWriter_();
97
99 virtual ~_OMWriter_() {};
100
101 std::string get_description() const override
102 { return "OpenMesh Format"; }
103
104 std::string get_extensions() const override
105 { return "om"; }
106
107 bool write(std::ostream&, BaseExporter&, Options, std::streamsize _precision = 6) const override;
108
109 size_t binary_size(BaseExporter& _be, Options _opt) const override;
110
111 static OMFormat::uint8 get_version() { return version_; }
112
113
114 protected:
115
116 static const OMFormat::uchar magic_[3];
117 static const OMFormat::uint8 version_;
118
119 bool write(const std::string&, BaseExporter&, Options, std::streamsize _precision = 6) const override;
120
121 bool write_binary(std::ostream&, BaseExporter&, Options) const;
122
123
124 size_t store_binary_custom_chunk( std::ostream&, const BaseProperty&,
125 OMFormat::Chunk::Entity, bool) const;
126 };
127
128
129 //== TYPE DEFINITION ==========================================================
130
131
133 extern _OMWriter_ __OMWriterInstance;
134 OPENMESHDLLEXPORT _OMWriter_& OMWriter();
135
136
137 //=============================================================================
138 } // namespace IO
139 } // namespace OpenMesh
140 //=============================================================================
141 #endif
142 //=============================================================================
OpenMesh::IO::binary_size
size_t binary_size(const Mesh &_mesh, const std::string &_ext, Options _opt=Options::Default)
Get binary size of data.
Definition: MeshIO.hh:268
OpenMesh::IO::_OMWriter_
Definition: OMWriter.hh:91
config.h
OpenMesh::IO::BaseWriter
Definition: BaseWriter.hh:83
OpenMesh::BaseProperty
Definition: BaseProperty.hh:60
BaseExporter
Definition: BaseExporter.hh:1
OpenMesh
Definition: MeshItems.hh:59
OpenMesh::IO::__OMWriterInstance
_OMWriter_ __OMWriterInstance
Declare the single entity of the OM writer.
Definition: OMWriter.cc:76
OpenMesh::IO::BaseExporter
Definition: BaseExporter.hh:84
OpenMesh::IO::_OMWriter_::get_extensions
std::string get_extensions() const override
Return file format&#39;s extension.
Definition: OMWriter.hh:104
OpenMesh::IO::Options
Set options for reader/writer modules.
Definition: Options.hh:90
OpenMesh::IO::_OMWriter_::~_OMWriter_
virtual ~_OMWriter_()
Destructor.
Definition: OMWriter.hh:99
OpenMesh::IO::_OMWriter_::get_description
std::string get_description() const override
Return short description of the supported file format.
Definition: OMWriter.hh:101