Alembic Version 1.1
OXform.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_OXform_h
38#define Alembic_AbcGeom_OXform_h
39
40#include <Alembic/Util/Export.h>
43
45
46namespace Alembic {
47namespace AbcGeom {
48namespace ALEMBIC_VERSION_NS {
49
53
54//-*****************************************************************************
55class ALEMBIC_EXPORT OXformSchema : public Abc::OSchema<XformSchemaInfo>
56{
57 //-*************************************************************************
58 // XFORM SCHEMA
59 //-*************************************************************************
60public:
61
67
68 //-*************************************************************************
69 // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
70 //-*************************************************************************
71
75 {
76 m_numChannels = 0;
77 m_numOps = 0;
78 m_useArrayProp = false;
79 m_isIdentity = true;
80 }
81
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 const Abc::Argument &iArg3 = Abc::Argument() );
94
102 const std::string &iName,
103 const Abc::Argument &iArg0 = Abc::Argument(),
104 const Abc::Argument &iArg1 = Abc::Argument(),
105 const Abc::Argument &iArg2 = Abc::Argument() );
106
109 : Abc::OSchema<XformSchemaInfo>()
110 { *this = iCopy; }
111
113
114 //-*************************************************************************
115 // SCHEMA STUFF
116 //-*************************************************************************
117
119
120 //-*************************************************************************
121 // SAMPLE STUFF
122 //-*************************************************************************
123
126 size_t getNumSamples() const;
127
130 void set( XformSample &ioSamp );
131
134
135 void setTimeSampling( uint32_t iIndex );
137
141
142 //-*************************************************************************
143 // ABC BASE MECHANISMS
144 // These functions are used by Abc to deal with errors, validity,
145 // and so on.
146 //-*************************************************************************
147
150 void reset()
151 {
152 m_childBoundsProperty.reset();
153 m_inheritsProperty.reset();
154 m_opsPWPtr.reset();
155 m_valsPWPtr.reset();
156 m_protoSample.reset();
157 m_data.reset();
158
159 m_arbGeomParams.reset();
160 m_userProperties.reset();
161
162 super_type::reset();
163 }
164
166 bool valid() const
167 {
168 return ( super_type::valid() );
169 }
170
173 ALEMBIC_OVERRIDE_OPERATOR_BOOL( this_type::valid() );
174
175
176private:
177 void init( const AbcA::index_t iTSIndex );
178
179 // not technically needed as the m_protoSample can return this info
180 std::size_t m_numChannels;
181 std::size_t m_numOps;
182
183 // should we store are channel values in an ArrayProperty,
184 // or in a ScalarProperty with some Dimension > 0 and < MAX_SCALAR_CHANS
185 bool m_useArrayProp;
186
187 AbcA::DataType m_arrayValuesDataType;
188 Alembic::Util::Dimensions m_arraySampleDimensions;
189
190 void setChannelValues( const std::vector<double> &iVals );
191
192protected:
193
195
197
199
201
203
204 // ensure that our sample's topology is unchanging between
205 // calls to set; see usage in OXformSchema::set()
207
209
211
213
214 class Data;
215
216 // shared and not scoped because we want this to be shared across copies
217 Util::shared_ptr< Data > m_data;
218};
219
220//-*****************************************************************************
221// SCHEMA OBJECT
222//-*****************************************************************************
224
225typedef Util::shared_ptr< OXform > OXformPtr;
226
227} // End namespace ALEMBIC_VERSION_NS
228
229using namespace ALEMBIC_VERSION_NS;
230
231} // End namespace AbcGeom
232} // End namespace Alembic
233
234#endif
#define ALEMBIC_EXPORT_CONST
Definition: Export.h:53
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
OXformSchema(AbcA::CompoundPropertyWriterPtr iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument(), const Abc::Argument &iArg3=Abc::Argument())
void setTimeSampling(AbcA::TimeSamplingPtr iTime)
OXformSchema(const OXformSchema &iCopy)
Explicit copy constructor to work around MSVC bug.
Definition: OXform.h:108
OXformSchema(Abc::OCompoundProperty iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument())
AbcA::TimeSamplingPtr getTimeSampling() const
Default assignment operator used.
bool valid() const
Valid returns whether this function set is valid.
Definition: OXform.h:166
AbcA::ScalarPropertyWriterPtr m_opsPWPtr
Definition: OXform.h:196
Abc::OSchema< XformSchemaInfo > super_type
Definition: OXform.h:64
void setFromPrevious()
Set from previous sample. Will hold the animated channels.
AbcA::BasePropertyWriterPtr m_valsPWPtr
Definition: OXform.h:198
Alembic::Util::shared_ptr< CompoundPropertyWriter > CompoundPropertyWriterPtr
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
Alembic::Util::shared_ptr< BasePropertyWriter > BasePropertyWriterPtr
Alembic::Util::shared_ptr< ScalarPropertyWriter > ScalarPropertyWriterPtr
Util::shared_ptr< OXform > OXformPtr
Definition: OXform.h:225
Abc::OSchemaObject< OXformSchema > OXform
Definition: OXform.h:223
static ALEMBIC_EXPORT_CONST double kXFORM_DELTA_TOLERANCE
Definition: OXform.h:52
Alembic namespace ...
Definition: ArchiveInfo.h:46