HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups 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 constructor creates a new array property reader.
69  //! The first argument is the parent ICompundProperty, from which the error
70  //! handler policy for inheritance is also derived. The remaining optional
71  //! arguments can be used to override the ErrorHandlerPolicy, and that's it.
72  IArrayProperty( const ICompoundProperty & iParent,
73  const std::string &iName,
74 
75  const Argument &iArg0 = Argument(),
76  const Argument &iArg1 = Argument() );
77 
78  //! This attaches an IArrayProperty wrapper around an existing
79  //! ArrayPropertyReaderPtr, with an optional error handling policy.
81  //! The pointer
82  //! ...
84 
85  //! Optional error handling policy
86  //! ...
87  const Argument &iArg0 = Argument() )
89  GetErrorHandlerPolicy( iPtr, iArg0 ) ) {};
90 
91  // Deprecated in favor of the constructor above
94  WrapExistingFlag iWrapFlag,
95  const Argument &iArg0 = Argument() )
97  GetErrorHandlerPolicy( iPtr, iArg0 ) ) {};
98 
99  //! Default copy constructor used
100  //! Default assignment operator used.
101 
102  //! Destructor
103  //! ...
104  ~IArrayProperty();
105 
106  //-*************************************************************************
107  // ARRAY PROPERTY READER FUNCTIONALITY
108  //-*************************************************************************
109 
110  //! Return the number of samples contained in the property.
111  //! This can be any number, including zero.
112  //! This returns the number of samples that were written, independently
113  //! of whether or not they were constant.
114  size_t getNumSamples() const;
115 
116  //! Ask if we're constant - no change in value amongst samples,
117  //! regardless of the time sampling.
118  bool isConstant() const;
119 
120  //! Ask if we are like a scalar - we have 1 and only 1 DataType per sample.
121  bool isScalarLike() const;
122 
123  //! Time information.
124  AbcA::TimeSamplingPtr getTimeSampling() const;
125 
126  //! Get a sample into the address of a datum.
127  //! ...
128  void get( AbcA::ArraySamplePtr& oSample,
129  const ISampleSelector &iSS = ISampleSelector() ) const;
130 
131  //! Get a sample into the address of a datum as a particular POD type.
132  void getAs( void *oSample, AbcA::PlainOldDataType iPod,
133  const ISampleSelector &iSS = ISampleSelector() );
134 
135  //! Get a sample into the address of a datum as the POD type of this
136  //! array property.
137  void getAs( void *oSample,
138  const ISampleSelector &iSS = ISampleSelector() );
139 
140  //! Get a key from an address of a datum.
141  //! ...
142  bool getKey( AbcA::ArraySampleKey& oKey,
143  const ISampleSelector &iSS = ISampleSelector() ) const;
144 
145  //! Get the dimensions of the datum.
146  void getDimensions( Util::Dimensions & oDim,
147  const ISampleSelector &iSS = ISampleSelector() ) const;
148 
149  //! Return the parent compound property, handily wrapped in a
150  //! ICompoundProperty wrapper.
151  ICompoundProperty getParent() const;
152 
153 private:
154  void init( AbcA::CompoundPropertyReaderPtr iParentObject,
155  const std::string &iName,
156 
157  ErrorHandler::Policy iParentPolicy,
158 
159  const Argument &iArg0,
160  const Argument &iArg1 );
161 };
162 
163 } // End namespace ALEMBIC_VERSION_NS
164 
165 using namespace ALEMBIC_VERSION_NS;
166 
167 } // End namespace Abc
168 } // End namespace Alembic
169 
170 #endif
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
IArrayProperty(AbcA::ArrayPropertyReaderPtr iPtr, WrapExistingFlag iWrapFlag, const Argument &iArg0=Argument())
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
ErrorHandler::Policy GetErrorHandlerPolicy(SOMETHING iSomething, const Argument &iArg0, const Argument &iArg1=Argument(), const Argument &iArg2=Argument(), const Argument &iArg3=Argument())
Definition: Argument.h:242
IArrayProperty(AbcA::ArrayPropertyReaderPtr iPtr, const Argument &iArg0=Argument())
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105