Alembic Version 1.1

ICamera.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
37#ifndef Alembic_AbcGeom_ICamera_h
38#define Alembic_AbcGeom_ICamera_h
39
40#include <Alembic/Util/Export.h>
41#include <Alembic/AbcGeom/Foundation.h>
42#include <Alembic/AbcGeom/SchemaInfoDeclarations.h>
43#include <Alembic/AbcGeom/CameraSample.h>
44
45 namespace Alembic {
46 namespace AbcGeom {
47 namespace ALEMBIC_VERSION_NS {
48
49//-*****************************************************************************
50 class ALEMBIC_EXPORT ICameraSchema : public Abc::ISchema<CameraSchemaInfo>
51{
52 //-*************************************************************************
53 // CAMERA SCHEMA
54 //-*************************************************************************
55 public:
58 typedef ICameraSchema this_type;
59
60 //-*************************************************************************
61 // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
62 //-*************************************************************************
63
66 ICameraSchema() {}
67
74 ICameraSchema( const ICompoundProperty & iParent,
75 const std::string &iName,
76
77 const Abc::Argument &iArg0 = Abc::Argument(),
78 const Abc::Argument &iArg1 = Abc::Argument() )
79 : Abc::ISchema<CameraSchemaInfo>( iParent, iName, iArg0, iArg1 )
80 {
81 init( iArg0, iArg1 );
82 }
83
88 ICameraSchema( const ICompoundProperty & iProp,
89 const Abc::Argument &iArg0 = Abc::Argument(),
90 const Abc::Argument &iArg1 = Abc::Argument() )
91 : Abc::ISchema<CameraSchemaInfo>( iProp, iArg0, iArg1 )
92 {
93 init( iArg0, iArg1 );
94 }
95
96
98 ICameraSchema(const ICameraSchema& iCopy)
99 : Abc::ISchema<CameraSchemaInfo>()
100 {
101 *this = iCopy;
102 }
103
105
107 AbcA::TimeSamplingPtr getTimeSampling() const
108 { return m_coreProperties.getTimeSampling(); }
109
114 size_t getNumSamples() const
115 { return m_coreProperties.getNumSamples(); }
116
119 bool isConstant() const;
120
121 void get( CameraSample &oSample,
122 const Abc::ISampleSelector &iSS = Abc::ISampleSelector() ) const;
123
124 CameraSample getValue(
125 const Abc::ISampleSelector &iSS = Abc::ISampleSelector() ) const
126 {
127 CameraSample smp;
128 get( smp, iSS );
129 return smp;
130 }
131
132 // compound property to use as parent for any arbitrary GeomParams
133 // underneath it
134 ICompoundProperty getArbGeomParams() const { return m_arbGeomParams; }
135 ICompoundProperty getUserProperties() const { return m_userProperties; }
136
137 Abc::IBox3dProperty getChildBoundsProperty() const { return m_childBoundsProperty; }
138
141 void reset()
142 {
143 m_coreProperties.reset();
144 m_childBoundsProperty.reset();
145 m_arbGeomParams.reset();
146 m_userProperties.reset();
147 m_ops.clear();
148 Abc::ISchema<CameraSchemaInfo>::reset();
149 }
150
152 bool valid() const
153 {
154 return ( Abc::ISchema<CameraSchemaInfo>::valid() &&
155 m_coreProperties.valid() );
156 }
157
160 ALEMBIC_OVERRIDE_OPERATOR_BOOL( ICameraSchema::valid() );
161
162 protected:
163 void init( const Abc::Argument &iArg0,
164 const Abc::Argument &iArg1 );
165
166 Abc::IScalarProperty m_coreProperties;
167
168 Abc::IBox3dProperty m_childBoundsProperty;
169
170 Abc::ICompoundProperty m_arbGeomParams;
171 Abc::ICompoundProperty m_userProperties;
172
173 Abc::IScalarProperty m_smallFilmBackChannels;
174 Abc::IDoubleArrayProperty m_largeFilmBackChannels;
175
176 private:
177 std::vector < FilmBackXformOp > m_ops;
178
179};
180
181//-*****************************************************************************
182// SCHEMA OBJECT
183//-*****************************************************************************
184 typedef Abc::ISchemaObject<ICameraSchema> ICamera;
185
186 typedef Util::shared_ptr< ICamera > ICameraPtr;
187
188} // End namespace ALEMBIC_VERSION_NS
189
190 using namespace ALEMBIC_VERSION_NS;
191
192} // End namespace AbcGeom
193} // End namespace Alembic
194
195#endif
Foundation.h
SchemaInfoDeclarations.h
CameraSample.h
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition: Export.h:51
ALEMBIC_VERSION_NS
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample
Definition: CameraSample.h:50
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema
Definition: ICamera.h:51
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::getNumSamples
size_t getNumSamples() const
Definition: ICamera.h:114
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::ICameraSchema
ICameraSchema()
Definition: ICamera.h:66
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::valid
bool valid() const
Returns whether this function set is valid.
Definition: ICamera.h:152
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::isConstant
bool isConstant() const
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::m_smallFilmBackChannels
Abc::IScalarProperty m_smallFilmBackChannels
Definition: ICamera.h:173
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::getValue
CameraSample getValue(const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
Definition: ICamera.h:124
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::m_largeFilmBackChannels
Abc::IDoubleArrayProperty m_largeFilmBackChannels
Definition: ICamera.h:174
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::ALEMBIC_OVERRIDE_OPERATOR_BOOL
ALEMBIC_OVERRIDE_OPERATOR_BOOL(ICameraSchema::valid())
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::ICameraSchema
ICameraSchema(const ICompoundProperty &iProp, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition: ICamera.h:88
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::m_arbGeomParams
Abc::ICompoundProperty m_arbGeomParams
Definition: ICamera.h:170
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::m_coreProperties
Abc::IScalarProperty m_coreProperties
Definition: ICamera.h:166
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::m_userProperties
Abc::ICompoundProperty m_userProperties
Definition: ICamera.h:171
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::ICameraSchema
ICameraSchema(const ICompoundProperty &iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition: ICamera.h:74
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::getChildBoundsProperty
Abc::IBox3dProperty getChildBoundsProperty() const
Definition: ICamera.h:137
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::m_childBoundsProperty
Abc::IBox3dProperty m_childBoundsProperty
Definition: ICamera.h:168
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::init
void init(const Abc::Argument &iArg0, const Abc::Argument &iArg1)
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::getTimeSampling
AbcA::TimeSamplingPtr getTimeSampling() const
Default assignment operator used.
Definition: ICamera.h:107
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::this_type
ICameraSchema this_type
Definition: ICamera.h:58
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::reset
void reset()
Definition: ICamera.h:141
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::ICameraSchema
ICameraSchema(const ICameraSchema &iCopy)
Copy constructor.
Definition: ICamera.h:98
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::getUserProperties
ICompoundProperty getUserProperties() const
Definition: ICamera.h:135
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::get
void get(CameraSample &oSample, const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::getArbGeomParams
ICompoundProperty getArbGeomParams() const
Definition: ICamera.h:134
Alembic::Abc::ALEMBIC_VERSION_NS::Argument
Definition: Argument.h:120
Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >::reset
void reset()
Definition: IBaseProperty.h:160
Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT::valid
bool valid() const
Definition: IBaseProperty.h:164
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
Definition: IScalarProperty.h:54
Alembic::Abc::ALEMBIC_VERSION_NS::ISchemaObject
Definition: ISchemaObject.h:56
Alembic::Abc::ALEMBIC_VERSION_NS::ISchema
Definition: ISchema.h:58
Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< Float64TPTraits >
Alembic::Abc::ALEMBIC_VERSION_NS::ITypedScalarProperty< Box3dTPTraits >
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSamplingPtr
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICamera
Abc::ISchemaObject< ICameraSchema > ICamera
Definition: ICamera.h:184
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraPtr
Util::shared_ptr< ICamera > ICameraPtr
Definition: ICamera.h:186
Alembic::Abc::ALEMBIC_VERSION_NS
Definition: ArchiveInfo.h:48
Alembic
Alembic namespace ...
Definition: ArchiveInfo.h:46