HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CompoundPropertyWriter.h
Go to the documentation of this file.
1 //-*****************************************************************************
2 //
3 // Copyright (c) 2009-2011,
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_AbcCoreAbstract_CompoundPropertyWriter_h_
38 #define _Alembic_AbcCoreAbstract_CompoundPropertyWriter_h_
39 
40 #include <Alembic/Util/Export.h>
43 
44 namespace Alembic {
45 namespace AbcCoreAbstract {
46 namespace ALEMBIC_VERSION_NS {
47 
48 //-*****************************************************************************
49 //! A CompoundProperty is a group of other properties, possibly Simple
50 //! or possibly Compound. Every object has at one of these.
52  : public BasePropertyWriter
53 {
54 public:
55  //! Virtual destructor
56  //! ...
57  virtual ~CompoundPropertyWriter();
58 
59  //-*************************************************************************
60  // NEW FUNCTIONS
61  //-*************************************************************************
62 
63  //! Returns the number of properties that have been created thus far.
64  //! May change as more are created.
65  virtual size_t getNumProperties() = 0;
66 
67  //! Return the header of a property that has already been added.
68  //! Property is selected by index.
69  //! This will throw an exception on out-of-range access.
70  virtual const PropertyHeader & getPropertyHeader( size_t i ) = 0;
71 
72  //! Return the header of a property that has already been added,
73  //! found by name. A typical use of this would be for an application
74  //! that wants to incrementally add properties, and wishes to query
75  //! whether a property of a given name has already been added, before
76  //! attempting to add a new one.
77  //! This will return NULL if no property of the given name has
78  //! been added.
79  virtual const PropertyHeader *
80  getPropertyHeader( const std::string &iName ) = 0;
81 
82  //! It is an error to request for a property by index out of range.
83  //! This returns a property that has ALREADY BEEN ADDED.
84  //! This will throw an exception on out-of-range access.
85  //! There is a possibility it could return a NULL pointer, if the
86  //! added property has been closed (deleted).
87  //! This is just a convenience function which calls getPropertyHeader
88  //! and then getProperty.
89  BasePropertyWriterPtr getProperty( size_t i );
90 
91  //! Returns an ALREADY ADDED PROPERTY by name. If it can't find
92  //! one by name, it returns an empty pointer. This can also happen
93  //! if the property was added, but has been closed (deleted).
94  virtual BasePropertyWriterPtr getProperty( const std::string & iName ) = 0;
95 
96  //! Create and return the requested scalar property.
97  //! If a property already exists with the same name, throws
98  //! an exception. An exception will also be thrown if the DataType,
99  //! or time sampling index is illegal.
101  createScalarProperty( const std::string & iName,
102  const MetaData & iMetaData,
103  const DataType & iDataType,
104  uint32_t iTimeSamplingIndex ) = 0;
105 
106  //! Create and return the requested array property.
107  //! If a property already exists with the same name, throws.
108  //! an exception. An exception will also be thrown if the DataType,
109  //! or time sampling index is illegal.
110  virtual ArrayPropertyWriterPtr
111  createArrayProperty( const std::string & iName,
112  const MetaData & iMetaData,
113  const DataType & iDataType,
114  uint32_t iTimeSamplingIndex ) = 0;
115 
116  //! Create and return the requested compound property.
117  //! If a property already exists with the same name, throws
118  //! an exception.
120  createCompoundProperty( const std::string & iName,
121  const MetaData & iMetaData ) = 0;
122 
123 };
124 
125 } // End namespace ALEMBIC_VERSION_NS
126 
127 using namespace ALEMBIC_VERSION_NS;
128 
129 } // End namespace AbcCoreAbstract
130 } // End namespace Alembic
131 
132 #endif
133 
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
png_uint_32 i
Definition: png.h:2877
Alembic::Util::shared_ptr< BasePropertyWriter > BasePropertyWriterPtr
Alembic::Util::shared_ptr< ArrayPropertyWriter > ArrayPropertyWriterPtr
Alembic::Util::shared_ptr< ScalarPropertyWriter > ScalarPropertyWriterPtr
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:104
Alembic::Util::shared_ptr< CompoundPropertyWriter > CompoundPropertyWriterPtr