Alembic Version 1.1

OCompoundProperty.h
Go to the documentation of this file.
1//-*****************************************************************************
2//
3// Copyright (c) 2009-2013,
4// Sony Pictures Imageworks, Inc. and
5// Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
6//
7// All rights reserved.
8//
9// Redistribution and use in source and binary forms, with or without
10// modification, are permitted provided that the following conditions are
11// met:
12// * Redistributions of source code must retain the above copyright
13// notice, this list of conditions and the following disclaimer.
14// * Redistributions in binary form must reproduce the above
15// copyright notice, this list of conditions and the following disclaimer
16// in the documentation and/or other materials provided with the
17// distribution.
18// * Neither the name of Sony Pictures Imageworks, nor
19// Industrial Light & Magic nor the names of their contributors may be used
20// to endorse or promote products derived from this software without specific
21// prior written permission.
22//
23// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34//
35//-*****************************************************************************
36
37#ifndef Alembic_Abc_OCompoundProperty_h
38#define Alembic_Abc_OCompoundProperty_h
39
40#include <Alembic/Util/Export.h>
41#include <Alembic/Abc/Foundation.h>
42#include <Alembic/Abc/Argument.h>
43#include <Alembic/Abc/Base.h>
44#include <Alembic/Abc/OBaseProperty.h>
45
46 namespace Alembic {
47 namespace Abc {
48 namespace ALEMBIC_VERSION_NS {
49
50//-*****************************************************************************
51 class ALEMBIC_EXPORT OCompoundProperty
52 : public OBasePropertyT<AbcA::CompoundPropertyWriterPtr>
53{
54 public:
57 typedef OCompoundProperty this_type;
58
59 //-*************************************************************************
60 // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
61 //-*************************************************************************
62
65 OCompoundProperty() : OBasePropertyT<AbcA::CompoundPropertyWriterPtr>() {}
66
67
71 OCompoundProperty( AbcA::CompoundPropertyWriterPtr iParent,
72 const std::string &iName,
73 const Argument &iArg0 = Argument(),
74 const Argument &iArg1 = Argument() );
75
79 OCompoundProperty( OCompoundProperty iParent,
80 const std::string &iName,
81 const Argument &iArg0 = Argument(),
82 const Argument &iArg1 = Argument() );
83
86 OCompoundProperty(
87 AbcA::CompoundPropertyWriterPtr iProp,
88 const Argument &iArg0 = Argument(),
89 const Argument &iArg1 = Argument() );
90
91 // Deprecated in favor of the constructor above
92 OCompoundProperty(
93 AbcA::CompoundPropertyWriterPtr iProp,
94 WrapExistingFlag iWrapFlag = kWrapExisting,
95 const Argument &iArg0 = Argument(),
96 const Argument &iArg1 = Argument() );
97
100 OCompoundProperty(
101 OObject iObject,
102 const Argument &iArg0 = Argument(),
103 const Argument &iArg1 = Argument() );
104
105 // Deprecated in favor of the constructor above
106 OCompoundProperty(
107 OObject iObject,
108 TopFlag iTopFlag = kTop,
109 const Argument &iArg0 = Argument(),
110 const Argument &iArg1 = Argument() );
111
114
117 ~OCompoundProperty();
118
119 //-*************************************************************************
120 // COMPOUND PROPERTY WRITER FUNCTIONALITY
121 //-*************************************************************************
122
125 size_t getNumProperties() const;
126
130 const AbcA::PropertyHeader & getPropertyHeader( size_t i ) const;
131
135 const AbcA::PropertyHeader * getPropertyHeader( const std::string &iName ) const;
136
141 OBaseProperty getProperty( size_t i ) const;
142
147 OBaseProperty getProperty( const std::string &iName ) const;
148
151 OCompoundProperty getParent() const;
152
153 private:
154
155 void init( OObject iObject, const Argument &iArg0, const Argument &iArg1 );
156
157 void init( AbcA::CompoundPropertyWriterPtr iParentObject,
158 const std::string &iName,
159 const Argument &iArg0,
160 const Argument &iArg1,
161 const Argument &iArg2 = Argument() );
162};
163
164//-*****************************************************************************
165 inline AbcA::CompoundPropertyWriterPtr
166 GetCompoundPropertyWriterPtr
167( OCompoundProperty iPrp ) { return iPrp.getPtr(); }
168
169} // End namespace ALEMBIC_VERSION_NS
170
171 using namespace ALEMBIC_VERSION_NS;
172
173} // End namespace Abc
174} // End namespace Alembic
175
176#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::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader
Definition: PropertyHeader.h:79
Alembic::Abc::ALEMBIC_VERSION_NS::Argument
Definition: Argument.h:120
Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT
Definition: OBaseProperty.h:58
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
Definition: ArchiveReader.h:47
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::TopFlag
TopFlag
Definition: Foundation.h:104
Alembic::Abc::ALEMBIC_VERSION_NS::kTop
@ kTop
Definition: Foundation.h:105
Alembic
Alembic namespace ...
Definition: ArchiveInfo.h:46