Cortex  10.0.0-a4
ParameterisedHolderInterface.h
1 //
3 // Copyright (c) 2013, 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 IECOREHOUDINI_PARAMETERISEDHOLDERINTERFACE_H
36 #define IECOREHOUDINI_PARAMETERISEDHOLDERINTERFACE_H
37 
38 #include "IECore/Parameterised.h"
39 #include "IECore/Parameter.h"
40 
41 namespace IECoreHoudini
42 {
43 
47 {
48 
49  public :
50 
53 
58  virtual void setParameterised( const std::string &className, int classVersion, const std::string &searchPathEnvVar ) = 0;
60  virtual void setParameterised( IECore::RunTimeTypedPtr p ) = 0;
61 
63  virtual bool hasParameterised() = 0;
64 
66  virtual IECore::RunTimeTypedPtr getParameterised() = 0;
67 
70 
74  virtual bool setNodeValues() = 0;
75 
77  // of the attributes of the node.
78  virtual void setParameterisedValues( double time ) = 0;
79 
80 };
81 
82 }
83 
84 #endif // IECOREHOUDINI_PARAMETERISEDHOLDERINTERFACE_H
Definition: ParameterisedInterface.h:50
virtual void setParameterisedValues(double time)=0
Sets the values of the parameters of the held Parameterised object to reflect the values...
virtual void setParameterised(const std::string &className, int classVersion, const std::string &searchPathEnvVar)=0
IECore::ParameterisedInterface * getParameterisedInterface()
Convenience method to return dynamic_cast( getParameterised().get() )
The IECoreHoudini namespace holds all the functionality of libIECoreHoudini.
Definition: CoreHoudini.h:51
Definition: ParameterisedHolderInterface.h:46
virtual bool hasParameterised()=0
Returns whether or not this node is holding a valid parameterised object.
virtual IECore::RunTimeTypedPtr getParameterised()=0
Returns the parameterised object held by this node.