Cortex  10.0.0-a4
FileSequenceVectorParameter.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_FILESEQUENCEVECTORPARAMETER_H
36 #define IE_CORE_FILESEQUENCEVECTORPARAMETER_H
37 
38 #include <vector>
39 
40 #include "IECore/Export.h"
41 #include "IECore/FrameList.h"
42 #include "IECore/FileSequence.h"
43 #include "IECore/PathVectorParameter.h"
44 
45 namespace IECore
46 {
47 
56 {
57  public:
58 
59  typedef std::vector< std::string > ExtensionList;
60 
61  IE_CORE_DECLARERUNTIMETYPED( FileSequenceVectorParameter, PathVectorParameter );
62 
63  FileSequenceVectorParameter( const std::string &name, const std::string &description, const std::vector< std::string > &defaultValue, bool allowEmptyList = true, CheckType check = PathVectorParameter::DontCare,
64  const StringVectorParameter::PresetsContainer &presets = StringVectorParameter::PresetsContainer(), bool presetsOnly = false, ConstCompoundObjectPtr userData=nullptr,
65  const ExtensionList &extensions = ExtensionList() );
66 
67  FileSequenceVectorParameter( const std::string &name, const std::string &description, ObjectTypePtr defaultValue, bool allowEmptyList = true, CheckType check = PathVectorParameter::DontCare,
68  const StringVectorParameter::ObjectPresetsContainer &presets = StringVectorParameter::ObjectPresetsContainer(), bool presetsOnly = false, ConstCompoundObjectPtr userData=nullptr,
69  const ExtensionList &extensions = ExtensionList() );
70 
71  ~FileSequenceVectorParameter() override;
72 
73  const ExtensionList &getExtensions() const;
74  void setExtensions( const ExtensionList &extensions );
75 
79  bool valueValid( const Object *value, std::string *reason = nullptr ) const override;
80 
81  void setFileSequenceValues( const std::vector< FileSequencePtr > &sequences );
82 
85  void getFileSequenceValues( const StringVectorData *value, std::vector< FileSequencePtr > &sequences ) const;
86 
88  void getFileSequenceValues( std::vector< FileSequencePtr > &sequences ) const;
89 
90 
91  protected :
92 
97  FileSequencePtr parseFileSequence( const std::string &fileSequenceString ) const;
98 
99  ExtensionList m_extensions;
100 
101 };
102 
103 IE_CORE_DECLAREPTR( FileSequenceVectorParameter );
104 
105 } // namespace IECore
106 
107 #endif // IE_CORE_FILESEQUENCEVECTORPARAMETER_H
Definition: PathVectorParameter.h:46
Definition: FileSequenceVectorParameter.h:55
Definition: Object.h:104
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43