Cortex  10.0.0-a4
Parameter.h
1 //
3 // Copyright (c) 2007-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 IE_CORE_PARAMETER_H
36 #define IE_CORE_PARAMETER_H
37 
38 #include <map>
39 #include <vector>
40 #include <string>
41 
42 #include "IECore/Export.h"
43 #include "IECore/Object.h"
44 
45 namespace IECore
46 {
47 
48 IE_CORE_FORWARDDECLARE( CompoundObject );
49 
53 class IECORE_API Parameter : public RunTimeTyped
54 {
55  public :
56 
57  IE_CORE_DECLARERUNTIMETYPED( Parameter, RunTimeTyped );
58 
61  typedef std::pair<std::string, ObjectPtr> Preset;
63  typedef std::vector<Preset> PresetsContainer;
64 
67  Parameter( const std::string &name, const std::string &description, ObjectPtr defaultValue,
68  const PresetsContainer &presets = PresetsContainer(), bool presetsOnly = false, ConstCompoundObjectPtr userData=nullptr );
69 
70  ~Parameter() override;
71 
74 
75  const std::string &name() const;
77  inline const InternedString &internedName() const;
79  const std::string &description() const;
81  virtual const Object *defaultValue() const;
83  virtual const PresetsContainer &getPresets() const;
85  virtual void setPresets( const PresetsContainer &presets );
88  virtual bool presetsOnly() const;
90  CompoundObject *userData();
92  const CompoundObject *userData() const;
94 
103 
104  virtual bool valueValid( const Object *value, std::string *reason = nullptr ) const;
117  bool valueValid( std::string *reason = nullptr ) const;
120  void validate() const;
123  void validate(const Object *value ) const;
125 
133 
134  virtual void setValue( ObjectPtr value );
140  void setValidatedValue( ObjectPtr value );
144  void setValue( const std::string &presetName );
146 
155 
156  virtual Object *getValue();
161  virtual const Object *getValue() const;
164  Object *getValidatedValue();
167  const Object *getValidatedValue() const;
169  template<typename T>
170  T *getTypedValue();
172  template<typename T>
173  const T *getTypedValue() const;
176  template<typename T>
177  T *getTypedValidatedValue();
180  template<typename T>
181  const T *getTypedValidatedValue() const;
184  std::string getCurrentPresetName() const;
186 
187  private :
188 
189  InternedString m_name;
190  InternedString m_description;
191 
192  ObjectPtr m_value;
193  ConstObjectPtr m_defaultValue;
194 
195  PresetsContainer m_presets;
196  bool m_presetsOnly;
197 
198  mutable CompoundObjectPtr m_userData;
199 
200 };
201 
202 IE_CORE_DECLAREPTR( Parameter );
203 
204 } // namespace IECore
205 
206 #include "IECore/Parameter.inl"
207 
208 #endif // IE_CORE_PARAMETER_H
Definition: Parameter.h:53
std::vector< Preset > PresetsContainer
A type to store a bunch of preset values for the Parameter.
Definition: Parameter.h:63
std::pair< std::string, ObjectPtr > Preset
Definition: Parameter.h:61
Definition: Object.h:104
Definition: CompoundObject.h:46
Definition: InternedString.h:55
Definition: RunTimeTyped.h:211
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43