Alembic Version 1.1
Loading...
Searching...
No Matches
IPoints.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_IPoints_h
38#define Alembic_AbcGeom_IPoints_h
39
40#include <Alembic/Util/Export.h>
45
46namespace Alembic {
47namespace AbcGeom {
48namespace ALEMBIC_VERSION_NS {
49
50//-*****************************************************************************
51class ALEMBIC_EXPORT IPointsSchema : public IGeomBaseSchema<PointsSchemaInfo>
52{
53public:
54 class Sample
55 {
56 public:
58
59 // Users don't ever create this data directly.
60 Sample() { reset(); }
61
62 Abc::P3fArraySamplePtr getPositions() const { return m_positions; }
63 Abc::UInt64ArraySamplePtr getIds() const { return m_ids; }
64 Abc::V3fArraySamplePtr getVelocities() const { return m_velocities; }
65
66 Abc::Box3d getSelfBounds() const { return m_selfBounds; }
67
68 bool valid() const
69 {
70 return m_positions && m_ids;
71 }
72
73 void reset()
74 {
75 m_positions.reset();
76 m_velocities.reset();
77 m_ids.reset();
78 m_selfBounds.makeEmpty();
79 }
80
82
83 protected:
84 friend class IPointsSchema;
88
89 Abc::Box3d m_selfBounds;
90 };
91
92 //-*************************************************************************
93 // POINTS SCHEMA
94 //-*************************************************************************
95public:
99
100 //-*************************************************************************
101 // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
102 //-*************************************************************************
103
107
115 const std::string &iName,
116
117 const Abc::Argument &iArg0 = Abc::Argument(),
118 const Abc::Argument &iArg1 = Abc::Argument() )
119 : IGeomBaseSchema<PointsSchemaInfo>( iParent, iName, iArg0, iArg1 )
120 {
121 init( iArg0, iArg1 );
122 }
123
129 const Abc::Argument &iArg0 = Abc::Argument(),
130 const Abc::Argument &iArg1 = Abc::Argument() )
131 : IGeomBaseSchema<PointsSchemaInfo>( iProp, iArg0, iArg1 )
132 {
133 init( iArg0, iArg1 );
134 }
135
138 : IGeomBaseSchema<PointsSchemaInfo>()
139 {
140 *this = iCopy;
141 }
142
144
145 //-*************************************************************************
146 // SCALAR PROPERTY READER FUNCTIONALITY
147 //-*************************************************************************
148
153 size_t getNumSamples() const
154 { return std::max( m_positionsProperty.getNumSamples(),
155 m_idsProperty.getNumSamples() ); }
156
159 bool isConstant() const { return m_positionsProperty.isConstant() && m_idsProperty.isConstant(); }
160
164 {
165 if ( m_positionsProperty.valid() )
166 {
167 return m_positionsProperty.getTimeSampling();
168 }
169 return getObject().getArchive().getTimeSampling(0);
170 }
171
172 //-*************************************************************************
173 void get( Sample &oSample,
174 const Abc::ISampleSelector &iSS = Abc::ISampleSelector() ) const
175 {
176 ALEMBIC_ABC_SAFE_CALL_BEGIN( "IPointsSchema::get()" );
177
178 m_positionsProperty.get( oSample.m_positions, iSS );
179 m_idsProperty.get( oSample.m_ids, iSS );
180
181 m_selfBoundsProperty.get( oSample.m_selfBounds, iSS );
182
183 if ( m_velocitiesProperty && m_velocitiesProperty.getNumSamples() > 0 )
184 { m_velocitiesProperty.get( oSample.m_velocities, iSS ); }
185
186 // Could error check here.
187
189 }
190
192 {
193 Sample smp;
194 get( smp, iSS );
195 return smp;
196 }
197
199 {
200 return m_positionsProperty;
201 }
202
204 {
205 return m_velocitiesProperty;
206 }
207
209 {
210 return m_idsProperty;
211 }
212
214 {
215 return m_widthsParam;
216 }
217
218 //-*************************************************************************
219 // ABC BASE MECHANISMS
220 // These functions are used by Abc to deal with errors, rewrapping,
221 // and so on.
222 //-*************************************************************************
223
226 void reset()
227 {
228 m_positionsProperty.reset();
229 m_velocitiesProperty.reset();
230 m_idsProperty.reset();
231 m_widthsParam.reset();
232
234 }
235
238 bool valid() const
239 {
241 m_positionsProperty.valid() &&
242 m_idsProperty.valid() );
243 }
244
247 ALEMBIC_OVERRIDE_OPERATOR_BOOL( IPointsSchema::valid() );
248
249protected:
250 void init( const Abc::Argument &iArg0,
251 const Abc::Argument &iArg1 );
252
257};
258
259//-*****************************************************************************
261
262typedef Util::shared_ptr< IPoints > IPointsPtr;
263
264} // End namespace ALEMBIC_VERSION_NS
265
266using namespace ALEMBIC_VERSION_NS;
267
268} // End namespace AbcGeom
269} // End namespace Alembic
270
271#endif
#define ALEMBIC_ABC_SAFE_CALL_END()
#define ALEMBIC_ABC_SAFE_CALL_BEGIN(CONTEXT)
#define ALEMBIC_EXPORT
Definition Export.h:51
#define ALEMBIC_VERSION_NS
Definition Foundation.h:105
Abc::IP3fArrayProperty getPositionsProperty() const
Definition IPoints.h:198
IPointsSchema(const IPointsSchema &iCopy)
Copy constructor.
Definition IPoints.h:137
size_t getNumSamples() const
Default assignment operator used.
Definition IPoints.h:153
IPointsSchema(const ICompoundProperty &iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition IPoints.h:114
AbcA::TimeSamplingPtr getTimeSampling() const
Definition IPoints.h:163
void init(const Abc::Argument &iArg0, const Abc::Argument &iArg1)
void get(Sample &oSample, const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
Definition IPoints.h:173
Sample getValue(const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
Definition IPoints.h:191
Abc::IV3fArrayProperty getVelocitiesProperty() const
Definition IPoints.h:203
Abc::IUInt64ArrayProperty getIdsProperty() const
Definition IPoints.h:208
IPointsSchema(const ICompoundProperty iProp, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition IPoints.h:128
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Util::shared_ptr< IPoints > IPointsPtr
Definition IPoints.h:262
Alembic::Util::shared_ptr< UInt64ArraySample > UInt64ArraySamplePtr
Alembic::Util::shared_ptr< V3fArraySample > V3fArraySamplePtr
Alembic::Util::shared_ptr< P3fArraySample > P3fArraySamplePtr
Alembic namespace ...
Definition ArchiveInfo.h:46