Alembic Version 1.1
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>
41#include <Alembic/Abc/Base.h>
46
47namespace Alembic {
48namespace Abc {
49namespace ALEMBIC_VERSION_NS {
50
51//-*****************************************************************************
53 : public IBasePropertyT<AbcA::ArrayPropertyReaderPtr>
54{
55public:
59
60 //-*************************************************************************
61 // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
62 //-*************************************************************************
63
67
73 const std::string &iName,
74
75 const Argument &iArg0 = Argument(),
76 const Argument &iArg1 = Argument() );
77
84
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
101
105
106 //-*************************************************************************
107 // ARRAY PROPERTY READER FUNCTIONALITY
108 //-*************************************************************************
109
114 size_t getNumSamples() const;
115
118 bool isConstant() const;
119
121 bool isScalarLike() const;
122
125
128 void get( AbcA::ArraySamplePtr& oSample,
129 const ISampleSelector &iSS = ISampleSelector() ) const;
130
132 void getAs( void *oSample, AbcA::PlainOldDataType iPod,
133 const ISampleSelector &iSS = ISampleSelector() );
134
137 void getAs( void *oSample,
138 const ISampleSelector &iSS = ISampleSelector() );
139
143 const ISampleSelector &iSS = ISampleSelector() ) const;
144
147 const ISampleSelector &iSS = ISampleSelector() ) const;
148
152
153private:
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
165using namespace ALEMBIC_VERSION_NS;
166
167} // End namespace Abc
168} // End namespace Alembic
169
170#endif
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
void getAs(void *oSample, AbcA::PlainOldDataType iPod, const ISampleSelector &iSS=ISampleSelector())
Get a sample into the address of a datum as a particular POD type.
void get(AbcA::ArraySamplePtr &oSample, const ISampleSelector &iSS=ISampleSelector()) const
bool isScalarLike() const
Ask if we are like a scalar - we have 1 and only 1 DataType per sample.
void getAs(void *oSample, const ISampleSelector &iSS=ISampleSelector())
IArrayProperty(AbcA::ArrayPropertyReaderPtr iPtr, WrapExistingFlag iWrapFlag, const Argument &iArg0=Argument())
bool getKey(AbcA::ArraySampleKey &oKey, const ISampleSelector &iSS=ISampleSelector()) const
AbcA::TimeSamplingPtr getTimeSampling() const
Time information.
IArrayProperty(const ICompoundProperty &iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
IArrayProperty(AbcA::ArrayPropertyReaderPtr iPtr, const Argument &iArg0=Argument())
void getDimensions(Util::Dimensions &oDim, const ISampleSelector &iSS=ISampleSelector()) const
Get the dimensions of the datum.
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
Alembic namespace ...
Definition: ArchiveInfo.h:46