Alembic Version 1.1

Loading...
Searching...
No Matches
OCollections.h
Go to the documentation of this file.
1//-*****************************************************************************
2//
3// Copyright (c) 2009-2015,
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_AbcCollection_OCollections_h
38#define Alembic_AbcCollection_OCollections_h
39
40#include <Alembic/Abc/All.h>
41#include <Alembic/Util/Export.h>
42#include <Alembic/AbcCollection/SchemaInfoDeclarations.h>
43
44 namespace Alembic {
45 namespace AbcCollection {
46 namespace ALEMBIC_VERSION_NS {
47
48 class ALEMBIC_EXPORT OCollectionsSchema
49 : public Abc::OSchema<CollectionsSchemaInfo>
50{
51 public:
52
53 typedef OCollectionsSchema this_type;
54
55 OCollectionsSchema() {}
56
63 OCollectionsSchema(
64 Alembic::AbcCoreAbstract::CompoundPropertyWriterPtr iParent,
65 const std::string &iName,
66 const Abc::Argument &iArg0 = Abc::Argument(),
67 const Abc::Argument &iArg1 = Abc::Argument(),
68 const Abc::Argument &iArg2 = Abc::Argument(),
69 const Abc::Argument &iArg3 = Abc::Argument() );
70
77 OCollectionsSchema( Abc::OCompoundProperty iParent,
78 const std::string &iName,
79 const Abc::Argument &iArg0 = Abc::Argument(),
80 const Abc::Argument &iArg1 = Abc::Argument(),
81 const Abc::Argument &iArg2 = Abc::Argument() );
82
84 OCollectionsSchema( const OCollectionsSchema& iCopy )
85 : Abc::OSchema<CollectionsSchemaInfo>()
86 {
87 *this = iCopy;
88 }
89
92 Abc::OStringArrayProperty
93 createCollection( const std::string &iName,
94 const Abc::Argument &iArg0 = Abc::Argument(),
95 const Abc::Argument &iArg1 = Abc::Argument(),
96 const Abc::Argument &iArg2 = Abc::Argument() );
97
99 size_t getNumCollections() { return m_collections.size(); }
100
102 Abc::OStringArrayProperty getCollection( size_t i );
103
105 Abc::OStringArrayProperty getCollection( const std::string & iName );
106
108 bool valid() const
109 {
110 return ( Abc::OSchema<CollectionsSchemaInfo>::valid() );
111 }
112
113 protected:
114 std::vector< Abc::OStringArrayProperty > m_collections;
115
116};
117
119 typedef Abc::OSchemaObject<OCollectionsSchema> OCollections;
120
121 typedef Util::shared_ptr< OCollections > OCollectionsPtr;
122
123} // End namespace ALEMBIC_VERSION_NS
124
125 using namespace ALEMBIC_VERSION_NS;
126
127} // End namespace AbcCollection
128} // End namespace Alembic
129
130#endif
131
SchemaInfoDeclarations.h
All.h
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition Export.h:51
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::OCollectionsSchema
OCollectionsSchema(Abc::OCompoundProperty iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument())
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::OCollectionsSchema
OCollectionsSchema(Alembic::AbcCoreAbstract::CompoundPropertyWriterPtr iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument(), const Abc::Argument &iArg3=Abc::Argument())
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::createCollection
Abc::OStringArrayProperty createCollection(const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument())
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::valid
bool valid() const
Returns whether this function set is valid.
Definition OCollections.h:108
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::OCollectionsSchema
OCollectionsSchema(const OCollectionsSchema &iCopy)
Copy constructor.
Definition OCollections.h:84
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::getCollection
Abc::OStringArrayProperty getCollection(size_t i)
Return a collection by index.
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::getCollection
Abc::OStringArrayProperty getCollection(const std::string &iName)
Return a collection by name.
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::m_collections
std::vector< Abc::OStringArrayProperty > m_collections
Definition OCollections.h:114
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::getNumCollections
size_t getNumCollections()
Returns the number of collections that we have.
Definition OCollections.h:99
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::this_type
OCollectionsSchema this_type
Definition OCollections.h:53
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::OCollectionsSchema
OCollectionsSchema()
Definition OCollections.h:55
Alembic::Abc::ALEMBIC_VERSION_NS::Argument
Definition Argument.h:120
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty
Definition OCompoundProperty.h:53
Alembic::Abc::ALEMBIC_VERSION_NS::OSchemaObject
Definition OSchemaObject.h:54
Alembic::Abc::ALEMBIC_VERSION_NS::OSchema
Definition OSchema.h:119
Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< CollectionsSchemaInfo >::OSchema
OSchema()
Definition OSchema.h:191
Alembic::AbcCollection::ALEMBIC_VERSION_NS
Definition ICollections.h:46
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsPtr
Util::shared_ptr< OCollections > OCollectionsPtr
Definition OCollections.h:121
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollections
Abc::OSchemaObject< OCollectionsSchema > OCollections
Object declaration.
Definition OCollections.h:119
Alembic::AbcCollection
Definition ICollections.h:45
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriterPtr
Alembic::Util::shared_ptr< CompoundPropertyWriter > CompoundPropertyWriterPtr
Definition ForwardDeclarations.h:83
Alembic::Abc::ALEMBIC_VERSION_NS::OStringArrayProperty
OTypedArrayProperty< StringTPTraits > OStringArrayProperty
Definition OTypedArrayProperty.h:255
Alembic::Abc
Definition ArchiveInfo.h:47
Alembic
Alembic namespace ...
Definition ArchiveInfo.h:46