ArrayPropertyReader.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_ArrayPropertyReader_h
#define Alembic_AbcCoreAbstract_ArrayPropertyReader_h
#include <Alembic/Util/Export.h>
#include <Alembic/AbcCoreAbstract/Foundation.h>
#include <Alembic/AbcCoreAbstract/BasePropertyReader.h>
#include <Alembic/AbcCoreAbstract/ArraySample.h>
namespace Alembic {
namespace AbcCoreAbstract {
namespace ALEMBIC_VERSION_NS {
//-*****************************************************************************
class ALEMBIC_EXPORT ArrayPropertyReader
: public BasePropertyReader
{
public:
virtual ~ArrayPropertyReader();
//-*************************************************************************
// NEW FUNCTIONS
//-*************************************************************************
virtual size_t getNumSamples() = 0;
virtual bool isConstant() = 0;
virtual void getSample( index_t iSampleIndex,
ArraySamplePtr &oSample ) = 0;
virtual std::pair<index_t, chrono_t> getFloorIndex( chrono_t iTime ) = 0;
virtual std::pair<index_t, chrono_t> getCeilIndex( chrono_t iTime ) = 0;
virtual std::pair<index_t, chrono_t> getNearIndex( chrono_t iTime ) = 0;
virtual bool getKey( index_t iSampleIndex, ArraySampleKey & oKey ) = 0;
virtual void getDimensions( index_t iSampleIndex, Dimensions & oDim ) = 0;
virtual bool isScalarLike() = 0;
virtual void getAs( index_t iSample, void *iIntoLocation,
PlainOldDataType iPod ) = 0;
};
} // End namespace ALEMBIC_VERSION_NS
using namespace ALEMBIC_VERSION_NS;
} // End namespace AbcCoreAbstract
} // End namespace Alembic
#endif
Foundation.h
ArraySample.h
BasePropertyReader.h
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition: Export.h:51
ALEMBIC_VERSION_NS
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReader
Definition: ArrayPropertyReader.h:57
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReader::~ArrayPropertyReader
virtual ~ArrayPropertyReader()
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::AbcCoreAbstract::ALEMBIC_VERSION_NS::index_t
int64_t index_t
Definition: Foundation.h:62
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArraySamplePtr
Alembic::Util::shared_ptr< ArraySample > ArraySamplePtr
Definition: ArraySample.h:138
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::chrono_t
float64_t chrono_t
Definition: Foundation.h:71
Alembic::Util::ALEMBIC_VERSION_NS::PlainOldDataType
PlainOldDataType
Definition: PlainOldDataType.h:184
Alembic::Util::ALEMBIC_VERSION_NS::Dimensions
BaseDimensions< Alembic::Util::uint64_t > Dimensions
Definition: Dimensions.h:189
Alembic
Alembic namespace ...
Definition: ArchiveInfo.h:46
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArraySampleKey
Definition: ArraySampleKey.h:48