Cortex  10.0.0-a4
FromMayaShapeConverter.h
1 //
3 // Copyright (c) 2008-2011, 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 IECOREMAYA_FROMMAYASHAPECONVERTER_H
36 #define IECOREMAYA_FROMMAYASHAPECONVERTER_H
37 
38 #include "IECoreMaya/FromMayaObjectConverter.h"
39 
40 #include "IECore/NumericParameter.h"
41 
42 #include "maya/MDagPath.h"
43 
44 namespace IECore
45 {
46 
47 IE_CORE_FORWARDDECLARE( Primitive );
48 
49 } // namespace IECore
50 
51 namespace IECoreMaya
52 {
53 
54 IE_CORE_FORWARDDECLARE( FromMayaShapeConverter );
55 
59 {
60 
61  public :
62 
63  IE_CORE_DECLARERUNTIMETYPEDEXTENSION( FromMayaShapeConverter, FromMayaShapeConverterTypeId, FromMayaObjectConverter );
64 
65  enum Space
66  {
67  Object = 0,
68  World = 1
69  };
70 
71  IECore::IntParameterPtr spaceParameter();
72  IECore::ConstIntParameterPtr spaceParameter() const;
73 
74  IECore::StringParameterPtr primVarAttrPrefixParameter();
75  IECore::ConstStringParameterPtr primVarAttrPrefixParameter() const;
76 
81 
82  static FromMayaShapeConverterPtr create( const MDagPath &dagPath, IECore::TypeId resultType=IECore::InvalidTypeId );
90 
91  protected :
92 
93  FromMayaShapeConverter( const std::string &description, const MObject &object );
96  FromMayaShapeConverter( const std::string &description, const MDagPath &dagPath );
97 
101  virtual IECore::ObjectPtr doConversion( const MObject &object, IECore::ConstCompoundObjectPtr operands ) const;
103  virtual IECore::PrimitivePtr doPrimitiveConversion( const MObject &object, IECore::ConstCompoundObjectPtr operands ) const = 0;
105  virtual IECore::PrimitivePtr doPrimitiveConversion( const MDagPath &dagPath, IECore::ConstCompoundObjectPtr operands ) const = 0;
106 
108  MSpace::Space space() const;
113  const MDagPath *dagPath( bool emitSpaceWarnings=false ) const;
114 
117  template<class T>
119  {
120  public :
126  Description( MFn::Type fromType, IECore::TypeId resultType, bool defaultConversion );
127  private :
128  static FromMayaShapeConverterPtr creator( const MDagPath &dagPath );
129  };
130 
131  private :
132 
133  void constructCommon(); // does stuff both constructors need.
134  void addPrimVars( const MObject &object, IECore::PrimitivePtr primitive ) const;
135 
136  MDagPath m_dagPath;
137 
138  IECore::IntParameterPtr m_spaceParameter;
139  IECore::StringParameterPtr m_primVarAttrPrefixParameter;
140 
141  typedef FromMayaShapeConverterPtr (*ShapeCreatorFn)( const MDagPath &dagPath );
142  typedef std::pair<MFn::Type, IECore::TypeId> ShapeTypes;
143  typedef std::map<ShapeTypes, ShapeCreatorFn> ShapeTypesToFnsMap;
144  typedef std::map<MFn::Type, ShapeTypesToFnsMap::const_iterator> DefaultConvertersMap;
145 
146  static ShapeTypesToFnsMap &shapeTypesToFns();
147  static DefaultConvertersMap &defaultConverters();
148  static void registerShapeConverter( const MFn::Type fromType, IECore::TypeId resultType, bool defaultConverter, ShapeCreatorFn creator );
149 
150 };
151 
152 } // namespace IECoreMaya
153 
154 #include "IECoreMaya/FromMayaShapeConverter.inl"
155 
156 #endif // IECOREMAYA_FROMMAYASHAPECONVERTER_H
Definition: FromMayaObjectConverter.h:53
virtual IECore::PrimitivePtr doPrimitiveConversion(const MObject &object, IECore::ConstCompoundObjectPtr operands) const =0
Must be implemented by derived classes to return a Primitive created to represent the specified objec...
virtual IECore::ObjectPtr doConversion(const MObject &object, IECore::ConstCompoundObjectPtr operands) const
MSpace::Space space() const
The space in which derived classes should convert the object.
const std::string & description() const
Returns a description for this parameterised object.
TypeId
Definition: TypeIds.h:46
Definition: FromMayaShapeConverter.h:58
The IECoreMaya namespace holds all the functionality of libIECoreMaya.
Definition: BoolParameterHandler.h:44
static FromMayaShapeConverterPtr create(const MDagPath &dagPath, IECore::TypeId resultType=IECore::InvalidTypeId)
Definition: FromMayaShapeConverter.h:118
const MDagPath * dagPath(bool emitSpaceWarnings=false) const
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43
Description(MFn::Type fromType, IECore::TypeId resultType, bool defaultConversion)