Alembic Version 1.1

ISampleSelector.h
Go to the documentation of this file.
1//-*****************************************************************************
2//
3// Copyright (c) 2009-2011,
4// Sony Pictures Imageworks, Inc. and
5// Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
6//
7// All rights reserved.
8//
9// Redistribution and use in source and binary forms, with or without
10// modification, are permitted provided that the following conditions are
11// met:
12// * Redistributions of source code must retain the above copyright
13// notice, this list of conditions and the following disclaimer.
14// * Redistributions in binary form must reproduce the above
15// copyright notice, this list of conditions and the following disclaimer
16// in the documentation and/or other materials provided with the
17// distribution.
18// * Neither the name of Sony Pictures Imageworks, nor
19// Industrial Light & Magic nor the names of their contributors may be used
20// to endorse or promote products derived from this software without specific
21// prior written permission.
22//
23// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34//
35//-*****************************************************************************
36
37#ifndef Alembic_Abc_ISampleSelector_h
38#define Alembic_Abc_ISampleSelector_h
39
40#include <Alembic/Util/Export.h>
41#include <Alembic/Abc/Foundation.h>
42
43 namespace Alembic {
44 namespace Abc {
45 namespace ALEMBIC_VERSION_NS {
46
47//-*****************************************************************************
48 class ALEMBIC_EXPORT ISampleSelector
49{
50 public:
51 enum TimeIndexType
52 {
53 kFloorIndex,
54 kCeilIndex,
55 kNearIndex
56 };
57
58 ISampleSelector()
59 : m_requestedIndex( 0 ),
60 m_requestedTime( 0.0 ),
61 m_requestedTimeIndexType( kNearIndex ) {}
62
63 ISampleSelector( index_t iReqIdx )
64 : m_requestedIndex( iReqIdx ),
65 m_requestedTime( 0.0 ),
66 m_requestedTimeIndexType( kNearIndex ) {}
67
68 explicit ISampleSelector( chrono_t iReqTime,
69 TimeIndexType iReqIdxType = kNearIndex )
70 : m_requestedIndex( -1 ),
71 m_requestedTime( iReqTime ),
72 m_requestedTimeIndexType( iReqIdxType ) {}
73
74 index_t getRequestedIndex() const { return m_requestedIndex; }
75 chrono_t getRequestedTime() const { return m_requestedTime; }
76 TimeIndexType getRequestedTimeIndexType() const
77 { return m_requestedTimeIndexType; }
78
79 index_t getIndex( const AbcA::TimeSamplingPtr & iTsmp, index_t
80 iNumSamples ) const;
81
82 private:
83 index_t m_requestedIndex;
84 chrono_t m_requestedTime;
85 TimeIndexType m_requestedTimeIndexType;
86};
87
88} // End namespace ALEMBIC_VERSION_NS
89
90 using namespace ALEMBIC_VERSION_NS;
91
92} // End namespace Abc
93} // End namespace Alembic
94
95#endif
Foundation.h
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition: Export.h:51
ALEMBIC_VERSION_NS
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector
Definition: ISampleSelector.h:49
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector::getRequestedIndex
index_t getRequestedIndex() const
Definition: ISampleSelector.h:74
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector::getRequestedTimeIndexType
TimeIndexType getRequestedTimeIndexType() const
Definition: ISampleSelector.h:76
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector::ISampleSelector
ISampleSelector()
Definition: ISampleSelector.h:58
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector::getIndex
index_t getIndex(const AbcA::TimeSamplingPtr &iTsmp, index_t iNumSamples) const
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector::getRequestedTime
chrono_t getRequestedTime() const
Definition: ISampleSelector.h:75
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector::ISampleSelector
ISampleSelector(chrono_t iReqTime, TimeIndexType iReqIdxType=kNearIndex)
Definition: ISampleSelector.h:68
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector::TimeIndexType
TimeIndexType
Definition: ISampleSelector.h:52
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector::kCeilIndex
@ kCeilIndex
Definition: ISampleSelector.h:54
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector::kFloorIndex
@ kFloorIndex
Definition: ISampleSelector.h:53
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector::ISampleSelector
ISampleSelector(index_t iReqIdx)
Definition: ISampleSelector.h:63
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::index_t
int64_t index_t
Definition: Foundation.h:62
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::chrono_t
float64_t chrono_t
Definition: Foundation.h:71
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSamplingPtr
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
Alembic::Abc::ALEMBIC_VERSION_NS
Definition: ArchiveInfo.h:48
Alembic
Alembic namespace ...
Definition: ArchiveInfo.h:46