Alembic: AbcCollection/ICollections.h Source File

Alembic 1.8.11

Loading...
Searching...
No Matches
ICollections.h
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
44namespace Alembic {
45namespace AbcCollection {
46namespace ALEMBIC_VERSION_NS {
47
48 class ALEMBIC_EXPORT ICollectionsSchema
49 : public Abc::ISchema<CollectionsSchemaInfo>
50{
51public:
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 size_t getNumCollections() { return m_collections.size(); }
87
89 Abc::IStringArrayProperty getCollection( size_t i );
90
92 Abc::IStringArrayProperty getCollection( const std::string & iName );
93
95 std::string getCollectionName( size_t i );
96
98 bool valid() const
99 {
100 return ( Abc::ISchema<CollectionsSchemaInfo>::valid() );
101 }
102
103protected:
104 void init( const Abc::Argument &iArg0,
105 const Abc::Argument &iArg1 );
106
107 std::vector< Abc::IStringArrayProperty > m_collections;
108
109};
110
112typedef Abc::ISchemaObject<ICollectionsSchema> ICollections;
113
114typedef Util::shared_ptr< ICollections > ICollectionsPtr;
115
116} // End namespace ALEMBIC_VERSION_NS
117
118using namespace ALEMBIC_VERSION_NS;
119
120} // End namespace AbcCollection
121} // End namespace Alembic
122
123#endif
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::ISchema
Definition ISchema.h:58
Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< CollectionsSchemaInfo >::ISchema
ISchema()
Definition ISchema.h:112
Alembic::Abc::ALEMBIC_VERSION_NS::ISchemaObject
Definition ISchemaObject.h:56
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::valid
bool valid() const
Returns whether this function set is valid.
Definition ICollections.h:98
Alembic::AbcCollection::ALEMBIC_VERSION_NS::ICollectionsSchema::getNumCollections
size_t getNumCollections()
Returns the number of collections that we have.
Definition ICollections.h:86
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
Alembic namespace ...
Definition ArchiveInfo.cpp:39