Alembic 1.8.11

Loading...
Searching...
No Matches
ArrayPropertyReader.h
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_ArrayPropertyReader_h
38#define Alembic_AbcCoreAbstract_ArrayPropertyReader_h
39
40#include <Alembic/Util/Export.h>
41#include <Alembic/AbcCoreAbstract/Foundation.h>
42#include <Alembic/AbcCoreAbstract/BasePropertyReader.h>
43#include <Alembic/AbcCoreAbstract/ArraySample.h>
44
45 namespace Alembic {
46 namespace AbcCoreAbstract {
47 namespace ALEMBIC_VERSION_NS {
48
49//-*****************************************************************************
55 class ALEMBIC_EXPORT ArrayPropertyReader
56 : public BasePropertyReader
57{
58 public:
61 virtual ~ArrayPropertyReader();
62
63 //-*************************************************************************
64 // NEW FUNCTIONS
65 //-*************************************************************************
66
72 virtual size_t getNumSamples() = 0;
73
76 virtual bool isConstant() = 0;
77
93 virtual void getSample( index_t iSampleIndex,
94 ArraySamplePtr &oSample ) = 0;
95
100 virtual std::pair<index_t, chrono_t> getFloorIndex( chrono_t iTime ) = 0;
101
106 virtual std::pair<index_t, chrono_t> getCeilIndex( chrono_t iTime ) = 0;
107
110 virtual std::pair<index_t, chrono_t> getNearIndex( chrono_t iTime ) = 0;
111
113 virtual bool getKey( index_t iSampleIndex, ArraySampleKey & oKey ) = 0;
114
118 virtual void getDimensions( index_t iSampleIndex, Dimensions & oDim ) = 0;
119
123 virtual bool isScalarLike() = 0;
124
142 virtual void getAs( index_t iSample, void *iIntoLocation,
143 PlainOldDataType iPod ) = 0;
144};
145
146} // End namespace ALEMBIC_VERSION_NS
147
148 using namespace ALEMBIC_VERSION_NS;
149
150} // End namespace AbcCoreAbstract
151} // End namespace Alembic
152
153
154
155#endif
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReader
Definition ArrayPropertyReader.h:57
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReader::getNumSamples
virtual size_t getNumSamples()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReader::getDimensions
virtual void getDimensions(index_t iSampleIndex, Dimensions &oDim)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReader::getCeilIndex
virtual std::pair< index_t, chrono_t > getCeilIndex(chrono_t iTime)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReader::getNearIndex
virtual std::pair< index_t, chrono_t > getNearIndex(chrono_t iTime)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReader::getSample
virtual void getSample(index_t iSampleIndex, ArraySamplePtr &oSample)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReader::isConstant
virtual bool isConstant()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReader::isScalarLike
virtual bool isScalarLike()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReader::getKey
virtual bool getKey(index_t iSampleIndex, ArraySampleKey &oKey)=0
Expose the key for apps that use their own custom cache management.
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReader::getAs
virtual void getAs(index_t iSample, void *iIntoLocation, PlainOldDataType iPod)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReader::getFloorIndex
virtual std::pair< index_t, chrono_t > getFloorIndex(chrono_t iTime)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader
Base Property Reader.
Definition BasePropertyReader.h:53
Alembic
Alembic namespace ...
Definition ArchiveInfo.cpp:39
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArraySampleKey
Definition ArraySampleKey.h:48