Cortex  10.0.0-a4
ParameterHandler.h
1 //
3 // Copyright (c) 2010-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 IECORENUKE_PARAMETERHANDLER_H
36 #define IECORENUKE_PARAMETERHANDLER_H
37 
38 #include "DDImage/Op.h" // for Knob_Callback
39 
40 #include "IECore/Parameter.h"
41 
42 namespace IECoreNuke
43 {
44 
45 IE_CORE_FORWARDDECLARE( ParameterHandler )
46 
47 class ParameterHandler : public IECore::RefCounted
50 {
51 
52  public :
53 
54  enum ValueSource
55  {
56  Knob,
57  Storage
58  };
59 
60  typedef std::vector<DD::Image::Op *>::const_iterator InputIterator;
61 
65  virtual int minimumInputs( const IECore::Parameter *parameter );
69  virtual int maximumInputs( const IECore::Parameter *parameter );
73  virtual bool testInput( const IECore::Parameter *parameter, int input, const DD::Image::Op *op );
76  virtual void setParameterValue( IECore::Parameter *parameter, InputIterator first, InputIterator last );
77 
79  virtual void knobs( const IECore::Parameter *parameter, const char *knobName, DD::Image::Knob_Callback f );
86  virtual void setParameterValue( IECore::Parameter *parameter, ValueSource valueSource = Storage );
88  virtual void setKnobValue( const IECore::Parameter *parameter );
93  virtual IECore::ObjectPtr getState( const IECore::Parameter *parameter );
95  virtual void setState( IECore::Parameter *parameter, const IECore::Object *state );
96 
98  static ParameterHandlerPtr create( const IECore::Parameter *parameter );
99 
100  protected :
101 
102  ParameterHandler();
103 
105  std::string knobLabel( const IECore::Parameter *parameter ) const;
109  void setKnobProperties( const IECore::Parameter *parameter, DD::Image::Knob_Callback f, DD::Image::Knob *knob ) const;
110 
111  template<typename T>
112  class Description
113  {
114  public :
115 
116  Description( IECore::TypeId parameterType )
117  {
118  creatorFns()[parameterType] = creator;
119  }
120 
121  private :
122 
123  static ParameterHandlerPtr creator()
124  {
125  return new T();
126  }
127 
128  };
129 
130  private :
131 
132  typedef ParameterHandlerPtr (*CreatorFn)();
133 
134  typedef std::map<IECore::TypeId, CreatorFn> CreatorFnMap;
135  static CreatorFnMap &creatorFns();
136 
137 };
138 
139 } // namespace IECoreNuke
140 
141 #endif // IECORENUKE_PARAMETERHANDLER_H
Definition: Parameter.h:53
Definition: Object.h:104
The IECoreNuke namespace holds all the functionality of libIECoreNuke.
Definition: BoolParameterHandler.h:40
TypeId
Definition: TypeIds.h:46
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43