Cortex  10.0.0-a4
Writer.h
1 //
3 // Copyright (c) 2007-2013, Image Engine Design Inc. All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // * Neither the name of Image Engine Design nor the names of any
17 // other contributors to this software may be used to endorse or
18 // promote products derived from this software without specific prior
19 // written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
34 
35 #ifndef IE_CORE_WRITER_H
36 #define IE_CORE_WRITER_H
37 
38 #include "IECore/Export.h"
39 #include "IECore/Op.h"
40 #include "IECore/ObjectParameter.h"
41 #include "IECore/FileNameParameter.h"
42 
43 #include <map>
44 #include <vector>
45 
46 namespace IECore
47 {
48 
49 IE_CORE_FORWARDDECLARE( Writer );
50 IE_CORE_FORWARDDECLARE( FileNameParameter );
51 
55 class IECORE_API Writer : public Op
56 {
57 
58  public :
59 
60  IE_CORE_DECLARERUNTIMETYPED( Writer, Op )
61 
62 
63  static WriterPtr create( ObjectPtr object, const std::string &fileName );
72  static WriterPtr create( const std::string &fileName );
73 
77  const std::string &fileName() const;
81  const Object *object() const;
82 
85  void write();
86 
89  static void supportedExtensions( std::vector<std::string> &extensions );
90 
93  static void supportedExtensions( TypeId typeId, std::vector<std::string> &extensions );
94 
95  protected :
96 
97  Writer( const std::string &description, TypeId writableType );
98  Writer( const std::string &description, const ObjectParameter::TypeIdSet &writableTypes );
99 
101  ObjectPtr doOperation( const CompoundObject * operands ) override;
102 
105  virtual void doWrite( const CompoundObject *operands ) = 0;
106 
108  typedef WriterPtr (*CreatorFn)();
111  typedef bool (*CanWriteFn)( ConstObjectPtr object, const std::string &fileName );
112 
119  static void registerWriter( const std::string &extensions, CanWriteFn canWrite, CreatorFn creator, TypeId typeId );
120 
125  template<class T>
127  {
128  public :
129  WriterDescription( const std::string &extensions );
130  private :
131  static WriterPtr creator();
132  };
133 
134  ParameterPtr m_objectParameter;
135  FileNameParameterPtr m_fileNameParameter;
136 
137  private :
138 
139  struct WriterFns
140  {
141  CreatorFn creator;
142  CanWriteFn canWrite;
143  TypeId typeId;
144  };
145  typedef std::multimap<std::string, WriterFns> ExtensionsToFnsMap;
146  static ExtensionsToFnsMap *extensionsToFns();
147 
148  void constructParameters( void );
149 };
150 
151 } // namespace IECore
152 
153 #include "IECore/Writer.inl"
154 
155 #endif // IE_CORE_WRITER_H
Definition: Op.h:53
Definition: Writer.h:126
Definition: Object.h:104
TypeId
Definition: TypeIds.h:46
Definition: CompoundObject.h:46
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43
Definition: Writer.h:55