Alembic: AbcGeom/ILight.h Source File

Alembic 1.8.11

Loading...
Searching...
No Matches
ILight.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_ILight_h
38#define Alembic_AbcGeom_ILight_h
39
40#include <Alembic/Util/Export.h>
41#include <Alembic/AbcGeom/ICamera.h>
42#include <Alembic/AbcGeom/Foundation.h>
43#include <Alembic/AbcGeom/SchemaInfoDeclarations.h>
44
45namespace Alembic {
46namespace AbcGeom {
47namespace ALEMBIC_VERSION_NS {
48
49//-*****************************************************************************
50 class ALEMBIC_EXPORT ILightSchema : public Abc::ISchema<LightSchemaInfo>
51{
52 //-*************************************************************************
53 // LIGHT SCHEMA (container schema which has a camera schema)
54 //-*************************************************************************
55public:
58 typedef ILightSchema this_type;
59
60 //-*************************************************************************
61 // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
62 //-*************************************************************************
63
66 ILightSchema() {}
67
74 ILightSchema( const ICompoundProperty &iParent,
75 const std::string &iName,
76 const Abc::Argument &iArg0 = Abc::Argument(),
77 const Abc::Argument &iArg1 = Abc::Argument() )
78 : Abc::ISchema<LightSchemaInfo>( iParent, iName, iArg0, iArg1 )
79 {
80 init( iArg0, iArg1 );
81 }
82
87 explicit ILightSchema( const ICompoundProperty &iProp,
88 const Abc::Argument &iArg0 = Abc::Argument(),
89 const Abc::Argument &iArg1 = Abc::Argument() )
90 : Abc::ISchema<LightSchemaInfo>( iProp, iArg0, iArg1 )
91 {
92 init( iArg0, iArg1 );
93 }
94
96 ICameraSchema getCameraSchema() const { return m_cameraSchema; }
97
99 Abc::IBox3dProperty getChildBoundsProperty() const
100 {
101 return m_childBoundsProperty;
102 }
103
104 AbcA::TimeSamplingPtr getTimeSampling() const;
105
106 bool isConstant() const;
107
108 size_t getNumSamples() const;
109
110 // compound property to use as parent for any arbitrary GeomParams
111 // underneath it
112 ICompoundProperty getArbGeomParams() const { return m_arbGeomParams; }
113 ICompoundProperty getUserProperties() const { return m_userProperties; }
114
117 void reset()
118 {
119 m_childBoundsProperty.reset();
120 m_arbGeomParams.reset();
121 m_userProperties.reset();
122 m_cameraSchema.reset();
123 Abc::ISchema<LightSchemaInfo>::reset();
124 }
125
127 bool valid() const
128 {
129 return ( Abc::ISchema<LightSchemaInfo>::valid() );
130 }
131
134 ALEMBIC_OVERRIDE_OPERATOR_BOOL( ILightSchema::valid() );
135
136 protected:
137 void init( const Abc::Argument& iArg0,
138 const Abc::Argument& iArg1 );
139
140 Abc::IBox3dProperty m_childBoundsProperty;
141 Abc::ICompoundProperty m_arbGeomParams;
142 Abc::ICompoundProperty m_userProperties;
143
144 Alembic::AbcGeom::ICameraSchema m_cameraSchema;
145};
146
147//-*****************************************************************************
148// SCHEMA OBJECT
149//-*****************************************************************************
150typedef Abc::ISchemaObject< ILightSchema > ILight;
151
152typedef Util::shared_ptr< ILight > ILightPtr;
153
154} // End namespace ALEMBIC_VERSION_NS
155
156using namespace ALEMBIC_VERSION_NS;
157
158} // End namespace AbcGeom
159} // End namespace Alembic
160
161#endif
Alembic::Abc::ALEMBIC_VERSION_NS::Argument
Definition Argument.h:120
Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
Definition ICompoundProperty.h:53
Alembic::Abc::ALEMBIC_VERSION_NS::ISchema
Definition ISchema.h:58
Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< LightSchemaInfo >::ISchema
ISchema()
Definition ISchema.h:112
Alembic::Abc::ALEMBIC_VERSION_NS::ISchemaObject< ILightSchema >
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema
Definition ICamera.h:51
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::getCameraSchema
ICameraSchema getCameraSchema() const
Access to the camera schema.
Definition ILight.h:96
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::this_type
ILightSchema this_type
Definition ILight.h:58
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::ALEMBIC_OVERRIDE_OPERATOR_BOOL
ALEMBIC_OVERRIDE_OPERATOR_BOOL(ILightSchema::valid())
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::ILightSchema
ILightSchema(const ICompoundProperty &iProp, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition ILight.h:87
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::getChildBoundsProperty
Abc::IBox3dProperty getChildBoundsProperty() const
Access to the child bounds property.
Definition ILight.h:99
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::valid
bool valid() const
Returns whether this function set is valid.
Definition ILight.h:127
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::ILightSchema
ILightSchema()
Definition ILight.h:66
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::ILightSchema
ILightSchema(const ICompoundProperty &iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition ILight.h:74
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ILightSchema::reset
void reset()
Definition ILight.h:117
Alembic
Alembic namespace ...
Definition ArchiveInfo.cpp:39