HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ILight.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_ILight_h
38 #define Alembic_AbcGeom_ILight_h
39 
40 #include <Alembic/Util/Export.h>
44 
45 namespace Alembic {
46 namespace AbcGeom {
47 namespace 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  //-*************************************************************************
55 public:
56  //! By convention we always define this_type in AbcGeom classes.
57  //! Used by unspecified-bool-type conversion below
59 
60  //-*************************************************************************
61  // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
62  //-*************************************************************************
63 
64  //! The default constructor creates an empty OLightMeshSchema
65  //! ...
67 
68  //! This constructor creates a new light reader.
69  //! The first argument is the parent ICompoundProperty, from which the
70  //! error handler policy for is derived. The second argument is the name
71  //! of the ICompoundProperty that contains this schemas properties. The
72  //! remaining optional arguments can be used to override the
73  //! ErrorHandlerPolicy and to specify schema interpretation matching.
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 
83  //! This constructor wraps an existing ICompoundProperty as the faceset
84  //! reader, and the error handler policy is derived from it.
85  //! The remaining optional arguments can be used to override the
86  //! ErrorHandlerPolicy and to specify schema interpretation matching.
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 
95  //! Copy constructor.
96  ILightSchema(const ILightSchema& iCopy)
97  : Abc::ISchema<LightSchemaInfo>()
98  {
99  *this = iCopy;
100  }
101 
102  //! Access to the camera schema.
103  ICameraSchema getCameraSchema() const { return m_cameraSchema; }
104 
105  //! Access to the child bounds property
107  {
108  return m_childBoundsProperty;
109  }
110 
111  AbcA::TimeSamplingPtr getTimeSampling() const;
112 
113  bool isConstant() const;
114 
115  size_t getNumSamples() const;
116 
117  // compound property to use as parent for any arbitrary GeomParams
118  // underneath it
119  ICompoundProperty getArbGeomParams() const { return m_arbGeomParams; }
120  ICompoundProperty getUserProperties() const { return m_userProperties; }
121 
122  //! Reset returns this function set to an empty, default
123  //! state.
124  void reset()
125  {
126  m_childBoundsProperty.reset();
127  m_arbGeomParams.reset();
128  m_userProperties.reset();
129  m_cameraSchema.reset();
131  }
132 
133  //! Returns whether this function set is valid.
134  bool valid() const
135  {
137  }
138 
139  //! unspecified-bool-type operator overload.
140  //! ...
142 
143  protected:
144  void init( const Abc::Argument& iArg0,
145  const Abc::Argument& iArg1 );
146 
150 
152 };
153 
154 //-*****************************************************************************
155 // SCHEMA OBJECT
156 //-*****************************************************************************
158 
159 typedef Util::shared_ptr< ILight > ILightPtr;
160 
161 } // End namespace ALEMBIC_VERSION_NS
162 
163 using namespace ALEMBIC_VERSION_NS;
164 
165 } // End namespace AbcGeom
166 } // End namespace Alembic
167 
168 #endif
Abc::ISchemaObject< ILightSchema > ILight
Definition: ILight.h:157
ILightSchema(const ICompoundProperty &iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition: ILight.h:74
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
ICompoundProperty getArbGeomParams() const
Definition: ILight.h:119
ILightSchema(const ILightSchema &iCopy)
Copy constructor.
Definition: ILight.h:96
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
Abc::IBox3dProperty getChildBoundsProperty() const
Access to the child bounds property.
Definition: ILight.h:106
ICameraSchema getCameraSchema() const
Access to the camera schema.
Definition: ILight.h:103
#define ALEMBIC_OVERRIDE_OPERATOR_BOOL(PASS_COND)
Definition: OperatorBool.h:56
bool valid() const
Returns whether this function set is valid.
Definition: ILight.h:134
Alembic::AbcGeom::ICameraSchema m_cameraSchema
Definition: ILight.h:151
ICompoundProperty getUserProperties() const
Definition: ILight.h:120
Util::shared_ptr< ILight > ILightPtr
Definition: ILight.h:159
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
ILightSchema(const ICompoundProperty &iProp, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition: ILight.h:87