Alembic: Abc/IArrayProperty.h Source File

Alembic 1.8.11

Loading...
Searching...
No Matches
IArrayProperty.h
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>
43#include <Alembic/Abc/ISampleSelector.h>
44#include <Alembic/Abc/IBaseProperty.h>
45#include <Alembic/Abc/ICompoundProperty.h>
46
47namespace Alembic {
48namespace Abc {
49namespace ALEMBIC_VERSION_NS {
50
51//-*****************************************************************************
52 class ALEMBIC_EXPORT IArrayProperty
53 : public IBasePropertyT<AbcA::ArrayPropertyReaderPtr>
54{
55public:
58 typedef IArrayProperty this_type;
59
60 //-*************************************************************************
61 // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
62 //-*************************************************************************
63
66 IArrayProperty() : IBasePropertyT<AbcA::ArrayPropertyReaderPtr>() {}
67
72 IArrayProperty( const ICompoundProperty & iParent,
73 const std::string &iName,
74
75 const Argument &iArg0 = Argument(),
76 const Argument &iArg1 = Argument() );
77
80 IArrayProperty(
83 AbcA::ArrayPropertyReaderPtr iPtr,
84
87 const Argument &iArg0 = Argument() )
88 : IBasePropertyT<AbcA::ArrayPropertyReaderPtr>( iPtr,
89 GetErrorHandlerPolicy( iPtr, iArg0 ) ) {};
90
91 // Deprecated in favor of the constructor above
92 IArrayProperty(
93 AbcA::ArrayPropertyReaderPtr iPtr,
94 WrapExistingFlag iWrapFlag,
95 const Argument &iArg0 = Argument() )
96 : IBasePropertyT<AbcA::ArrayPropertyReaderPtr>( iPtr,
97 GetErrorHandlerPolicy( iPtr, iArg0 ) ) {};
98
101
104 ~IArrayProperty();
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
124 AbcA::TimeSamplingPtr getTimeSampling() const;
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
142 bool getKey( AbcA::ArraySampleKey& oKey,
143 const ISampleSelector &iSS = ISampleSelector() ) const;
144
146 void getDimensions( Util::Dimensions & oDim,
147 const ISampleSelector &iSS = ISampleSelector() ) const;
148
151 ICompoundProperty getParent() const;
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
Alembic::Abc::ALEMBIC_VERSION_NS::Argument
Definition Argument.h:120
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty
Definition IArrayProperty.h:54
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::IArrayProperty
IArrayProperty()
Definition IArrayProperty.h:66
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::IArrayProperty
IArrayProperty(AbcA::ArrayPropertyReaderPtr iPtr, const Argument &iArg0=Argument())
Definition IArrayProperty.h:80
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::this_type
IArrayProperty this_type
Definition IArrayProperty.h:58
Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT
Definition IBaseProperty.h:58
Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::ArrayPropertyReaderPtr >::IBasePropertyT
IBasePropertyT()
Definition IBaseProperty.h:72
Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
Definition ICompoundProperty.h:53
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector
Definition ISampleSelector.h:49
Alembic
Alembic namespace ...
Definition ArchiveInfo.cpp:39