HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OCompoundProperty.h
Go to the documentation of this file.
1 //-*****************************************************************************
2 //
3 // Copyright (c) 2009-2013,
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_Abc_OCompoundProperty_h
38 #define Alembic_Abc_OCompoundProperty_h
39 
40 #include <Alembic/Util/Export.h>
41 #include <Alembic/Abc/Foundation.h>
42 #include <Alembic/Abc/Argument.h>
43 #include <Alembic/Abc/Base.h>
45 
46 namespace Alembic {
47 namespace Abc {
48 namespace ALEMBIC_VERSION_NS {
49 
50 //-*****************************************************************************
52  : public OBasePropertyT<AbcA::CompoundPropertyWriterPtr>
53 {
54 public:
55  //! By convention we always define this_type in Abc classes
56  //! Used by unspecified-bool-type conversion below
58 
59  //-*************************************************************************
60  // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
61  //-*************************************************************************
62 
63  //! The default constructor creates an empty OCompoundProperty function set.
64  //! ...
66 
67 
68  //! Create a new OCompoundProperty named iName as a child of iParent.
69  //! The remaining optional arguments can be used to override the
70  //! ErrorHandlerPolicy, or to specify MetaData.
72  const std::string &iName,
73  const Argument &iArg0 = Argument(),
74  const Argument &iArg1 = Argument() );
75 
76  //! Create a new OCompoundProperty named iName as a child of iParent.
77  //! The remaining optional arguments can be used to override the
78  //! ErrorHandlerPolicy, or to specify MetaData.
80  const std::string &iName,
81  const Argument &iArg0 = Argument(),
82  const Argument &iArg1 = Argument() );
83 
84  //! This attaches an OCompoundProperty wrapper around an existing
85  //! CompoundPropertyWriterPtr, with an optional error handling policy.
88  const Argument &iArg0 = Argument(),
89  const Argument &iArg1 = Argument() );
90 
91  // Deprecated in favor of the constructor above
94  WrapExistingFlag iWrapFlag = kWrapExisting,
95  const Argument &iArg0 = Argument(),
96  const Argument &iArg1 = Argument() );
97 
98  //! This attaches an OCompoundProperty wrapper around the top
99  //! properties of an OObject.
101  OObject iObject,
102  const Argument &iArg0 = Argument(),
103  const Argument &iArg1 = Argument() );
104 
105  // Deprecated in favor of the constructor above
107  OObject iObject,
108  TopFlag iTopFlag = kTop,
109  const Argument &iArg0 = Argument(),
110  const Argument &iArg1 = Argument() );
111 
112  //! Default copy constructor used
113  //! Default assignment operator used.
114 
115  //! Destructor
116  //! ...
118 
119  //-*************************************************************************
120  // COMPOUND PROPERTY WRITER FUNCTIONALITY
121  //-*************************************************************************
122 
123  //! Returns the number of properties that have been created thus far.
124  //! May change as more are created.
125  size_t getNumProperties() const;
126 
127  //! Return the header of a property that has already been added.
128  //! Property is selected by index.
129  //! This will throw an exception on out-of-range access.
130  const AbcA::PropertyHeader & getPropertyHeader( size_t i ) const;
131 
132  //! Return the header of a property that has already been added.
133  //! Property is selected by name.
134  //! This will return NULL if no property with the given name is found.
135  const AbcA::PropertyHeader * getPropertyHeader( const std::string &iName ) const;
136 
137  //! Return a wrapped base property version of an ALREADY ADDED property.
138  //! Will return an empty pointer if the writer for this property
139  //! no longer exists or was never added.
140  //! This would primarily be used for introspection.
141  OBaseProperty getProperty( size_t i ) const;
142 
143  //! Return a wrapped base property version of an ALREADY ADDED property.
144  //! Will return an empty pointer if the writer for this property
145  //! no longer exists or was never added.
146  //! This would primarily be used for introspection.
147  OBaseProperty getProperty( const std::string &iName ) const;
148 
149  //! Return the parent compound property, handily wrapped in a
150  //! OCompoundProperty wrapper.
151  OCompoundProperty getParent() const;
152 
153 private:
154 
155  void init( OObject iObject, const Argument &iArg0, const Argument &iArg1 );
156 
157  void init( AbcA::CompoundPropertyWriterPtr iParentObject,
158  const std::string &iName,
159  const Argument &iArg0,
160  const Argument &iArg1,
161  const Argument &iArg2 = Argument() );
162 };
163 
164 //-*****************************************************************************
167 ( OCompoundProperty iPrp ) { return iPrp.getPtr(); }
168 
169 } // End namespace ALEMBIC_VERSION_NS
170 
171 using namespace ALEMBIC_VERSION_NS;
172 
173 } // End namespace Abc
174 } // End namespace Alembic
175 
176 #endif
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
png_uint_32 i
Definition: png.h:2877
AbcA::CompoundPropertyWriterPtr GetCompoundPropertyWriterPtr(AbcA::CompoundPropertyWriterPtr iPtr)
Definition: Foundation.h:174
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
Alembic::Util::shared_ptr< CompoundPropertyWriter > CompoundPropertyWriterPtr