HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OLight.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_OLight_h
38 #define Alembic_AbcGeom_OLight_h
39 
40 
41 #include <Alembic/Util/Export.h>
45 
46 namespace Alembic {
47 namespace AbcGeom {
48 namespace 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  //-*************************************************************************
56 public:
57  //! By convention we always define this_type in AbcGeom classes.
58  //! Used by unspecified-bool-type conversion below
60 
61  //-*************************************************************************
62  // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
63  //-*************************************************************************
64 
65  //! The default constructor creates an empty OLightMeshSchema
66  //! ...
68 
69  //! This constructor creates a new light writer.
70  //! The first argument is an CompoundPropertyWriterPtr to use as a parent.
71  //! The next is the name to give the schema which is usually the default
72  //! name given by OLight (.geom) The remaining optional arguments
73  //! can be used to override the ErrorHandlerPolicy, to specify
74  //! MetaData, specify sparse sampling and to set TimeSampling.
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 
82  //! This constructor creates a new light writer.
83  //! The first argument is an OCompundProperty to use as a parent, and from
84  //! which the ErrorHandlerPolicy is derived. The next is the name to give
85  //! the schema which is usually the default name given by OLight (.geom)
86  //! The remaining optional arguments can be used to specify MetaData,
87  //! specify sparse sampling and to set TimeSampling.
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 
94  //! Copy constructor.
95  OLightSchema(const OLightSchema& iCopy)
96  : Abc::OSchema<LightSchemaInfo>()
97  {
98  *this = iCopy;
99  }
100 
101  //! Default assignment operator used.
102 
103  //-*************************************************************************
104  // SCHEMA STUFF
105  //-*************************************************************************
106 
107  //! Return the time sampling.
108  AbcA::TimeSamplingPtr getTimeSampling() const { return m_tsPtr; }
109 
110  //-*************************************************************************
111  // SAMPLE STUFF
112  //-*************************************************************************
113 
114  //! All of our properties are not mandatory so we'll just use the
115  //! child bounds.
116  size_t getNumSamples();
117  //! Set a sample
118  void setCameraSample( const CameraSample &iSamp );
119 
120  //! Set from previous sample.
121  void setFromPrevious();
122 
123  void setTimeSampling( uint32_t iIndex );
124  void setTimeSampling( AbcA::TimeSamplingPtr iTime );
125 
126  Abc::OCompoundProperty getUserProperties();
127  Abc::OCompoundProperty getArbGeomParams();
128  Abc::OBox3dProperty getChildBoundsProperty();
129 
130  //-*************************************************************************
131  // ABC BASE MECHANISMS
132  // These functions are used by Abc to deal with errors, validity,
133  // and so on.
134  //-*************************************************************************
135 
136  //! Reset returns this function set to an empty, default
137  //! state.
138  void reset()
139  {
140  m_userProperties.reset();
141  m_arbGeomParams.reset();
142  m_cameraSchema.reset();
143  m_childBoundsProperty.reset();
145  }
146 
147  //! Returns whether this function set is valid.
148  bool valid() const
149  {
151  }
152 
153  //! unspecified-bool-type operator overload.
154  //! ...
156 
157 protected:
158 
159  void init( AbcA::CompoundPropertyWriterPtr iParent,
160  const Abc::Argument &iArg0,
161  const Abc::Argument &iArg1,
162  const Abc::Argument &iArg2,
163  const Abc::Argument &iArg3 );
164 
166 
168 
171 
173 };
174 
175 //-*****************************************************************************
176 // SCHEMA OBJECT
177 //-*****************************************************************************
179 
180 typedef Util::shared_ptr< OLight > OLightPtr;
181 
182 } // End namespace ALEMBIC_VERSION_NS
183 
184 using namespace ALEMBIC_VERSION_NS;
185 
186 } // End namespace AbcGeom
187 } // End namespace Alembic
188 
189 #endif
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
OLightSchema(const OLightSchema &iCopy)
Copy constructor.
Definition: OLight.h:95
Util::shared_ptr< OLight > OLightPtr
Definition: OLight.h:180
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
#define ALEMBIC_OVERRIDE_OPERATOR_BOOL(PASS_COND)
Definition: OperatorBool.h:56
AbcA::TimeSamplingPtr getTimeSampling() const
Default assignment operator used.
Definition: OLight.h:108
Abc::OSchemaObject< OLightSchema > OLight
Definition: OLight.h:178
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
Alembic::Util::shared_ptr< CompoundPropertyWriter > CompoundPropertyWriterPtr
bool valid() const
Returns whether this function set is valid.
Definition: OLight.h:148