Cortex  10.0.0-a4
FromMayaDagNodeConverter.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_FROMMAYADAGNODECONVERTER_H
36 #define IECOREMAYA_FROMMAYADAGNODECONVERTER_H
37 
38 #include "IECoreMaya/FromMayaObjectConverter.h"
39 
40 #include "maya/MDagPath.h"
41 #include "maya/MTypeId.h"
42 
43 namespace IECoreMaya
44 {
45 
46 IE_CORE_FORWARDDECLARE( FromMayaDagNodeConverter );
47 
51 {
52 
53  public :
54 
55  IE_CORE_DECLARERUNTIMETYPEDEXTENSION( FromMayaDagNodeConverter, FromMayaDagNodeConverterTypeId, FromMayaObjectConverter );
56 
59 
60  static FromMayaDagNodeConverterPtr create( const MDagPath &dagPath, IECore::TypeId resultType=IECore::InvalidTypeId );
65 
66  protected :
67 
68  FromMayaDagNodeConverter( const std::string &description, const MDagPath &dagPath );
69 
71  virtual IECore::ObjectPtr doConversion( const MObject &object, IECore::ConstCompoundObjectPtr operands ) const;
73  virtual IECore::ObjectPtr doConversion( const MDagPath &dagPath, IECore::ConstCompoundObjectPtr operands ) const = 0;
74 
77  template<class T>
79  {
80  public :
81 
83  Description( MFn::Type fromType, IECore::TypeId resultType, bool defaultConversion );
84 
86  Description( MTypeId fromType, IECore::TypeId resultType, bool defaultConversion );
87 
88  private :
89  static FromMayaDagNodeConverterPtr creator( const MDagPath &dagPath );
90  };
91 
92  private :
93 
94  MDagPath m_dagPath;
95 
96  typedef FromMayaDagNodeConverterPtr (*CreatorFn)( const MDagPath &dagPath );
97  typedef std::pair<MFn::Type, unsigned > MayaType;
98  typedef std::pair< MayaType, IECore::TypeId > Types;
99  typedef std::map< Types, CreatorFn > TypesToFnsMap;
100  typedef std::map< MayaType, TypesToFnsMap::const_iterator> DefaultConvertersMap;
101 
102  static TypesToFnsMap &typesToFns();
103  static DefaultConvertersMap &defaultConverters();
104  static void registerConverter( const MayaType fromType, IECore::TypeId resultType, bool defaultConverter, CreatorFn creator );
105 
106 };
107 
108 } // namespace IECoreMaya
109 
110 #include "IECoreMaya/FromMayaDagNodeConverter.inl"
111 
112 #endif // IECOREMAYA_FROMMAYADAGNODECONVERTER_H
Definition: FromMayaObjectConverter.h:53
virtual IECore::ObjectPtr doConversion(const MObject &object, IECore::ConstCompoundObjectPtr operands) const
No need to override this in derived classes - override the function below instead.
const std::string & description() const
Returns a description for this parameterised object.
static FromMayaDagNodeConverterPtr create(const MDagPath &dagPath, IECore::TypeId resultType=IECore::InvalidTypeId)
Description(MFn::Type fromType, IECore::TypeId resultType, bool defaultConversion)
use this constructor to register a converter for a native maya node:
Definition: FromMayaDagNodeConverter.h:78
TypeId
Definition: TypeIds.h:46
Definition: FromMayaDagNodeConverter.h:50
The IECoreMaya namespace holds all the functionality of libIECoreMaya.
Definition: BoolParameterHandler.h:44