HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
IArrayProperty.h
Go to the documentation of this file.
1 //-*****************************************************************************
2 //
3 // Copyright (c) 2009-2012,
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 #ifndef _Alembic_Abc_IArrayProperty_h_
37 #define _Alembic_Abc_IArrayProperty_h_
38 
39 #include <Alembic/Util/Export.h>
40 #include <Alembic/Abc/Foundation.h>
41 #include <Alembic/Abc/Base.h>
42 #include <Alembic/Abc/Argument.h>
46 
47 namespace Alembic {
48 namespace Abc {
49 namespace ALEMBIC_VERSION_NS {
50 
51 //-*****************************************************************************
53  : public IBasePropertyT<AbcA::ArrayPropertyReaderPtr>
54 {
55 public:
56  //! By convention we always define this_type in Abc classes
57  //! Used by unspecified-bool-type conversion below
59 
60  //-*************************************************************************
61  // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
62  //-*************************************************************************
63 
64  //! The default constructor creates an empty IArrayProperty function set.
65  //! ...
67 
68  //! This templated, explicit function creates a new array property reader.
69  //! The first argument is any Abc (or AbcCoreAbstract) object
70  //! which can intrusively be converted to a CompoundPropertyReaderPtr
71  //! to use as a parent, from which the error handler policy for
72  //! inheritance is also derived. The remaining optional arguments
73  //! can be used to override the ErrorHandlerPolicy, to specify
74  //! protocol matching policy, and that's it.
75  template <class OBJECT_PTR>
76  IArrayProperty( OBJECT_PTR iParentObject,
77  const std::string &iName,
78 
79  const Argument &iArg0 = Argument(),
80  const Argument &iArg1 = Argument() );
81 
82  //! This attaches an IArrayProperty wrapper around an existing
83  //! ArrayPropertyReaderPtr, with an optional error handling policy.
85  //! The pointer
86  //! ...
88 
89  //! The flag indicating that wrapping is intended.
90  //! Even though it's nonambiguous here, we use it anyway
91  //! for readability
92  WrapExistingFlag iWrapFlag,
93 
94  //! Optional error handling policy
95  //! ...
98  iWrapFlag,
99  iPolicy ) {}
100 
101  //! Default copy constructor used
102  //! Default assignment operator used.
103 
104  //! Destructor
105  //! ...
106  ~IArrayProperty();
107 
108  //-*************************************************************************
109  // ARRAY PROPERTY READER FUNCTIONALITY
110  //-*************************************************************************
111 
112  //! Return the number of samples contained in the property.
113  //! This can be any number, including zero.
114  //! This returns the number of samples that were written, independently
115  //! of whether or not they were constant.
116  size_t getNumSamples() const;
117 
118  //! Ask if we're constant - no change in value amongst samples,
119  //! regardless of the time sampling.
120  bool isConstant() const;
121 
122  //! Ask if we are like a scalar - we have 1 and only 1 DataType per sample.
123  bool isScalarLike() const;
124 
125  //! Time information.
126  AbcA::TimeSamplingPtr getTimeSampling() const;
127 
128  //! Get a sample into the address of a datum.
129  //! ...
130  void get( AbcA::ArraySamplePtr& oSample,
131  const ISampleSelector &iSS = ISampleSelector() ) const;
132 
133  //! Get a sample into the address of a datum as a particular POD type.
134  void getAs( void *oSample, AbcA::PlainOldDataType iPod,
135  const ISampleSelector &iSS = ISampleSelector() );
136 
137  //! Get a sample into the address of a datum as the POD type of this
138  //! array property.
139  void getAs( void *oSample,
140  const ISampleSelector &iSS = ISampleSelector() );
141 
142  //! Get a key from an address of a datum.
143  //! ...
144  bool getKey( AbcA::ArraySampleKey& oKey,
145  const ISampleSelector &iSS = ISampleSelector() ) const;
146 
147  //! Get the dimensions of the datum.
148  void getDimensions( Util::Dimensions & oDim,
149  const ISampleSelector &iSS = ISampleSelector() ) const;
150 
151  //! Return the parent compound property, handily wrapped in a
152  //! ICompoundProperty wrapper.
153  ICompoundProperty getParent() const;
154 
155 private:
156  void init( AbcA::CompoundPropertyReaderPtr iParentObject,
157  const std::string &iName,
158 
159  ErrorHandler::Policy iParentPolicy,
160 
161  const Argument &iArg0,
162  const Argument &iArg1 );
163 };
164 
165 //-*****************************************************************************
166 // TEMPLATE AND INLINE FUNCTIONS
167 //-*****************************************************************************
168 
169 //-*****************************************************************************
170 template <class CPROP_PTR>
171 inline IArrayProperty::IArrayProperty( CPROP_PTR iParentProp,
172  const std::string &iName,
173  const Argument &iArg0,
174  const Argument &iArg1 )
175 {
176  init( GetCompoundPropertyReaderPtr( iParentProp ),
177  iName,
178 
179  GetErrorHandlerPolicy( iParentProp ),
180  iArg0, iArg1 );
181 }
182 
183 } // End namespace ALEMBIC_VERSION_NS
184 
185 using namespace ALEMBIC_VERSION_NS;
186 
187 } // End namespace Abc
188 } // End namespace Alembic
189 
190 #endif
ErrorHandler::Policy GetErrorHandlerPolicy(SOMETHING iSomething, const Argument &iArg0, const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
Definition: Argument.h:219
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
Alembic::Util::shared_ptr< ArrayPropertyReader > ArrayPropertyReaderPtr
Alembic::Util::shared_ptr< ArraySample > ArraySamplePtr
Definition: ArraySample.h:138
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
Alembic::Util::shared_ptr< CompoundPropertyReader > CompoundPropertyReaderPtr
AbcA::CompoundPropertyReaderPtr GetCompoundPropertyReaderPtr(AbcA::CompoundPropertyReaderPtr iPtr)
Definition: Foundation.h:171
IArrayProperty(AbcA::ArrayPropertyReaderPtr iPtr, WrapExistingFlag iWrapFlag, ErrorHandler::Policy iPolicy=ErrorHandler::kThrowPolicy)
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:104