Cortex  10.0.0-a4
CompoundParameterHandler.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 IECORENUKE_COMPOUNDPARAMETERHANDLER_H
36 #define IECORENUKE_COMPOUNDPARAMETERHANDLER_H
37 
38 #include "IECoreNuke/ParameterHandler.h"
39 
40 namespace IECoreNuke
41 {
42 
43 class CompoundParameterHandler : public ParameterHandler
44 {
45 
46  public :
47 
48  CompoundParameterHandler();
49 
50  virtual int minimumInputs( const IECore::Parameter *parameter );
51  virtual int maximumInputs( const IECore::Parameter *parameter );
52  virtual bool testInput( const IECore::Parameter *parameter, int input, const DD::Image::Op *op );
53  virtual void setParameterValue( IECore::Parameter *parameter, InputIterator first, InputIterator last );
54 
55  virtual void knobs( const IECore::Parameter *parameter, const char *knobName, DD::Image::Knob_Callback f );
56  virtual void setParameterValue( IECore::Parameter *parameter, ValueSource valueSource = Storage );
57  virtual void setKnobValue( const IECore::Parameter *parameter );
58  virtual void setState( IECore::Parameter *parameter, const IECore::Object *state );
59  virtual IECore::ObjectPtr getState( const IECore::Parameter *parameter );
60 
61  protected :
62 
63  void beginGroup( const IECore::Parameter *parameter, const char *knobName, DD::Image::Knob_Callback f );
64  void childKnobs( const IECore::Parameter *parameter, const char *knobName, DD::Image::Knob_Callback f );
65  void endGroup( const IECore::Parameter *parameter, const char *knobName, DD::Image::Knob_Callback f );
66  std::string knobLabel( const IECore::Parameter *parameter ) const;
67 
68  private :
69 
70  enum ContainerType
71  {
72  Collapsible,
73  Tab,
74  Toolbar
75  };
76  ContainerType containerType( const IECore::Parameter *parameter );
77 
78  void inputs( const IECore::Parameter *parameter, int &minimum, int &maximum, bool &error );
79 
80  ParameterHandlerPtr handler( const IECore::Parameter *child, bool createIfMissing );
81  typedef std::map<IECore::InternedString, ParameterHandlerPtr> HandlerMap;
82  HandlerMap m_handlers;
83 
84  static Description<CompoundParameterHandler> g_description;
85 
86 };
87 
88 } // namespace IECoreNuke
89 
90 #endif // IECORENUKE_COMPOUNDPARAMETERHANDLER_H
Definition: Parameter.h:53
Definition: Object.h:104
The IECoreNuke namespace holds all the functionality of libIECoreNuke.
Definition: BoolParameterHandler.h:40