Loading...
Searching...
No Matches
IArrayProperty.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_Abc_IArrayProperty_h
#define Alembic_Abc_IArrayProperty_h
#include <Alembic/Util/Export.h>
#include <Alembic/Abc/Foundation.h>
#include <Alembic/Abc/Base.h>
#include <Alembic/Abc/Argument.h>
#include <Alembic/Abc/ISampleSelector.h>
#include <Alembic/Abc/IBaseProperty.h>
#include <Alembic/Abc/ICompoundProperty.h>
namespace Alembic {
namespace Abc {
namespace ALEMBIC_VERSION_NS {
//-*****************************************************************************
class ALEMBIC_EXPORT IArrayProperty
: public IBasePropertyT<AbcA::ArrayPropertyReaderPtr>
{
public:
typedef IArrayProperty this_type;
//-*************************************************************************
// CONSTRUCTION, DESTRUCTION, ASSIGNMENT
//-*************************************************************************
IArrayProperty() : IBasePropertyT<AbcA::ArrayPropertyReaderPtr>() {}
IArrayProperty( const ICompoundProperty & iParent,
const std::string &iName,
const Argument &iArg0 = Argument(),
const Argument &iArg1 = Argument() );
IArrayProperty(
AbcA::ArrayPropertyReaderPtr iPtr,
const Argument &iArg0 = Argument() )
: IBasePropertyT<AbcA::ArrayPropertyReaderPtr>( iPtr,
GetErrorHandlerPolicy( iPtr, iArg0 ) ) {};
// Deprecated in favor of the constructor above
IArrayProperty(
AbcA::ArrayPropertyReaderPtr iPtr,
WrapExistingFlag iWrapFlag,
const Argument &iArg0 = Argument() )
: IBasePropertyT<AbcA::ArrayPropertyReaderPtr>( iPtr,
GetErrorHandlerPolicy( iPtr, iArg0 ) ) {};
~IArrayProperty();
//-*************************************************************************
// ARRAY PROPERTY READER FUNCTIONALITY
//-*************************************************************************
size_t getNumSamples() const;
bool isConstant() const;
bool isScalarLike() const;
AbcA::TimeSamplingPtr getTimeSampling() const;
void get( AbcA::ArraySamplePtr& oSample,
const ISampleSelector &iSS = ISampleSelector() ) const;
void getAs( void *oSample, AbcA::PlainOldDataType iPod,
const ISampleSelector &iSS = ISampleSelector() );
void getAs( void *oSample,
const ISampleSelector &iSS = ISampleSelector() );
bool getKey( AbcA::ArraySampleKey& oKey,
const ISampleSelector &iSS = ISampleSelector() ) const;
void getDimensions( Util::Dimensions & oDim,
const ISampleSelector &iSS = ISampleSelector() ) const;
ICompoundProperty getParent() const;
private:
void init( AbcA::CompoundPropertyReaderPtr iParentObject,
const std::string &iName,
ErrorHandler::Policy iParentPolicy,
const Argument &iArg0,
const Argument &iArg1 );
};
} // End namespace ALEMBIC_VERSION_NS
using namespace ALEMBIC_VERSION_NS;
} // End namespace Abc
} // End namespace Alembic
#endif
Foundation.h
Argument.h
Base.h
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition Export.h:51
IBaseProperty.h
ICompoundProperty.h
ISampleSelector.h
Alembic::Abc::ALEMBIC_VERSION_NS::Argument
Definition Argument.h:120
Alembic::Abc::ALEMBIC_VERSION_NS::ErrorHandler::Policy
Policy
Definition ErrorHandler.h:52
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::getAs
void getAs(void *oSample, AbcA::PlainOldDataType iPod, const ISampleSelector &iSS=ISampleSelector())
Get a sample into the address of a datum as a particular POD type.
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::~IArrayProperty
~IArrayProperty()
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::get
void get(AbcA::ArraySamplePtr &oSample, const ISampleSelector &iSS=ISampleSelector()) const
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::isScalarLike
bool isScalarLike() const
Ask if we are like a scalar - we have 1 and only 1 DataType per sample.
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::getAs
void getAs(void *oSample, const ISampleSelector &iSS=ISampleSelector())
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::isConstant
bool isConstant() const
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::IArrayProperty
IArrayProperty()
Definition IArrayProperty.h:66
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::IArrayProperty
IArrayProperty(AbcA::ArrayPropertyReaderPtr iPtr, WrapExistingFlag iWrapFlag, const Argument &iArg0=Argument())
Definition IArrayProperty.h:92
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::getKey
bool getKey(AbcA::ArraySampleKey &oKey, const ISampleSelector &iSS=ISampleSelector()) const
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::getParent
ICompoundProperty getParent() const
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::getTimeSampling
AbcA::TimeSamplingPtr getTimeSampling() const
Time information.
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::IArrayProperty
IArrayProperty(const ICompoundProperty &iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::IArrayProperty
IArrayProperty(AbcA::ArrayPropertyReaderPtr iPtr, const Argument &iArg0=Argument())
Definition IArrayProperty.h:80
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::getDimensions
void getDimensions(Util::Dimensions &oDim, const ISampleSelector &iSS=ISampleSelector()) const
Get the dimensions of the datum.
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::this_type
IArrayProperty this_type
Definition IArrayProperty.h:58
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::getNumSamples
size_t getNumSamples() const
Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::ArrayPropertyReaderPtr >::IBasePropertyT
IBasePropertyT()
Definition IBaseProperty.h:72
Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
Definition ICompoundProperty.h:53
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector
Definition ISampleSelector.h:49
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReaderPtr
Alembic::Util::shared_ptr< ArrayPropertyReader > ArrayPropertyReaderPtr
Definition ForwardDeclarations.h:93
Alembic::Abc::ALEMBIC_VERSION_NS
Definition ArchiveInfo.h:48
Alembic::Abc::ALEMBIC_VERSION_NS::GetErrorHandlerPolicy
ErrorHandler::Policy GetErrorHandlerPolicy(SOMETHING iSomething, const Argument &iArg0, const Argument &iArg1=Argument(), const Argument &iArg2=Argument(), const Argument &iArg3=Argument())
Definition Argument.h:242
Alembic::Abc::ALEMBIC_VERSION_NS::WrapExistingFlag
WrapExistingFlag
Definition Foundation.h:94
Alembic::Abc
Definition ArchiveInfo.h:47
Alembic::Util::ALEMBIC_VERSION_NS::Dimensions
BaseDimensions< Alembic::Util::uint64_t > Dimensions
Definition Dimensions.h:189
Alembic
Alembic namespace ...
Definition ArchiveInfo.h:46