Cortex  10.0.0-a4
NumericParameter.h
1 //
3 // Copyright (c) 2007-2010, 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_NUMERICPARAMETER_H
36 #define IE_CORE_NUMERICPARAMETER_H
37 
38 #include "IECore/Parameter.h"
39 #include "IECore/TypedData.h"
40 #include "OpenEXR/ImathLimits.h"
41 
42 namespace IECore
43 {
44 
47 template<typename T>
49 {
50  public :
51 
52  typedef T ValueType;
53  typedef TypedData<T> ObjectType;
54 
55  IE_CORE_DECLAREPTR( ObjectType );
56  typedef std::pair<std::string, T> Preset;
57  typedef std::vector<Preset> PresetsContainer;
58 
59  NumericParameter( const std::string &name, const std::string &description, T defaultValue = T(),
60  T minValue = Imath::limits<T>::min(), T maxValue = Imath::limits<T>::max(),
61  const PresetsContainer &presets = PresetsContainer(), bool presetsOnly = false, ConstCompoundObjectPtr userData = nullptr );
62 
63  NumericParameter( const std::string &name, const std::string &description, T defaultValue,
64  const PresetsContainer &presets, ConstCompoundObjectPtr userData = nullptr );
65 
66  IECORE_RUNTIMETYPED_DECLARETEMPLATE( NumericParameter<T>, Parameter );
67 
68  bool hasMinValue() const;
69  T minValue() const;
70 
71  bool hasMaxValue() const;
72  T maxValue() const;
73 
77  T numericDefaultValue() const;
78 
85  T getNumericValue() const;
88  void setNumericValue( T value );
89 
92  bool valueValid( const Object *value, std::string *reason = nullptr ) const override;
93 
94  private :
95 
96  T m_min;
97  T m_max;
98 
99  static TypeDescription<NumericParameter<T> > g_typeDescription;
100 
101 };
102 
106 
107 IE_CORE_DECLAREPTR( IntParameter );
108 IE_CORE_DECLAREPTR( FloatParameter );
109 IE_CORE_DECLAREPTR( DoubleParameter );
110 
111 } // namespace IECore
112 
113 #endif // IE_CORE_NUMERICPARAMETER_H
Definition: Parameter.h:53
bool valueValid(const Object *value, std::string *reason=nullptr) const override
const std::string & description() const
Returns the description for this parameter.
Definition: TypedData.h:64
CompoundObject * userData()
Returns the userdata. This can be modified freely.
Definition: Object.h:104
const std::string & name() const
Returns the name of this parameter.
Definition: NumericParameter.h:48
void setNumericValue(T value)
T numericDefaultValue() const
virtual const Object * defaultValue() const
Returns the default value for this parameter.
virtual bool presetsOnly() const
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43