Loading...
Searching...
No Matches
OCompoundProperty.h
Go to the documentation of this file.
//-*****************************************************************************
//
// Copyright (c) 2009-2013,
// 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_OCompoundProperty_h
#define Alembic_Abc_OCompoundProperty_h
#include <Alembic/Util/Export.h>
#include <Alembic/Abc/Foundation.h>
#include <Alembic/Abc/Argument.h>
#include <Alembic/Abc/Base.h>
#include <Alembic/Abc/OBaseProperty.h>
namespace Alembic {
namespace Abc {
namespace ALEMBIC_VERSION_NS {
//-*****************************************************************************
class ALEMBIC_EXPORT OCompoundProperty
: public OBasePropertyT<AbcA::CompoundPropertyWriterPtr>
{
public:
typedef OCompoundProperty this_type;
//-*************************************************************************
// CONSTRUCTION, DESTRUCTION, ASSIGNMENT
//-*************************************************************************
OCompoundProperty() : OBasePropertyT<AbcA::CompoundPropertyWriterPtr>() {}
OCompoundProperty( AbcA::CompoundPropertyWriterPtr iParent,
const std::string &iName,
const Argument &iArg0 = Argument(),
const Argument &iArg1 = Argument() );
OCompoundProperty( OCompoundProperty iParent,
const std::string &iName,
const Argument &iArg0 = Argument(),
const Argument &iArg1 = Argument() );
OCompoundProperty(
AbcA::CompoundPropertyWriterPtr iProp,
const Argument &iArg0 = Argument(),
const Argument &iArg1 = Argument() );
// Deprecated in favor of the constructor above
OCompoundProperty(
AbcA::CompoundPropertyWriterPtr iProp,
WrapExistingFlag iWrapFlag = kWrapExisting,
const Argument &iArg0 = Argument(),
const Argument &iArg1 = Argument() );
OCompoundProperty(
OObject iObject,
const Argument &iArg0 = Argument(),
const Argument &iArg1 = Argument() );
// Deprecated in favor of the constructor above
OCompoundProperty(
OObject iObject,
TopFlag iTopFlag = kTop,
const Argument &iArg0 = Argument(),
const Argument &iArg1 = Argument() );
~OCompoundProperty();
//-*************************************************************************
// COMPOUND PROPERTY WRITER FUNCTIONALITY
//-*************************************************************************
size_t getNumProperties() const;
const AbcA::PropertyHeader & getPropertyHeader( size_t i ) const;
const AbcA::PropertyHeader * getPropertyHeader( const std::string &iName ) const;
OBaseProperty getProperty( size_t i ) const;
OBaseProperty getProperty( const std::string &iName ) const;
OCompoundProperty getParent() const;
private:
void init( OObject iObject, const Argument &iArg0, const Argument &iArg1 );
void init( AbcA::CompoundPropertyWriterPtr iParentObject,
const std::string &iName,
const Argument &iArg0,
const Argument &iArg1,
const Argument &iArg2 = Argument() );
};
//-*****************************************************************************
inline AbcA::CompoundPropertyWriterPtr
GetCompoundPropertyWriterPtr
( OCompoundProperty iPrp ) { return iPrp.getPtr(); }
} // 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
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::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >::OBasePropertyT
OBasePropertyT()
Definition OBaseProperty.h:74
Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT::getPtr
PROP_PTR getPtr() const
Definition OBaseProperty.h:162
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty
Definition OCompoundProperty.h:53
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::OCompoundProperty
OCompoundProperty(AbcA::CompoundPropertyWriterPtr iProp, WrapExistingFlag iWrapFlag=kWrapExisting, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::OCompoundProperty
OCompoundProperty(OCompoundProperty iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::getPropertyHeader
const AbcA::PropertyHeader * getPropertyHeader(const std::string &iName) const
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::OCompoundProperty
OCompoundProperty(OObject iObject, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::getPropertyHeader
const AbcA::PropertyHeader & getPropertyHeader(size_t i) const
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::getParent
OCompoundProperty getParent() const
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::OCompoundProperty
OCompoundProperty(AbcA::CompoundPropertyWriterPtr iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::OCompoundProperty
OCompoundProperty()
Definition OCompoundProperty.h:65
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::getProperty
OBaseProperty getProperty(const std::string &iName) const
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::getProperty
OBaseProperty getProperty(size_t i) const
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::getNumProperties
size_t getNumProperties() const
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::OCompoundProperty
OCompoundProperty(AbcA::CompoundPropertyWriterPtr iProp, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::OCompoundProperty
OCompoundProperty(OObject iObject, TopFlag iTopFlag=kTop, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::this_type
OCompoundProperty this_type
Definition OCompoundProperty.h:57
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::~OCompoundProperty
~OCompoundProperty()
Alembic::Abc::ALEMBIC_VERSION_NS::OObject
Definition OObject.h:54
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriterPtr
Alembic::Util::shared_ptr< CompoundPropertyWriter > CompoundPropertyWriterPtr
Definition ForwardDeclarations.h:83
Alembic::Abc::ALEMBIC_VERSION_NS
Definition ArchiveInfo.h:48
Alembic::Abc::ALEMBIC_VERSION_NS::GetCompoundPropertyWriterPtr
AbcA::CompoundPropertyWriterPtr GetCompoundPropertyWriterPtr(AbcA::CompoundPropertyWriterPtr iPtr)
Definition Foundation.h:174
Alembic::Abc::ALEMBIC_VERSION_NS::WrapExistingFlag
WrapExistingFlag
Definition Foundation.h:94
Alembic::Abc::ALEMBIC_VERSION_NS::kWrapExisting
@ kWrapExisting
Definition Foundation.h:95
Alembic::Abc::ALEMBIC_VERSION_NS::OBaseProperty
OBasePropertyT< AbcA::BasePropertyWriterPtr > OBaseProperty
Definition OBaseProperty.h:184
Alembic::Abc::ALEMBIC_VERSION_NS::TopFlag
TopFlag
Definition Foundation.h:104
Alembic::Abc::ALEMBIC_VERSION_NS::kTop
@ kTop
Definition Foundation.h:105
Alembic::Abc
Definition ArchiveInfo.h:47
Alembic
Alembic namespace ...
Definition ArchiveInfo.h:46