Cortex  10.0.0-a4
ParameterisedHolderInterface.h
1 //
3 // Copyright (c) 2007-2009, 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_PARAMETERISEDHOLDERINTERFACE_H
36 #define IE_COREMAYA_PARAMETERISEDHOLDERINTERFACE_H
37 
38 #include "maya/MPxNode.h"
39 
40 #include "IECore/Parameterised.h"
41 #include "IECore/Parameter.h"
42 
43 namespace IECoreMaya
44 {
45 
49 {
50 
51  public:
52 
55 
60  virtual MStatus setParameterised( const std::string &className, int classVersion, const std::string &searchPathEnvVar ) = 0;
62  virtual MStatus setParameterised( IECore::RunTimeTypedPtr p ) = 0;
66  virtual MStatus updateParameterised() = 0;
72  virtual IECore::RunTimeTypedPtr getParameterised( std::string *className = 0, int *classVersion = 0, std::string *searchPathEnvVar = 0 ) = 0;
76  IECore::ParameterisedInterface *getParameterisedInterface( std::string *className, int *classVersion = 0, std::string *searchPathEnvVar = 0 );
80  virtual MStatus setNodeValues() = 0;
84  virtual MStatus setNodeValue( IECore::ParameterPtr pa ) = 0;
88  virtual MStatus setParameterisedValues() = 0;
92  virtual MStatus setParameterisedValue( IECore::ParameterPtr pa ) = 0;
96  virtual MPlug parameterPlug( IECore::ConstParameterPtr parameter ) = 0;
99  virtual IECore::ParameterPtr plugParameter( const MPlug &plug ) = 0;
100 
101 };
102 
103 }
104 
105 #endif // IE_COREMAYA_PARAMETERISEDHOLDERINTERFACE_H
Definition: ParameterisedInterface.h:50
virtual IECore::ParameterPtr plugParameter(const MPlug &plug)=0
IECore::ParameterisedInterface * getParameterisedInterface()
Convenience method to return dynamic_cast( getParameterised().get() )
virtual MStatus setParameterisedValue(IECore::ParameterPtr pa)=0
virtual MPlug parameterPlug(IECore::ConstParameterPtr parameter)=0
virtual MStatus setNodeValue(IECore::ParameterPtr pa)=0
Definition: ParameterisedHolderInterface.h:48
virtual IECore::RunTimeTypedPtr getParameterised(std::string *className=0, int *classVersion=0, std::string *searchPathEnvVar=0)=0
virtual MStatus setParameterised(const std::string &className, int classVersion, const std::string &searchPathEnvVar)=0
The IECoreMaya namespace holds all the functionality of libIECoreMaya.
Definition: BoolParameterHandler.h:44