Developer Documentation
OBJWriter.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 an IOManager writer module for OBJ files
48 //
49 //=============================================================================
50 
51 
52 #ifndef __OBJWRITER_HH__
53 #define __OBJWRITER_HH__
54 
55 
56 //=== INCLUDES ================================================================
57 
58 
59 #include <string>
60 #include <fstream>
61 
63 #include <OpenMesh/Core/Utils/SingletonT.hh>
64 #include <OpenMesh/Core/IO/exporter/BaseExporter.hh>
65 #include <OpenMesh/Core/IO/writer/BaseWriter.hh>
66 
67 
68 //== NAMESPACES ===============================================================
69 
70 
71 namespace OpenMesh {
72 namespace IO {
73 
74 
75 //=== IMPLEMENTATION ==========================================================
76 
77 
82 class OPENMESHDLLEXPORT _OBJWriter_ : public BaseWriter
83 {
84 public:
85 
86  _OBJWriter_();
87 
89  virtual ~_OBJWriter_() {};
90 
91  std::string get_description() const override { return "Alias/Wavefront"; }
92  std::string get_extensions() const override { return "obj"; }
93 
94  bool write(const std::string&, BaseExporter&, Options, std::streamsize _precision = 6) const override;
95 
96  bool write(std::ostream&, BaseExporter&, Options, std::streamsize _precision = 6) const override;
97 
98  size_t binary_size(BaseExporter&, Options) const override { return 0; }
99 
100 private:
101 
102  mutable std::string path_;
103  mutable std::string objName_;
104 
105  mutable std::vector< OpenMesh::Vec3f > material_;
106  mutable std::vector< OpenMesh::Vec4f > materialA_;
107 
108  size_t getMaterial(OpenMesh::Vec3f _color) const;
109 
110  size_t getMaterial(OpenMesh::Vec4f _color) const;
111 
112  bool writeMaterial(std::ostream& _out, BaseExporter&, Options) const;
113 
114 
115 };
116 
117 
118 //== TYPE DEFINITION ==========================================================
119 
120 
123 OPENMESHDLLEXPORT _OBJWriter_& OBJWriter();
124 
125 
126 //=============================================================================
127 } // namespace IO
128 } // namespace OpenMesh
129 //=============================================================================
130 #endif
131 //=============================================================================
_OBJWriter_ __OBJWriterinstance
Declare the single entity of the OBJ writer.
Definition: OBJWriter.cc:69
Set options for reader/writer modules.
Definition: Options.hh:90
size_t binary_size(BaseExporter &, Options) const override
Returns expected size of file if binary format is supported else 0.
Definition: OBJWriter.hh:98
std::string get_description() const override
Return short description of the supported file format.
Definition: OBJWriter.hh:91
std::string get_extensions() const override
Return file format&#39;s extension.
Definition: OBJWriter.hh:92
virtual ~_OBJWriter_()
Destructor.
Definition: OBJWriter.hh:89