Cortex  10.0.0-a4
LensModel.h
1 //
3 // Copyright (c) 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 IECORE_LENSMODEL_H
36 #define IECORE_LENSMODEL_H
37 
38 #include <map>
39 
40 #include "IECore/Export.h"
41 #include "IECore/Object.h"
42 #include "IECore/Parameter.h"
43 #include "IECore/Parameterised.h"
44 #include "IECore/SimpleTypedData.h"
45 #include "IECore/SimpleTypedParameter.h"
46 #include "IECore/CompoundParameter.h"
47 #include "IECore/TypeIds.h"
48 #include "boost/format.hpp"
49 
50 namespace IECore
51 {
52 
53 IE_CORE_FORWARDDECLARE( CompoundObject )
54 IE_CORE_FORWARDDECLARE( LensModel );
55 
75 class IECORE_API LensModel : public Parameterised
76 {
77  public:
78 
79  enum
80  {
81  Distort = 0,
82  Undistort = 1
83  } DistortionMode;
84 
85  typedef LensModelPtr (*CreatorFn)( ConstCompoundObjectPtr data );
86 
87  IE_CORE_DECLARERUNTIMETYPED( LensModel, Parameterised );
88 
96  Imath::Box2i bounds( int mode, const Imath::Box2i &input, int width, int height );
97 
101 
102  virtual void validate() = 0;
105 
109  virtual Imath::V2d distort( Imath::V2d p ) = 0;
110 
114  virtual Imath::V2d undistort( Imath::V2d p ) = 0;
116 
120 
121  static LensModelPtr create( ConstCompoundObjectPtr lensParams );
125 
128  static LensModelPtr create( const std::string &name );
129 
132  static LensModelPtr create( TypeId id );
133 
135  static std::vector<std::string> lensModels();
136 
137  protected :
138 
142  LensModel();
143  ~LensModel() override;
144 
151  template<class T>
153  {
154  public:
157 
158  private:
160  static LensModelPtr creator( ConstCompoundObjectPtr data = nullptr );
161  };
162 
163  private:
164 
165  typedef std::map< std::string, CreatorFn > CreatorMap;
166 
168  static CreatorMap& creators();
169 
170 };
171 
172 IE_CORE_DECLAREPTR(LensModel);
173 
174 }
175 
176 #include "LensModel.inl"
177 
178 #endif // IECORE_LENSMODEL_H
179 
Definition: Parameterised.h:49
Definition: LensModel.h:75
Definition: LensModel.h:152
TypeId
Definition: TypeIds.h:46
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43