Alembic: AbcGeom/OLight.h Source File

Alembic 1.8.11

Loading...
Searching...
No Matches
OLight.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
37#ifndef Alembic_AbcGeom_OLight_h
38#define Alembic_AbcGeom_OLight_h
39
40
41#include <Alembic/Util/Export.h>
42#include <Alembic/AbcGeom/OCamera.h>
43#include <Alembic/AbcGeom/Foundation.h>
44#include <Alembic/AbcGeom/SchemaInfoDeclarations.h>
45
46namespace Alembic {
47namespace AbcGeom {
48namespace ALEMBIC_VERSION_NS {
49
50//-*****************************************************************************
51 class ALEMBIC_EXPORT OLightSchema : public Abc::OSchema<LightSchemaInfo>
52{
53 //-*************************************************************************
54 // LIGHT SCHEMA (just a container schema which has a camera schema)
55 //-*************************************************************************
56public:
59 typedef OLightSchema this_type;
60
61 //-*************************************************************************
62 // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
63 //-*************************************************************************
64
67 OLightSchema() {}
68
75 OLightSchema( AbcA::CompoundPropertyWriterPtr iParent,
76 const std::string &iName,
77 const Abc::Argument &iArg0 = Abc::Argument(),
78 const Abc::Argument &iArg1 = Abc::Argument(),
79 const Abc::Argument &iArg2 = Abc::Argument(),
80 const Abc::Argument &iArg3 = Abc::Argument() );
81
88 OLightSchema( Abc::OCompoundProperty iParent,
89 const std::string &iName,
90 const Abc::Argument &iArg0 = Abc::Argument(),
91 const Abc::Argument &iArg1 = Abc::Argument(),
92 const Abc::Argument &iArg2 = Abc::Argument() );
93
95
96 //-*************************************************************************
97 // SCHEMA STUFF
98 //-*************************************************************************
99
101 AbcA::TimeSamplingPtr getTimeSampling() const { return m_tsPtr; }
102
103 //-*************************************************************************
104 // SAMPLE STUFF
105 //-*************************************************************************
106
109 size_t getNumSamples();
111 void setCameraSample( const CameraSample &iSamp );
112
114 void setFromPrevious();
115
116 void setTimeSampling( uint32_t iIndex );
117 void setTimeSampling( AbcA::TimeSamplingPtr iTime );
118
119 Abc::OCompoundProperty getUserProperties();
120 Abc::OCompoundProperty getArbGeomParams();
121 Abc::OBox3dProperty getChildBoundsProperty();
122
123 //-*************************************************************************
124 // ABC BASE MECHANISMS
125 // These functions are used by Abc to deal with errors, validity,
126 // and so on.
127 //-*************************************************************************
128
131 void reset()
132 {
133 m_userProperties.reset();
134 m_arbGeomParams.reset();
135 m_cameraSchema.reset();
136 m_childBoundsProperty.reset();
137 Abc::OSchema<LightSchemaInfo>::reset();
138 }
139
141 bool valid() const
142 {
143 return ( Abc::OSchema<LightSchemaInfo>::valid() );
144 }
145
148 ALEMBIC_OVERRIDE_OPERATOR_BOOL( OLightSchema::valid() );
149
150protected:
151
152 void init( AbcA::CompoundPropertyWriterPtr iParent,
153 const Abc::Argument &iArg0,
154 const Abc::Argument &iArg1,
155 const Abc::Argument &iArg2,
156 const Abc::Argument &iArg3 );
157
158 AbcA::TimeSamplingPtr m_tsPtr;
159
160 Abc::OBox3dProperty m_childBoundsProperty;
161
162 Abc::OCompoundProperty m_userProperties;
163 Abc::OCompoundProperty m_arbGeomParams;
164
165 AbcGeom::OCameraSchema m_cameraSchema;
166};
167
168//-*****************************************************************************
169// SCHEMA OBJECT
170//-*****************************************************************************
171typedef Abc::OSchemaObject<OLightSchema> OLight;
172
173typedef Util::shared_ptr< OLight > OLightPtr;
174
175} // End namespace ALEMBIC_VERSION_NS
176
177using namespace ALEMBIC_VERSION_NS;
178
179} // End namespace AbcGeom
180} // End namespace Alembic
181
182#endif
Alembic::Abc::ALEMBIC_VERSION_NS::Argument
Definition Argument.h:120
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty
Definition OCompoundProperty.h:53
Alembic::Abc::ALEMBIC_VERSION_NS::OSchema
Definition OSchema.h:119
Alembic::Abc::ALEMBIC_VERSION_NS::OSchemaObject
Definition OSchemaObject.h:54
Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample
Definition CameraSample.h:50
Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCameraSchema
Definition OCamera.h:51
Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema
Definition OLight.h:52
Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::OLightSchema
OLightSchema()
Definition OLight.h:67
Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::ALEMBIC_OVERRIDE_OPERATOR_BOOL
ALEMBIC_OVERRIDE_OPERATOR_BOOL(OLightSchema::valid())
Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::this_type
OLightSchema this_type
Definition OLight.h:59
Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::reset
void reset()
Definition OLight.h:131
Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::valid
bool valid() const
Returns whether this function set is valid.
Definition OLight.h:141
Alembic::AbcGeom::ALEMBIC_VERSION_NS::OLightSchema::getTimeSampling
AbcA::TimeSamplingPtr getTimeSampling() const
Default assignment and copy operator used.
Definition OLight.h:101
Alembic
Alembic namespace ...
Definition ArchiveInfo.cpp:39