Cortex  10.0.0-a4
TypedParameter.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_TYPEDPARAMETER_H
36 #define IE_CORE_TYPEDPARAMETER_H
37 
38 #include "IECore/Parameter.h"
39 #include "IECore/TypedData.h"
40 #include "IECore/TypedParameterInternals.h"
41 
42 namespace IECore
43 {
44 
47 template<typename T>
48 class TypedParameter : public Parameter
49 {
50  public :
51 
52  typedef T ValueType;
54 
55  IE_CORE_DECLAREPTR( ObjectType );
56 
57  typedef std::pair<std::string, T> Preset;
58  typedef std::pair<std::string, ObjectTypePtr> ObjectPreset;
59  typedef std::vector<Preset> PresetsContainer;
60  typedef std::vector<ObjectPreset> ObjectPresetsContainer;
61 
63  TypedParameter( const std::string &name, const std::string &description, const T &defaultValue = T(),
64  const PresetsContainer &presets = PresetsContainer(), bool presetsOnly = false, ConstCompoundObjectPtr userData = nullptr );
66  TypedParameter( const std::string &name, const std::string &description, ObjectTypePtr defaultValue,
67  const ObjectPresetsContainer &presets = ObjectPresetsContainer(), bool presetsOnly = false, ConstCompoundObjectPtr userData = nullptr );
68 
69  IECORE_RUNTIMETYPED_DECLARETEMPLATE( TypedParameter<T>, Parameter );
70 
72  bool valueValid( const Object *value, std::string *reason = nullptr ) const override;
73 
76  const ValueType &typedDefaultValue() const;
77 
83  ValueType &getTypedValue();
84  const ValueType &getTypedValue() const;
87  void setTypedValue( const T &value );
88 
89  private :
90 
91  static const TypeDescription<TypedParameter<T> > g_typeDescription;
92 
93 };
94 
95 } // namespace IECore
96 
97 #endif // IE_CORE_TYPEDPARAMETER_H
Definition: Parameter.h:53
TypedParameter(const std::string &name, const std::string &description, const T &defaultValue=T(), const PresetsContainer &presets=PresetsContainer(), bool presetsOnly=false, ConstCompoundObjectPtr userData=nullptr)
Constructs a new ObjectType object to hold the default value.
const ValueType & typedDefaultValue() const
const std::string & description() const
Returns the description for this parameter.
void setTypedValue(const T &value)
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: TypedParameter.h:48
Definition: TypedData.h:64
CompoundObject * userData()
Returns the userdata. This can be modified freely.
Definition: Object.h:104
bool valueValid(const Object *value, std::string *reason=nullptr) const override
Implemented to return true only if value is of type TypedData.
const std::string & name() const
Returns the name of this parameter.
ValueType & getTypedValue()
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