HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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>
43 
44 namespace Alembic {
45 namespace AbcCollection {
46 namespace ALEMBIC_VERSION_NS {
47 
49  : public Abc::OSchema<CollectionsSchemaInfo>
50 {
51 public:
52 
54 
56 
57  //! This constructor creates a new collections writer.
58  //! The first argument is an CompoundPropertyWriterPtr to use as a parent.
59  //! The next is the name to give the schema which is usually the default
60  //! name given by OCollections (.collection) The remaining optional
61  //! arguments can be used to override the ErrorHandlerPolicy, to specify
62  //! MetaData, specify sparse sampling and to set TimeSampling.
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 
71  //! This constructor creates a new collections writer.
72  //! The first argument is an OCompundProperty to use as a parent, and from
73  //! which the ErrorHandlerPolicy is derived. The next is the name to give
74  //! the schema which is usually the default name given by OCollections
75  //! (.collection) The remaining optional arguments can be used to specify
76  //! MetaData, specify sparse sampling and to set TimeSampling.
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 
83  //! Copy constructor.
85  : Abc::OSchema<CollectionsSchemaInfo>()
86  {
87  *this = iCopy;
88  }
89 
90  //! Create a named collection, if the collection already exists
91  //! return it.
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 
98  //! Returns the number of collections that we have
99  size_t getNumCollections() { return m_collections.size(); }
100 
101  //! Return a collection by index
102  Abc::OStringArrayProperty getCollection( size_t i );
103 
104  //! Return a collection by name
105  Abc::OStringArrayProperty getCollection( const std::string & iName );
106 
107  //! Returns whether this function set is valid.
108  bool valid() const
109  {
111  }
112 
113 protected:
114  std::vector< Abc::OStringArrayProperty > m_collections;
115 
116 };
117 
118 //! Object declaration
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 
size_t getNumCollections()
Returns the number of collections that we have.
Definition: OCollections.h:99
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
png_uint_32 i
Definition: png.h:2877
OCollectionsSchema(const OCollectionsSchema &iCopy)
Copy constructor.
Definition: OCollections.h:84
std::vector< Abc::OStringArrayProperty > m_collections
Definition: OCollections.h:114
Abc::OSchemaObject< OCollectionsSchema > OCollections
Object declaration.
Definition: OCollections.h:119
Util::shared_ptr< OCollections > OCollectionsPtr
Definition: OCollections.h:121
bool valid() const
Returns whether this function set is valid.
Definition: OCollections.h:108
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
Alembic::Util::shared_ptr< CompoundPropertyWriter > CompoundPropertyWriterPtr