Cortex  10.0.0-a4
ObjectParameter.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_OBJECTPARAMETER_H
36 #define IE_CORE_OBJECTPARAMETER_H
37 
38 #include "IECore/Export.h"
39 #include "IECore/Parameter.h"
40 
41 #include <set>
42 
43 namespace IECore
44 {
45 
48 class IECORE_API ObjectParameter : public Parameter
49 {
50  public :
51 
52  IE_CORE_DECLARERUNTIMETYPED( ObjectParameter, Parameter )
53 
54  typedef std::set<TypeId> TypeIdSet;
55 
56  ObjectParameter( const std::string &name, const std::string &description, ObjectPtr defaultValue, TypeId type, const PresetsContainer &presets = PresetsContainer(), bool presetsOnly = false,ConstCompoundObjectPtr userData=nullptr );
57  ObjectParameter( const std::string &name, const std::string &description, ObjectPtr defaultValue, const TypeIdSet &types, const PresetsContainer &presets = PresetsContainer(), bool presetsOnly = false, ConstCompoundObjectPtr userData=nullptr );
59  ObjectParameter( const std::string &name, const std::string &description, ObjectPtr defaultValue, const TypeId *types, const PresetsContainer &presets = PresetsContainer(), bool presetsOnly = false, ConstCompoundObjectPtr userData=nullptr );
60 
62  bool valueValid( const Object *value, std::string *reason = nullptr ) const override;
63 
65  const TypeIdSet &validTypes() const;
66 
67  private :
68 
69  TypeIdSet m_validTypes;
70 
71 };
72 
73 IE_CORE_DECLAREPTR( ObjectParameter );
74 
75 } // namespace IECore
76 
77 #endif // IE_CORE_OBJECTPARAMETER_H
Definition: Parameter.h:53
Definition: ObjectParameter.h:48
std::vector< Preset > PresetsContainer
A type to store a bunch of preset values for the Parameter.
Definition: Parameter.h:63
Definition: Object.h:104
TypeId
Definition: TypeIds.h:46
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43