Alembic: AbcCoreAbstract/ArchiveReader.h Source File

Alembic 1.8.11

Loading...
Searching...
No Matches
ArchiveReader.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_ArchiveReader_h
38#define Alembic_AbcCoreAbstract_ArchiveReader_h
39
40#include <Alembic/Util/Export.h>
41#include <Alembic/AbcCoreAbstract/Foundation.h>
42#include <Alembic/AbcCoreAbstract/ForwardDeclarations.h>
43#include <Alembic/AbcCoreAbstract/ReadArraySampleCache.h>
44
45namespace Alembic {
46namespace AbcCoreAbstract {
47namespace ALEMBIC_VERSION_NS {
48
49//-*****************************************************************************
59 namespace IllustrationOnly {
60 struct ALEMBIC_EXPORT ArchiveReaderConstructor
61{
62 // Create whatever cache is the default caching mechanism associated
63 // with the archive reader implementation
64 ArchiveReaderPtr operator()( const std::string &iFileName );
65
66 // Use the explicitly supplied cache implementation.
67 ArchiveReaderPtr operator()( const std::string &iFileName,
68 ReadArraySampleCachePtr iCachePtr );
69};
70} // End namespace IllustrationOnly
71
72//-*****************************************************************************
75 class ALEMBIC_EXPORT ArchiveReader
76 : private Alembic::Util::noncopyable
77{
78public:
81 virtual ~ArchiveReader();
82
83 //-*************************************************************************
84 // NEW FUNCTIONS
85 //-*************************************************************************
86
89 virtual const std::string &getName() const = 0;
90
93 virtual const MetaData &getMetaData() const = 0;
94
97 virtual ObjectReaderPtr getTop() = 0;
98
102 virtual ReadArraySampleCachePtr getReadArraySampleCachePtr() = 0;
103
107 virtual void setReadArraySampleCachePtr( ReadArraySampleCachePtr iPtr ) = 0;
108
110 virtual TimeSamplingPtr getTimeSampling( uint32_t iIndex ) = 0;
111
116 virtual index_t getMaxNumSamplesForTimeSamplingIndex( uint32_t iIndex ) = 0;
117
120 virtual uint32_t getNumTimeSamplings() = 0;
121
124 virtual int32_t getArchiveVersion() = 0;
125
128 virtual ArchiveReaderPtr asArchivePtr() = 0;
129};
130
131} // End namespace ALEMBIC_VERSION_NS
132
133using namespace ALEMBIC_VERSION_NS;
134
135} // End namespace AbcCoreAbstract
136} // End namespace Alembic
137
138#endif
139
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveReader
Definition ArchiveReader.h:77
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveReader::getMetaData
virtual const MetaData & getMetaData() const =0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveReader::getNumTimeSamplings
virtual uint32_t getNumTimeSamplings()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveReader::getTimeSampling
virtual TimeSamplingPtr getTimeSampling(uint32_t iIndex)=0
Returns the TimeSampling at a given index.
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveReader::asArchivePtr
virtual ArchiveReaderPtr asArchivePtr()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveReader::getReadArraySampleCachePtr
virtual ReadArraySampleCachePtr getReadArraySampleCachePtr()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveReader::getName
virtual const std::string & getName() const =0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveReader::getArchiveVersion
virtual int32_t getArchiveVersion()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveReader::getMaxNumSamplesForTimeSamplingIndex
virtual index_t getMaxNumSamplesForTimeSamplingIndex(uint32_t iIndex)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveReader::getTop
virtual ObjectReaderPtr getTop()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveReader::setReadArraySampleCachePtr
virtual void setReadArraySampleCachePtr(ReadArraySampleCachePtr iPtr)=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::MetaData
Definition MetaData.h:60
Alembic::Util::ALEMBIC_VERSION_NS::noncopyable
Definition Foundation.h:98
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::IllustrationOnly
Definition ArchiveReader.h:59
Alembic
Alembic namespace ...
Definition ArchiveInfo.cpp:39
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::IllustrationOnly::ArchiveReaderConstructor
Definition ArchiveReader.h:61