Cortex  10.0.0-a4
Parameterised.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_PARAMETERISED_H
36 #define IE_CORE_PARAMETERISED_H
37 
38 #include "IECore/Export.h"
39 #include "IECore/RunTimeTyped.h"
40 #include "IECore/ParameterisedInterface.h"
41 
42 namespace IECore
43 {
44 
45 IE_CORE_FORWARDDECLARE( CompoundObject )
46 
47 class IECORE_API Parameterised : public RunTimeTyped, public ParameterisedInterface
50 {
51 
52  public :
53 
54  IE_CORE_DECLARERUNTIMETYPED( Parameterised, RunTimeTyped );
55 
58  Parameterised( const std::string &description );
59 
61  Parameterised( const std::string &description, CompoundParameterPtr compoundParameter );
62 
63  ~Parameterised() override;
64 
66  const std::string &description() const;
67 
70  CompoundParameter *parameters() override;
72  const CompoundParameter *parameters() const override;
73 
75  CompoundObject *userData();
77  const CompoundObject *userData() const;
78 
79  private :
80 
81  std::string m_description;
82  CompoundParameterPtr m_parameters;
83  CompoundObjectPtr m_userData;
84 
85 };
86 
87 IE_CORE_DECLAREPTR( Parameterised );
88 
89 } // namespace IECore
90 
91 #endif // IE_CORE_PARAMETERISED_H
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43