Alembic Version 1.1

TimeSampling.h
Go to the documentation of this file.
1//-*****************************************************************************
2//
3// Copyright (c) 2009-2012,
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_AbcCoreAbstract_TimeSampling_h
38#define Alembic_AbcCoreAbstract_TimeSampling_h
39
40#include <Alembic/Util/Export.h>
41#include <Alembic/AbcCoreAbstract/Foundation.h>
42#include <Alembic/AbcCoreAbstract/TimeSamplingType.h>
43#include <Alembic/AbcCoreAbstract/ArraySample.h>
44
45 namespace Alembic {
46 namespace AbcCoreAbstract {
47 namespace ALEMBIC_VERSION_NS {
48
49
50//-*****************************************************************************
57 class ALEMBIC_EXPORT TimeSampling
58{
59 public:
64 TimeSampling( const TimeSamplingType & iTimeSamplingType,
65
67 const std::vector < chrono_t > & iSampleTimes );
68
71 TimeSampling( chrono_t iTimePerCycle, chrono_t iStartTime );
72
73 TimeSampling( const TimeSampling &copy );
74
75 TimeSampling();
76
77 bool operator==( const TimeSampling & iRhs ) const
78 {
79 return (m_timeSamplingType == iRhs.m_timeSamplingType &&
80 m_sampleTimes == iRhs.m_sampleTimes);
81 }
82
87 size_t getNumStoredTimes() const
88 {
89 return m_sampleTimes.size();
90 }
91
92 const std::vector < chrono_t > & getStoredTimes() const
93 {
94 return m_sampleTimes;
95 }
96
97 TimeSamplingType getTimeSamplingType() const
98 {
99 return m_timeSamplingType;
100 }
101
104 chrono_t getSampleTime( index_t iIndex ) const;
105
110 std::pair<index_t, chrono_t> getFloorIndex( chrono_t iTime,
111 index_t iNumSamples ) const;
112
117 std::pair<index_t, chrono_t> getCeilIndex( chrono_t iTime,
118 index_t iNumSamples ) const;
119
122 std::pair<index_t, chrono_t> getNearIndex( chrono_t iTime,
123 index_t iNumSamples ) const;
124
125 protected:
128 TimeSamplingType m_timeSamplingType;
129
130 std::vector < chrono_t > m_sampleTimes;
131
132 private:
133 // sanity checks the data coming in
134 void init();
135};
136
137 typedef Alembic::Util::shared_ptr<TimeSampling> TimeSamplingPtr;
138
139} // End namespace ALEMBIC_VERSION_NS
140
141 using namespace ALEMBIC_VERSION_NS;
142
143} // End namespace AbcCoreAbstract
144} // End namespace Alembic
145
146#endif
147
Foundation.h
ArraySample.h
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition: Export.h:51
TimeSamplingType.h
ALEMBIC_VERSION_NS
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSamplingType
Definition: TimeSamplingType.h:69
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling
Definition: TimeSampling.h:58
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling::getFloorIndex
std::pair< index_t, chrono_t > getFloorIndex(chrono_t iTime, index_t iNumSamples) const
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling::TimeSampling
TimeSampling(chrono_t iTimePerCycle, chrono_t iStartTime)
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling::getNearIndex
std::pair< index_t, chrono_t > getNearIndex(chrono_t iTime, index_t iNumSamples) const
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling::TimeSampling
TimeSampling(const TimeSamplingType &iTimeSamplingType, const std::vector< chrono_t > &iSampleTimes)
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling::getStoredTimes
const std::vector< chrono_t > & getStoredTimes() const
Definition: TimeSampling.h:92
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling::operator==
bool operator==(const TimeSampling &iRhs) const
Definition: TimeSampling.h:77
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling::m_timeSamplingType
TimeSamplingType m_timeSamplingType
Definition: TimeSampling.h:128
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling::TimeSampling
TimeSampling(const TimeSampling &copy)
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling::m_sampleTimes
std::vector< chrono_t > m_sampleTimes
Definition: TimeSampling.h:130
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling::getSampleTime
chrono_t getSampleTime(index_t iIndex) const
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling::getNumStoredTimes
size_t getNumStoredTimes() const
Definition: TimeSampling.h:87
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling::getTimeSamplingType
TimeSamplingType getTimeSamplingType() const
Definition: TimeSampling.h:97
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling::TimeSampling
TimeSampling()
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSampling::getCeilIndex
std::pair< index_t, chrono_t > getCeilIndex(chrono_t iTime, index_t iNumSamples) const
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
Alembic namespace ...
Definition: ArchiveInfo.h:46