Cortex  10.0.0-a4
FromMayaObjectConverter.h
1 //
3 // Copyright (c) 2007-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 IE_COREMAYA_FROMMAYAOBJECTCONVERTER_H
36 #define IE_COREMAYA_FROMMAYAOBJECTCONVERTER_H
37 
38 #include "IECoreMaya/FromMayaConverter.h"
39 
40 #include "IECore/Object.h"
41 #include "IECore/SimpleTypedParameter.h"
42 
43 #include "maya/MObjectHandle.h"
44 
45 namespace IECoreMaya
46 {
47 
48 IE_CORE_FORWARDDECLARE( FromMayaObjectConverter );
49 
54 {
55 
56  public :
57 
58  IE_CORE_DECLARERUNTIMETYPEDEXTENSION( FromMayaObjectConverter, FromMayaObjectConverterTypeId, FromMayaConverter );
59 
62  const MObject &object() const;
67  bool objectIsAlive() const;
68 
72 
73  IECore::StringParameterPtr blindDataAttrPrefixParameter();
74  IECore::ConstStringParameterPtr blindDataAttrPrefixParameter() const;
75  IECore::BoolParameterPtr blindDataRemoveNamespaceParameter();
76  IECore::ConstBoolParameterPtr blindDataRemoveNamespaceParameter() const;
78 
81 
82  static FromMayaObjectConverterPtr create( const MObject &object, IECore::TypeId resultType=IECore::InvalidTypeId );
88 
89  protected :
90 
91  FromMayaObjectConverter( const std::string &description, const MObject &object );
92 
95  virtual IECore::ObjectPtr doConversion( IECore::ConstCompoundObjectPtr operands ) const;
98  virtual IECore::ObjectPtr doConversion( const MObject &object, IECore::ConstCompoundObjectPtr operands ) const = 0;
99 
100  typedef FromMayaObjectConverterPtr (*CreatorFn)( const MObject &object );
101 
102  static void registerConverter( const MFn::Type fromType, IECore::TypeId resultType, bool defaultConversion, CreatorFn creator );
103 
106  template<class T>
108  {
109  public :
115  FromMayaObjectConverterDescription( MFn::Type fromType, IECore::TypeId resultType, bool defaultConversion );
116  private :
117  static FromMayaObjectConverterPtr creator( const MObject &object );
118  };
119 
120  private :
121 
122  void addBlindData( const MObject &object, IECore::ObjectPtr convertedObject ) const;
123 
124  MObjectHandle m_objectHandle;
125  IECore::StringParameterPtr m_blindDataAttrPrefixParameter;
126  IECore::BoolParameterPtr m_blindDataRemoveNamespaceParameter;
127 
128  typedef std::pair<MFn::Type, IECore::TypeId> Types;
129  typedef std::map<Types, CreatorFn> TypesToFnsMap;
130  typedef std::map<MFn::Type, TypesToFnsMap::const_iterator> DefaultConvertersMap;
131 
132  static TypesToFnsMap &typesToFns();
133  static DefaultConvertersMap &defaultConverters();
134 
135 };
136 
137 } // namespace IECoreMaya
138 
139 #include "IECoreMaya/FromMayaObjectConverter.inl"
140 
141 #endif // IE_COREMAYA_FROMMAYACONVERTER_H
Definition: FromMayaConverter.h:48
Definition: FromMayaObjectConverter.h:53
const std::string & description() const
Returns a description for this parameterised object.
static FromMayaObjectConverterPtr create(const MObject &object, IECore::TypeId resultType=IECore::InvalidTypeId)
TypeId
Definition: TypeIds.h:46
FromMayaObjectConverterDescription(MFn::Type fromType, IECore::TypeId resultType, bool defaultConversion)
The IECoreMaya namespace holds all the functionality of libIECoreMaya.
Definition: BoolParameterHandler.h:44
const MObject & object() const
virtual IECore::ObjectPtr doConversion(IECore::ConstCompoundObjectPtr operands) const