Cortex  10.0.0-a4
FileSequenceParameter.h
1 //
3 // Copyright (c) 2009-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_FILESEQUENCEPARAMETER_H
36 #define IE_CORE_FILESEQUENCEPARAMETER_H
37 
38 #include <vector>
39 
40 #include "IECore/Export.h"
41 #include "IECore/FrameList.h"
42 #include "IECore/FileSequence.h"
43 #include "IECore/PathParameter.h"
44 
45 namespace IECore
46 {
47 
51 class IECORE_API FileSequenceParameter : public PathParameter
52 {
53  public:
54 
55  typedef std::vector< std::string > ExtensionList;
56 
57  IE_CORE_DECLARERUNTIMETYPED( FileSequenceParameter, PathParameter );
58 
61  FileSequenceParameter( const std::string &name, const std::string &description, const std::string &defaultValue = "", bool allowEmptyString = true, CheckType check = PathParameter::DontCare,
62  const StringParameter::PresetsContainer &presets = StringParameter::PresetsContainer(), bool presetsOnly = false, ConstCompoundObjectPtr userData=nullptr,
63  const ExtensionList &extensions = ExtensionList(), size_t minSequenceSize = 2 );
64 
65  ~FileSequenceParameter() override;
66 
67  const ExtensionList &getExtensions() const;
68  void setExtensions( const ExtensionList &extensions );
69 
70  size_t getMinSequenceSize() const;
71  void setMinSequenceSize( size_t size );
72 
76  bool valueValid( const Object *value, std::string *reason = nullptr ) const override;
77 
79  void setFileSequenceValue( ConstFileSequencePtr fileSequence );
80 
87  FileSequencePtr getFileSequenceValue( const StringData *value ) const;
88 
90  FileSequencePtr getFileSequenceValue() const;
91 
92  protected :
93 
94  ExtensionList m_extensions;
95  size_t m_minSequenceSize;
96 
97 };
98 
99 IE_CORE_DECLAREPTR( FileSequenceParameter );
100 
101 } // namespace IECore
102 
103 #endif // IE_CORE_FILESEQUENCEPARAMETER_H
Definition: PathParameter.h:46
Definition: Object.h:104
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43
Definition: FileSequenceParameter.h:51