Alembic Version 1.1

Loading...
Searching...
No Matches
IScalarProperty.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#ifndef Alembic_Abc_IScalarProperty_h
37#define Alembic_Abc_IScalarProperty_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
47 namespace Alembic {
48 namespace Abc {
49 namespace ALEMBIC_VERSION_NS {
50
51//-*****************************************************************************
52 class ALEMBIC_EXPORT IScalarProperty
53 : public IBasePropertyT<AbcA::ScalarPropertyReaderPtr>
54{
55 public:
58 typedef IScalarProperty this_type;
59
60 //-*************************************************************************
61 // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
62 //-*************************************************************************
63
66 IScalarProperty() : IBasePropertyT<AbcA::ScalarPropertyReaderPtr>() {}
67
72 IScalarProperty( const ICompoundProperty & iParent,
73 const std::string &iName,
74
75 const Argument &iArg0 = Argument() );
76
79 IScalarProperty(
82 AbcA::ScalarPropertyReaderPtr iPtr,
83
86 const Argument &iArg0 = Argument() )
87 : IBasePropertyT<AbcA::ScalarPropertyReaderPtr>( iPtr,
88 GetErrorHandlerPolicy( iPtr, iArg0 ) )
89 {}
90
91 // Deprecated in favor of the constructor above
92 IScalarProperty(
93 AbcA::ScalarPropertyReaderPtr iPtr,
94 WrapExistingFlag iWrapFlag,
95 const Argument &iArg0 = Argument() )
96 : IBasePropertyT<AbcA::ScalarPropertyReaderPtr>( iPtr,
97 GetErrorHandlerPolicy( iPtr, iArg0 ) )
98 {}
99
102
105 ~IScalarProperty();
106
107 //-*************************************************************************
108 // SCALAR PROPERTY READER FUNCTIONALITY
109 //-*************************************************************************
110
115 size_t getNumSamples() const;
116
119 bool isConstant() const;
120
123 AbcA::TimeSamplingPtr getTimeSampling() const;
124
127 void get( void *oSample,
128 const ISampleSelector &iSS = ISampleSelector() ) const;
129
132 ICompoundProperty getParent() const;
133
134 private:
135 void init( AbcA::CompoundPropertyReaderPtr iParentObject,
136 const std::string &iName,
137
138 ErrorHandler::Policy iParentPolicy,
139
140 const Argument &iArg0 );
141};
142
143} // End namespace ALEMBIC_VERSION_NS
144
145 using namespace ALEMBIC_VERSION_NS;
146
147} // End namespace Abc
148} // End namespace Alembic
149
150#endif
Foundation.h
Argument.h
Base.h
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition Export.h:51
IBaseProperty.h
ICompoundProperty.h
ISampleSelector.h
Alembic::Abc::ALEMBIC_VERSION_NS::Argument
Definition Argument.h:120
Alembic::Abc::ALEMBIC_VERSION_NS::ErrorHandler::Policy
Policy
Definition ErrorHandler.h:52
Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::ScalarPropertyReaderPtr >::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::Abc::ALEMBIC_VERSION_NS::IScalarProperty::IScalarProperty
IScalarProperty(AbcA::ScalarPropertyReaderPtr iPtr, WrapExistingFlag iWrapFlag, const Argument &iArg0=Argument())
Definition IScalarProperty.h:92
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::get
void get(void *oSample, const ISampleSelector &iSS=ISampleSelector()) const
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::IScalarProperty
IScalarProperty()
Definition IScalarProperty.h:66
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::getNumSamples
size_t getNumSamples() const
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::getTimeSampling
AbcA::TimeSamplingPtr getTimeSampling() const
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::this_type
IScalarProperty this_type
Definition IScalarProperty.h:58
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::isConstant
bool isConstant() const
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::IScalarProperty
IScalarProperty(const ICompoundProperty &iParent, const std::string &iName, const Argument &iArg0=Argument())
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::getParent
ICompoundProperty getParent() const
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::IScalarProperty
IScalarProperty(AbcA::ScalarPropertyReaderPtr iPtr, const Argument &iArg0=Argument())
Definition IScalarProperty.h:79
Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::~IScalarProperty
~IScalarProperty()
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ScalarPropertyReaderPtr
Alembic::Util::shared_ptr< ScalarPropertyReader > ScalarPropertyReaderPtr
Definition ForwardDeclarations.h:94
Alembic::Abc::ALEMBIC_VERSION_NS
Definition ArchiveInfo.h:48
Alembic::Abc::ALEMBIC_VERSION_NS::GetErrorHandlerPolicy
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::Abc::ALEMBIC_VERSION_NS::WrapExistingFlag
WrapExistingFlag
Definition Foundation.h:94
Alembic::Abc
Definition ArchiveInfo.h:47
Alembic
Alembic namespace ...
Definition ArchiveInfo.h:46