IScalarProperty.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_IScalarProperty_h
#define Alembic_Abc_IScalarProperty_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 IScalarProperty
: public IBasePropertyT<AbcA::ScalarPropertyReaderPtr>
{
public:
typedef IScalarProperty this_type;
//-*************************************************************************
// CONSTRUCTION, DESTRUCTION, ASSIGNMENT
//-*************************************************************************
IScalarProperty() : IBasePropertyT<AbcA::ScalarPropertyReaderPtr>() {}
IScalarProperty( const ICompoundProperty & iParent,
const std::string &iName,
const Argument &iArg0 = Argument() );
IScalarProperty(
AbcA::ScalarPropertyReaderPtr iPtr,
const Argument &iArg0 = Argument() )
: IBasePropertyT<AbcA::ScalarPropertyReaderPtr>( iPtr,
GetErrorHandlerPolicy( iPtr, iArg0 ) )
{}
// Deprecated in favor of the constructor above
IScalarProperty(
AbcA::ScalarPropertyReaderPtr iPtr,
WrapExistingFlag iWrapFlag,
const Argument &iArg0 = Argument() )
: IBasePropertyT<AbcA::ScalarPropertyReaderPtr>( iPtr,
GetErrorHandlerPolicy( iPtr, iArg0 ) )
{}
~IScalarProperty();
//-*************************************************************************
// SCALAR PROPERTY READER FUNCTIONALITY
//-*************************************************************************
size_t getNumSamples() const;
bool isConstant() const;
AbcA::TimeSamplingPtr getTimeSampling() const;
void get( void *oSample,
const ISampleSelector &iSS = ISampleSelector() ) const;
ICompoundProperty getParent() const;
private:
void init( AbcA::CompoundPropertyReaderPtr iParentObject,
const std::string &iName,
ErrorHandler::Policy iParentPolicy,
const Argument &iArg0 );
};
} // 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_VERSION_NS
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
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::IBasePropertyT
Definition: IBaseProperty.h:58
Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
Definition: ICompoundProperty.h:53
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector
Definition: ISampleSelector.h:49
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty
Definition: IScalarProperty.h:54
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::IScalarProperty
IScalarProperty(AbcA::ScalarPropertyReaderPtr iPtr, WrapExistingFlag iWrapFlag, const Argument &iArg0=Argument())
Definition: IScalarProperty.h:92
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::get
void get(void *oSample, const ISampleSelector &iSS=ISampleSelector()) const
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::IScalarProperty
IScalarProperty()
Definition: IScalarProperty.h:66
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::getNumSamples
size_t getNumSamples() const
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::getTimeSampling
AbcA::TimeSamplingPtr getTimeSampling() const
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::this_type
IScalarProperty this_type
Definition: IScalarProperty.h:58
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::isConstant
bool isConstant() const
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::IScalarProperty
IScalarProperty(const ICompoundProperty &iParent, const std::string &iName, const Argument &iArg0=Argument())
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::getParent
ICompoundProperty getParent() const
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::IScalarProperty
IScalarProperty(AbcA::ScalarPropertyReaderPtr iPtr, const Argument &iArg0=Argument())
Definition: IScalarProperty.h:79
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::~IScalarProperty
~IScalarProperty()
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS
Definition: ArchiveReader.h:47
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSamplingPtr
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ScalarPropertyReaderPtr
Alembic::Util::shared_ptr< ScalarPropertyReader > ScalarPropertyReaderPtr
Definition: ForwardDeclarations.h:94
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyReaderPtr
Alembic::Util::shared_ptr< CompoundPropertyReader > CompoundPropertyReaderPtr
Definition: ForwardDeclarations.h:92
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