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>
41#include <Alembic/AbcGeom/Foundation.h>
42#include <Alembic/AbcGeom/SchemaInfoDeclarations.h>
43#include <Alembic/AbcGeom/IGeomParam.h>
44#include <Alembic/AbcGeom/IGeomBase.h>
45
46 namespace Alembic {
47 namespace AbcGeom {
48 namespace ALEMBIC_VERSION_NS {
49
50//-*****************************************************************************
51 class ALEMBIC_EXPORT IPointsSchema : public IGeomBaseSchema<PointsSchemaInfo>
52{
53 public:
54 class Sample
55 {
56 public:
57 typedef Sample this_type;
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
81 ALEMBIC_OPERATOR_BOOL( valid() );
82
83 protected:
84 friend class IPointsSchema;
85 Abc::P3fArraySamplePtr m_positions;
86 Abc::UInt64ArraySamplePtr m_ids;
87 Abc::V3fArraySamplePtr m_velocities;
88
89 Abc::Box3d m_selfBounds;
90 };
91
92 //-*************************************************************************
93 // POINTS SCHEMA
94 //-*************************************************************************
95 public:
98 typedef IPointsSchema this_type;
99
100 //-*************************************************************************
101 // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
102 //-*************************************************************************
103
106 IPointsSchema() {}
107
114 IPointsSchema( const ICompoundProperty &iParent,
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
128 IPointsSchema( const ICompoundProperty iProp,
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
137 IPointsSchema(const IPointsSchema& iCopy)
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
163 AbcA::TimeSamplingPtr getTimeSampling() const
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
188 ALEMBIC_ABC_SAFE_CALL_END();
189 }
190
191 Sample getValue( const Abc::ISampleSelector &iSS = Abc::ISampleSelector() ) const
192 {
193 Sample smp;
194 get( smp, iSS );
195 return smp;
196 }
197
198 Abc::IP3fArrayProperty getPositionsProperty() const
199 {
200 return m_positionsProperty;
201 }
202
203 Abc::IV3fArrayProperty getVelocitiesProperty() const
204 {
205 return m_velocitiesProperty;
206 }
207
208 Abc::IUInt64ArrayProperty getIdsProperty() const
209 {
210 return m_idsProperty;
211 }
212
213 IFloatGeomParam getWidthsParam() const
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
233 IGeomBaseSchema<PointsSchemaInfo>::reset();
234 }
235
238 bool valid() const
239 {
240 return ( IGeomBaseSchema<PointsSchemaInfo>::valid() &&
241 m_positionsProperty.valid() &&
242 m_idsProperty.valid() );
243 }
244
247 ALEMBIC_OVERRIDE_OPERATOR_BOOL( IPointsSchema::valid() );
248
249 protected:
250 void init( const Abc::Argument &iArg0,
251 const Abc::Argument &iArg1 );
252
253 Abc::IP3fArrayProperty m_positionsProperty;
254 Abc::IUInt64ArrayProperty m_idsProperty;
255 Abc::IV3fArrayProperty m_velocitiesProperty;
256 IFloatGeomParam m_widthsParam;
257};
258
259//-*****************************************************************************
260 typedef Abc::ISchemaObject<IPointsSchema> IPoints;
261
262 typedef Util::shared_ptr< IPoints > IPointsPtr;
263
264} // End namespace ALEMBIC_VERSION_NS
265
266 using namespace ALEMBIC_VERSION_NS;
267
268} // End namespace AbcGeom
269} // End namespace Alembic
270
271#endif
Foundation.h
SchemaInfoDeclarations.h
ALEMBIC_ABC_SAFE_CALL_END
#define ALEMBIC_ABC_SAFE_CALL_END()
Definition ErrorHandler.h:198
ALEMBIC_ABC_SAFE_CALL_BEGIN
#define ALEMBIC_ABC_SAFE_CALL_BEGIN(CONTEXT)
Definition ErrorHandler.h:172
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition Export.h:51
IGeomBase.h
IGeomParam.h
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema::reset
virtual void reset()
Definition IGeomBase.h:147
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< PointsSchemaInfo >::m_selfBoundsProperty
Abc::IBox3dProperty m_selfBoundsProperty
Definition IGeomBase.h:183
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema::valid
virtual bool valid() const
Definition IGeomBase.h:156
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< PointsSchemaInfo >::IGeomBaseSchema
IGeomBaseSchema()
Definition IGeomBase.h:76
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample
Definition IPoints.h:55
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::getVelocities
Abc::V3fArraySamplePtr getVelocities() const
Definition IPoints.h:64
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::reset
void reset()
Definition IPoints.h:73
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::getSelfBounds
Abc::Box3d getSelfBounds() const
Definition IPoints.h:66
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::getPositions
Abc::P3fArraySamplePtr getPositions() const
Definition IPoints.h:62
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::getIds
Abc::UInt64ArraySamplePtr getIds() const
Definition IPoints.h:63
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::valid
bool valid() const
Definition IPoints.h:68
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::m_velocities
Abc::V3fArraySamplePtr m_velocities
Definition IPoints.h:87
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::Sample
Sample()
Definition IPoints.h:60
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::m_positions
Abc::P3fArraySamplePtr m_positions
Definition IPoints.h:85
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::this_type
Sample this_type
Definition IPoints.h:57
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::IPointsSchema
friend class IPointsSchema
Definition IPoints.h:84
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::ALEMBIC_OPERATOR_BOOL
ALEMBIC_OPERATOR_BOOL(valid())
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::m_selfBounds
Abc::Box3d m_selfBounds
Definition IPoints.h:89
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::Sample::m_ids
Abc::UInt64ArraySamplePtr m_ids
Definition IPoints.h:86
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::getPositionsProperty
Abc::IP3fArrayProperty getPositionsProperty() const
Definition IPoints.h:198
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::this_type
IPointsSchema this_type
Definition IPoints.h:98
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::IPointsSchema
IPointsSchema(const IPointsSchema &iCopy)
Copy constructor.
Definition IPoints.h:137
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::getNumSamples
size_t getNumSamples() const
Default assignment operator used.
Definition IPoints.h:153
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::ALEMBIC_OVERRIDE_OPERATOR_BOOL
ALEMBIC_OVERRIDE_OPERATOR_BOOL(IPointsSchema::valid())
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::reset
void reset()
Definition IPoints.h:226
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::IPointsSchema
IPointsSchema(const ICompoundProperty &iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition IPoints.h:114
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::valid
bool valid() const
Definition IPoints.h:238
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::m_idsProperty
Abc::IUInt64ArrayProperty m_idsProperty
Definition IPoints.h:254
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::getWidthsParam
IFloatGeomParam getWidthsParam() const
Definition IPoints.h:213
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::getTimeSampling
AbcA::TimeSamplingPtr getTimeSampling() const
Definition IPoints.h:163
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::init
void init(const Abc::Argument &iArg0, const Abc::Argument &iArg1)
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::get
void get(Sample &oSample, const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
Definition IPoints.h:173
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::m_widthsParam
IFloatGeomParam m_widthsParam
Definition IPoints.h:256
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::getValue
Sample getValue(const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
Definition IPoints.h:191
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::m_positionsProperty
Abc::IP3fArrayProperty m_positionsProperty
Definition IPoints.h:253
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::isConstant
bool isConstant() const
Definition IPoints.h:159
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::getVelocitiesProperty
Abc::IV3fArrayProperty getVelocitiesProperty() const
Definition IPoints.h:203
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::m_velocitiesProperty
Abc::IV3fArrayProperty m_velocitiesProperty
Definition IPoints.h:255
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::IPointsSchema
IPointsSchema()
Definition IPoints.h:106
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::getIdsProperty
Abc::IUInt64ArrayProperty getIdsProperty() const
Definition IPoints.h:208
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::IPointsSchema
IPointsSchema(const ICompoundProperty iProp, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition IPoints.h:128
Alembic::Abc::ALEMBIC_VERSION_NS::Argument
Definition Argument.h:120
Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >::getObject
IObject getObject() const
Definition IBaseProperty.h:207
Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
Definition ICompoundProperty.h:53
Alembic::Abc::ALEMBIC_VERSION_NS::ISampleSelector
Definition ISampleSelector.h:49
Alembic::Abc::ALEMBIC_VERSION_NS::ISchemaObject
Definition ISchemaObject.h:56
Alembic::AbcGeom::ALEMBIC_VERSION_NS
Definition ArchiveBounds.h:45
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsPtr
Util::shared_ptr< IPoints > IPointsPtr
Definition IPoints.h:262
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPoints
Abc::ISchemaObject< IPointsSchema > IPoints
Definition IPoints.h:260
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IFloatGeomParam
ITypedGeomParam< Float32TPTraits > IFloatGeomParam
Definition IGeomParam.h:513
Alembic::AbcGeom
Definition ArchiveBounds.h:44
Alembic::Abc::ALEMBIC_VERSION_NS::IP3fArrayProperty
ITypedArrayProperty< P3fTPTraits > IP3fArrayProperty
Definition ITypedArrayProperty.h:247
Alembic::Abc::ALEMBIC_VERSION_NS::UInt64ArraySamplePtr
Alembic::Util::shared_ptr< UInt64ArraySample > UInt64ArraySamplePtr
Definition TypedArraySample.h:225
Alembic::Abc::ALEMBIC_VERSION_NS::V3fArraySamplePtr
Alembic::Util::shared_ptr< V3fArraySample > V3fArraySamplePtr
Definition TypedArraySample.h:240
Alembic::Abc::ALEMBIC_VERSION_NS::IV3fArrayProperty
ITypedArrayProperty< V3fTPTraits > IV3fArrayProperty
Definition ITypedArrayProperty.h:237
Alembic::Abc::ALEMBIC_VERSION_NS::P3fArraySamplePtr
Alembic::Util::shared_ptr< P3fArraySample > P3fArraySamplePtr
Definition TypedArraySample.h:250
Alembic::Abc::ALEMBIC_VERSION_NS::IUInt64ArrayProperty
ITypedArrayProperty< Uint64TPTraits > IUInt64ArrayProperty
Definition ITypedArrayProperty.h:222
Alembic
Alembic namespace ...
Definition ArchiveInfo.h:46