OArrayProperty.h
Go to the documentation of this file.
//-*****************************************************************************
//
// Copyright (c) 2009-2011,
// 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_OArrayProperty_h
#define Alembic_Abc_OArrayProperty_h
#include <Alembic/Util/Export.h>
#include <Alembic/Abc/Foundation.h>
#include <Alembic/Abc/Base.h>
#include <Alembic/Abc/Argument.h>
#include <Alembic/Abc/OBaseProperty.h>
#include <Alembic/Abc/OCompoundProperty.h>
namespace Alembic {
namespace Abc {
namespace ALEMBIC_VERSION_NS {
//-*****************************************************************************
class ALEMBIC_EXPORT OArrayProperty
: public OBasePropertyT<AbcA::ArrayPropertyWriterPtr>
{
public:
typedef OArrayProperty this_type;
//-*************************************************************************
// CONSTRUCTION, DESTRUCTION, ASSIGNMENT
//-*************************************************************************
OArrayProperty() : OBasePropertyT<AbcA::ArrayPropertyWriterPtr>() {}
OArrayProperty( OCompoundProperty iParent,
const std::string &iName,
const AbcA::DataType &iDataType,
const Argument &iArg0 = Argument(),
const Argument &iArg1 = Argument(),
const Argument &iArg2 = Argument() );
OArrayProperty(
AbcA::ArrayPropertyWriterPtr iPtr,
const Argument &iArg0 = Argument() )
: OBasePropertyT<AbcA::ArrayPropertyWriterPtr>( iPtr,
GetErrorHandlerPolicy( iPtr, iArg0 ) ) {}
// Deprecated in favor of the constructor above
OArrayProperty(
AbcA::ArrayPropertyWriterPtr iPtr,
WrapExistingFlag iWrapFlag,
const Argument &iArg0 = Argument() )
: OBasePropertyT<AbcA::ArrayPropertyWriterPtr>( iPtr,
GetErrorHandlerPolicy( iPtr, iArg0 ) ) {}
~OArrayProperty();
//-*************************************************************************
// ARRAY PROPERTY WRITER FUNCTIONALITY
//-*************************************************************************
size_t getNumSamples() const;
void set( const AbcA::ArraySample &iSample );
void setFromPrevious( );
void setTimeSampling( uint32_t iIndex );
void setTimeSampling( AbcA::TimeSamplingPtr iTime );
OCompoundProperty getParent() const;
private:
void init( AbcA::CompoundPropertyWriterPtr iParentObject,
const std::string &iName,
const AbcA::DataType &iDataType,
ErrorHandler::Policy iParentPolicy,
const Argument &iArg0,
const Argument &iArg1,
const Argument &iArg2 );
};
} // 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
OBaseProperty.h
OCompoundProperty.h
ALEMBIC_VERSION_NS
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArraySample
Definition: ArraySample.h:60
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::DataType
Definition: DataType.h:52
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::OArrayProperty
Definition: OArrayProperty.h:53
Alembic::Abc::ALEMBIC_VERSION_NS::OArrayProperty::OArrayProperty
OArrayProperty(AbcA::ArrayPropertyWriterPtr iPtr, WrapExistingFlag iWrapFlag, const Argument &iArg0=Argument())
Definition: OArrayProperty.h:88
Alembic::Abc::ALEMBIC_VERSION_NS::OArrayProperty::OArrayProperty
OArrayProperty(AbcA::ArrayPropertyWriterPtr iPtr, const Argument &iArg0=Argument())
Definition: OArrayProperty.h:81
Alembic::Abc::ALEMBIC_VERSION_NS::OArrayProperty::getNumSamples
size_t getNumSamples() const
Alembic::Abc::ALEMBIC_VERSION_NS::OArrayProperty::setTimeSampling
void setTimeSampling(uint32_t iIndex)
Alembic::Abc::ALEMBIC_VERSION_NS::OArrayProperty::OArrayProperty
OArrayProperty()
Definition: OArrayProperty.h:65
Alembic::Abc::ALEMBIC_VERSION_NS::OArrayProperty::getParent
OCompoundProperty getParent() const
Alembic::Abc::ALEMBIC_VERSION_NS::OArrayProperty::set
void set(const AbcA::ArraySample &iSample)
Alembic::Abc::ALEMBIC_VERSION_NS::OArrayProperty::setTimeSampling
void setTimeSampling(AbcA::TimeSamplingPtr iTime)
Alembic::Abc::ALEMBIC_VERSION_NS::OArrayProperty::OArrayProperty
OArrayProperty(OCompoundProperty iParent, const std::string &iName, const AbcA::DataType &iDataType, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
Alembic::Abc::ALEMBIC_VERSION_NS::OArrayProperty::~OArrayProperty
~OArrayProperty()
Alembic::Abc::ALEMBIC_VERSION_NS::OArrayProperty::setFromPrevious
void setFromPrevious()
Alembic::Abc::ALEMBIC_VERSION_NS::OArrayProperty::this_type
OArrayProperty this_type
Definition: OArrayProperty.h:57
Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT
Definition: OBaseProperty.h:58
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty
Definition: OCompoundProperty.h:53
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS
Definition: ArchiveReader.h:47
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriterPtr
Alembic::Util::shared_ptr< CompoundPropertyWriter > CompoundPropertyWriterPtr
Definition: ForwardDeclarations.h:83
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSamplingPtr
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyWriterPtr
Alembic::Util::shared_ptr< ArrayPropertyWriter > ArrayPropertyWriterPtr
Definition: ForwardDeclarations.h:84
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
Alembic namespace ...
Definition: ArchiveInfo.h:46