Cortex  10.0.0-a4
ClassParameterHandler.h
1 //
3 // Copyright (c) 2010-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_CLASSPARAMETERHANDLER_H
36 #define IECOREMAYA_CLASSPARAMETERHANDLER_H
37 
38 #include "IECoreMaya/ParameterHandler.h"
39 
40 namespace IECoreMaya
41 {
42 
46 {
47 
48  public :
49 
52  static MStatus setClass( IECore::ParameterPtr parameter, const MString &className, int classVersion, const MString &searchPathEnvVar );
55  static MStatus getClass( IECore::ConstParameterPtr parameter, MString &className, int &classVersion, MString &searchPathEnvVar );
56 
63  static void currentClass( const MPlug &plug, MString &className, int &classVersion, MString &searchPathEnvVar );
64 
65  protected:
66 
67  virtual MPlug doCreate( IECore::ConstParameterPtr parameter, const MString &plugName, MObject &node ) const;
68  virtual MStatus doUpdate( IECore::ConstParameterPtr parameter, MPlug &plug ) const;
69  virtual MStatus doSetValue( IECore::ConstParameterPtr parameter, MPlug &plug ) const;
70  virtual MStatus doSetValue( const MPlug &plug, IECore::ParameterPtr parameter ) const;
71  virtual MStatus doRestore( const MPlug &plug, IECore::ParameterPtr parameter ) const;
72 
73  private :
74 
75  static MStatus storeClass( IECore::ConstParameterPtr parameter, MPlug &plug );
76 
77 
78 };
79 
80 } // namespace IECoreMaya
81 
82 #endif // IECOREMAYA_CLASSPARAMETERHANDLER_H
static MStatus getClass(IECore::ConstParameterPtr parameter, MString &className, int &classVersion, MString &searchPathEnvVar)
Definition: ParameterHandler.h:57
static MStatus setClass(IECore::ParameterPtr parameter, const MString &className, int classVersion, const MString &searchPathEnvVar)
Definition: ClassParameterHandler.h:45
static void currentClass(const MPlug &plug, MString &className, int &classVersion, MString &searchPathEnvVar)
The IECoreMaya namespace holds all the functionality of libIECoreMaya.
Definition: BoolParameterHandler.h:44