HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros 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  template <class CPROP_PTR>
58  OCollectionsSchema( CPROP_PTR iParent,
59  const std::string &iName,
60  const Abc::Argument &iArg0 = Abc::Argument(),
61  const Abc::Argument &iArg1 = Abc::Argument(),
62  const Abc::Argument &iArg2 = Abc::Argument() )
63  : Abc::OSchema<CollectionsSchemaInfo>( iParent, iName,
64  iArg0, iArg1, iArg2 )
65  {
66  }
67 
68  template <class CPROP_PTR>
69  explicit OCollectionsSchema( CPROP_PTR iParent,
70  const Abc::Argument &iArg0 = Abc::Argument(),
71  const Abc::Argument &iArg1 = Abc::Argument(),
72  const Abc::Argument &iArg2 = Abc::Argument() )
73  : Abc::OSchema<CollectionsSchemaInfo>( iParent,
74  iArg0, iArg1, iArg2 )
75  {
76  }
77 
78  //! Copy constructor.
80  : Abc::OSchema<CollectionsSchemaInfo>()
81  {
82  *this = iCopy;
83  }
84 
85  //! Create a named collection, if the collection already exists
86  //! return it.
88  createCollection( const std::string &iName,
89  const Abc::Argument &iArg0 = Abc::Argument(),
90  const Abc::Argument &iArg1 = Abc::Argument(),
91  const Abc::Argument &iArg2 = Abc::Argument() );
92 
93  //! Returns the number of collections that we have
94  size_t getNumCollections() { return m_collections.size(); }
95 
96  //! Return a collection by index
97  Abc::OStringArrayProperty getCollection( size_t i );
98 
99  //! Return a collection by name
100  Abc::OStringArrayProperty getCollection( const std::string & iName );
101 
102  //! Returns whether this function set is valid.
103  bool valid() const
104  {
106  }
107 
108 protected:
109  std::vector< Abc::OStringArrayProperty > m_collections;
110 
111 };
112 
113 //! Object declaration
115 
116 typedef Util::shared_ptr< OCollections > OCollectionsPtr;
117 
118 } // End namespace ALEMBIC_VERSION_NS
119 
120 using namespace ALEMBIC_VERSION_NS;
121 
122 } // End namespace AbcCollection
123 } // End namespace Alembic
124 
125 #endif
126 
size_t getNumCollections()
Returns the number of collections that we have.
Definition: OCollections.h:94
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:79
OCollectionsSchema(CPROP_PTR iParent, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument())
Definition: OCollections.h:69
std::vector< Abc::OStringArrayProperty > m_collections
Definition: OCollections.h:109
OCollectionsSchema(CPROP_PTR iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument())
Definition: OCollections.h:58
Abc::OSchemaObject< OCollectionsSchema > OCollections
Object declaration.
Definition: OCollections.h:114
Util::shared_ptr< OCollections > OCollectionsPtr
Definition: OCollections.h:116
bool valid() const
Returns whether this function set is valid.
Definition: OCollections.h:103
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:104