Alembic Version 1.1

Loading...
Searching...
No Matches
ICollections.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_AbcCollections_ICollections_h
38#define Alembic_AbcCollections_ICollections_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 ICollectionsSchema
49 : public Abc::ISchema<CollectionsSchemaInfo>
50{
51 public:
52
53 typedef ICollectionsSchema this_type;
54
55 // default constructor creates an empty ICollectionSchema
56 ICollectionsSchema() {}
57
64 ICollectionsSchema( const ICompoundProperty &iParent,
65 const std::string &iName,
66 const Abc::Argument &iArg0 = Abc::Argument(),
67 const Abc::Argument &iArg1 = Abc::Argument())
68 : Abc::ISchema<CollectionsSchemaInfo>( iParent, iName, iArg0, iArg1 )
69 {
70 init( iArg0, iArg1 );
71 }
72
77 ICollectionsSchema( const ICompoundProperty &iProp,
78 const Abc::Argument &iArg0 = Abc::Argument(),
79 const Abc::Argument &iArg1 = Abc::Argument() )
80 : Abc::ISchema<CollectionsSchemaInfo>( iProp, iArg0, iArg1 )
81 {
82 init( iArg0, iArg1 );
83 }
84
86 ICollectionsSchema( const ICollectionsSchema& iCopy )
87 : Abc::ISchema<CollectionsSchemaInfo>()
88 {
89 *this = iCopy;
90 }
91
93 size_t getNumCollections() { return m_collections.size(); }
94
96 Abc::IStringArrayProperty getCollection( size_t i );
97
99 Abc::IStringArrayProperty getCollection( const std::string & iName );
100
102 std::string getCollectionName( size_t i );
103
105 bool valid() const
106 {
107 return ( Abc::ISchema<CollectionsSchemaInfo>::valid() );
108 }
109
110 protected:
111 void init( const Abc::Argument &iArg0,
112 const Abc::Argument &iArg1 );
113
114 std::vector< Abc::IStringArrayProperty > m_collections;
115
116};
117
119 typedef Abc::ISchemaObject<ICollectionsSchema> ICollections;
120
121 typedef Util::shared_ptr< ICollections > ICollectionsPtr;
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
SchemaInfoDeclarations.h
All.h
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition Export.h:51
Alembic::AbcCollection::ALEMBIC_VERSION_NS::ICollectionsSchema::ICollectionsSchema
ICollectionsSchema(const ICollectionsSchema &iCopy)
Copy constructor.
Definition ICollections.h:86
Alembic::AbcCollection::ALEMBIC_VERSION_NS::ICollectionsSchema::ICollectionsSchema
ICollectionsSchema(const ICompoundProperty &iProp, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition ICollections.h:77
Alembic::AbcCollection::ALEMBIC_VERSION_NS::ICollectionsSchema::m_collections
std::vector< Abc::IStringArrayProperty > m_collections
Definition ICollections.h:114
Alembic::AbcCollection::ALEMBIC_VERSION_NS::ICollectionsSchema::valid
bool valid() const
Returns whether this function set is valid.
Definition ICollections.h:105
Alembic::AbcCollection::ALEMBIC_VERSION_NS::ICollectionsSchema::init
void init(const Abc::Argument &iArg0, const Abc::Argument &iArg1)
Alembic::AbcCollection::ALEMBIC_VERSION_NS::ICollectionsSchema::getCollection
Abc::IStringArrayProperty getCollection(size_t i)
Return a collection by index.
Alembic::AbcCollection::ALEMBIC_VERSION_NS::ICollectionsSchema::getNumCollections
size_t getNumCollections()
Returns the number of collections that we have.
Definition ICollections.h:93
Alembic::AbcCollection::ALEMBIC_VERSION_NS::ICollectionsSchema::ICollectionsSchema
ICollectionsSchema()
Definition ICollections.h:56
Alembic::AbcCollection::ALEMBIC_VERSION_NS::ICollectionsSchema::getCollection
Abc::IStringArrayProperty getCollection(const std::string &iName)
Return a collection by name.
Alembic::AbcCollection::ALEMBIC_VERSION_NS::ICollectionsSchema::this_type
ICollectionsSchema this_type
Definition ICollections.h:53
Alembic::AbcCollection::ALEMBIC_VERSION_NS::ICollectionsSchema::ICollectionsSchema
ICollectionsSchema(const ICompoundProperty &iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition ICollections.h:64
Alembic::AbcCollection::ALEMBIC_VERSION_NS::ICollectionsSchema::getCollectionName
std::string getCollectionName(size_t i)
Returns the name of a collection at a given index.
Alembic::Abc::ALEMBIC_VERSION_NS::Argument
Definition Argument.h:120
Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty::ICompoundProperty
ICompoundProperty()
Definition ICompoundProperty.h:65
Alembic::Abc::ALEMBIC_VERSION_NS::ISchemaObject
Definition ISchemaObject.h:56
Alembic::Abc::ALEMBIC_VERSION_NS::ISchema
Definition ISchema.h:58
Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< CollectionsSchemaInfo >::ISchema
ISchema()
Definition ISchema.h:112
Alembic::AbcCollection::ALEMBIC_VERSION_NS
Definition ICollections.h:46
Alembic::AbcCollection::ALEMBIC_VERSION_NS::ICollections
Abc::ISchemaObject< ICollectionsSchema > ICollections
Object declaration.
Definition ICollections.h:119
Alembic::AbcCollection::ALEMBIC_VERSION_NS::ICollectionsPtr
Util::shared_ptr< ICollections > ICollectionsPtr
Definition ICollections.h:121
Alembic::AbcCollection
Definition ICollections.h:45
Alembic::Abc::ALEMBIC_VERSION_NS::IStringArrayProperty
ITypedArrayProperty< StringTPTraits > IStringArrayProperty
Definition ITypedArrayProperty.h:227
Alembic::Abc
Definition ArchiveInfo.h:47
Alembic
Alembic namespace ...
Definition ArchiveInfo.h:46