Loading...
Searching...
No Matches
ArchiveReader.h
Go to the documentation of this file.
//-*****************************************************************************
//
// Copyright (c) 2009-2012,
// Sony Pictures Imageworks Inc. and
// Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Sony Pictures Imageworks, nor
// Industrial Light & Magic, nor the names of their contributors may be used
// to endorse or promote products derived from this software without specific
// prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//-*****************************************************************************
#ifndef Alembic_AbcCoreAbstract_ArchiveReader_h
#define Alembic_AbcCoreAbstract_ArchiveReader_h
#include <Alembic/Util/Export.h>
#include <Alembic/AbcCoreAbstract/Foundation.h>
#include <Alembic/AbcCoreAbstract/ForwardDeclarations.h>
#include <Alembic/AbcCoreAbstract/ReadArraySampleCache.h>
namespace Alembic {
namespace AbcCoreAbstract {
namespace ALEMBIC_VERSION_NS {
//-*****************************************************************************
namespace IllustrationOnly {
struct ALEMBIC_EXPORT ArchiveReaderConstructor
{
// Create whatever cache is the default caching mechanism associated
// with the archive reader implementation
ArchiveReaderPtr operator()( const std::string &iFileName );
// Use the explicitly supplied cache implementation.
ArchiveReaderPtr operator()( const std::string &iFileName,
ReadArraySampleCachePtr iCachePtr );
};
} // End namespace IllustrationOnly
//-*****************************************************************************
class ALEMBIC_EXPORT ArchiveReader
: private Alembic::Util::noncopyable
{
public:
virtual ~ArchiveReader();
//-*************************************************************************
// NEW FUNCTIONS
//-*************************************************************************
virtual const std::string &getName() const = 0;
virtual const MetaData &getMetaData() const = 0;
virtual ObjectReaderPtr getTop() = 0;
virtual ReadArraySampleCachePtr getReadArraySampleCachePtr() = 0;
virtual void setReadArraySampleCachePtr( ReadArraySampleCachePtr iPtr ) = 0;
virtual TimeSamplingPtr getTimeSampling( uint32_t iIndex ) = 0;
virtual index_t getMaxNumSamplesForTimeSamplingIndex( uint32_t iIndex ) = 0;
virtual uint32_t getNumTimeSamplings() = 0;
virtual int32_t getArchiveVersion() = 0;
virtual ArchiveReaderPtr asArchivePtr() = 0;
};
} // End namespace ALEMBIC_VERSION_NS
using namespace ALEMBIC_VERSION_NS;
} // End namespace AbcCoreAbstract
} // End namespace Alembic
#endif
Foundation.h
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition Export.h:51
ForwardDeclarations.h
ReadArraySampleCache.h
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::~ArchiveReader
virtual ~ArchiveReader()
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:115
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::IllustrationOnly
Definition ArchiveReader.h:59
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS
Definition ArchiveReader.h:47
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::index_t
int64_t index_t
Definition Foundation.h:62
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSamplingPtr
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition TimeSampling.h:137
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReaderPtr
Alembic::Util::shared_ptr< ObjectReader > ObjectReaderPtr
Definition ForwardDeclarations.h:91
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleCachePtr
Alembic::Util::shared_ptr< ReadArraySampleCache > ReadArraySampleCachePtr
Definition ReadArraySampleCache.h:138
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveReaderPtr
Alembic::Util::shared_ptr< ArchiveReader > ArchiveReaderPtr
Smart Ptrs to Readers.
Definition ForwardDeclarations.h:90
Alembic::AbcCoreAbstract
Definition ArchiveReader.h:46
Alembic
Alembic namespace ...
Definition ArchiveInfo.h:46