Cortex  10.0.0-a4
FrameRange.h
1 //
3 // Copyright (c) 2009, 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_FRAMERANGE_H
36 #define IE_CORE_FRAMERANGE_H
37 
38 #include "IECore/Export.h"
39 #include "IECore/FrameList.h"
40 
41 namespace IECore
42 {
43 
47 class IECORE_API FrameRange : public FrameList
48 {
49  public:
50 
51  IE_CORE_DECLARERUNTIMETYPED( FrameRange, FrameList );
52 
53  FrameRange( Frame start, Frame end, Frame step = 1 );
54  ~FrameRange() override;
55 
56  void asList( std::vector<Frame> &frames ) const override ;
57  std::string asString() const override ;
58  bool isEqualTo( ConstFrameListPtr other ) const override;
59  FrameListPtr copy() const override;
60 
61  static FrameListPtr parse( const std::string &frameList );
62 
63  Frame getStart();
64  void setStart( Frame start );
65 
66  Frame getEnd();
67  void setEnd( Frame end );
68 
69  Frame getStep();
70  void setStep( Frame step );
71 
72  protected :
73 
74  Frame m_start;
75  Frame m_end;
76  Frame m_step;
77 
78  private :
79 
80  static FrameList::Parser< FrameRange > g_parserRegistrar;
81 };
82 
83 IE_CORE_DECLAREPTR( FrameRange );
84 
85 } // namespace IECore
86 
87 
88 #endif // IE_CORE_FRAMERANGE_H
Definition: FrameRange.h:47
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43
Definition: FrameList.h:52