HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 
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;
88 
90  };
91 
92  //-*************************************************************************
93  // POINTS SCHEMA
94  //-*************************************************************************
95 public:
96  //! By convention we always define this_type in AbcGeom classes.
97  //! Used by unspecified-bool-type conversion below
99 
100  //-*************************************************************************
101  // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
102  //-*************************************************************************
103 
104  //! The default constructor creates an empty OPointsSchema
105  //! ...
107 
108  //! This templated, explicit function creates a new scalar property reader.
109  //! The first argument is any Abc (or AbcCoreAbstract) object
110  //! which can intrusively be converted to an CompoundPropertyReaderPtr
111  //! to use as a parent, from which the error handler policy for
112  //! inheritance is also derived. The remaining optional arguments
113  //! can be used to override the ErrorHandlerPolicy, to specify
114  //! MetaData, and to set TimeSamplingType.
115  template <class CPROP_PTR>
116  IPointsSchema( CPROP_PTR iParent,
117  const std::string &iName,
118 
119  const Abc::Argument &iArg0 = Abc::Argument(),
120  const Abc::Argument &iArg1 = Abc::Argument() )
121  : IGeomBaseSchema<PointsSchemaInfo>( iParent, iName,
122  iArg0, iArg1 )
123  {
124  init( iArg0, iArg1 );
125  }
126 
127  //! This constructor is the same as above, but with default
128  //! schema name used.
129  template <class CPROP_PTR>
130  explicit IPointsSchema( CPROP_PTR iParent,
131  const Abc::Argument &iArg0 = Abc::Argument(),
132  const Abc::Argument &iArg1 = Abc::Argument() )
133  : IGeomBaseSchema<PointsSchemaInfo>( iParent,
134  iArg0, iArg1 )
135  {
136  init( iArg0, iArg1 );
137  }
138 
139  //! Copy constructor.
141  : IGeomBaseSchema<PointsSchemaInfo>()
142  {
143  *this = iCopy;
144  }
145 
146  //! Default assignment operator used.
147 
148  //-*************************************************************************
149  // SCALAR PROPERTY READER FUNCTIONALITY
150  //-*************************************************************************
151 
152  //! Return the number of samples contained in the property.
153  //! This can be any number, including zero.
154  //! This returns the number of samples that were written, independently
155  //! of whether or not they were constant.
156  size_t getNumSamples() const
157  { return std::max( m_positionsProperty.getNumSamples(),
158  m_idsProperty.getNumSamples() ); }
159 
160  //! Ask if we're constant - no change in value amongst samples,
161  //! regardless of the time sampling.
162  bool isConstant() const { return m_positionsProperty.isConstant() && m_idsProperty.isConstant(); }
163 
164  //! Time sampling Information.
165  //!
167  {
168  if ( m_positionsProperty.valid() )
169  {
170  return m_positionsProperty.getTimeSampling();
171  }
172  return getObject().getArchive().getTimeSampling(0);
173  }
174 
175  //-*************************************************************************
176  void get( Sample &oSample,
177  const Abc::ISampleSelector &iSS = Abc::ISampleSelector() ) const
178  {
179  ALEMBIC_ABC_SAFE_CALL_BEGIN( "IPointsSchema::get()" );
180 
181  m_positionsProperty.get( oSample.m_positions, iSS );
182  m_idsProperty.get( oSample.m_ids, iSS );
183 
184  m_selfBoundsProperty.get( oSample.m_selfBounds, iSS );
185 
186  if ( m_velocitiesProperty && m_velocitiesProperty.getNumSamples() > 0 )
187  { m_velocitiesProperty.get( oSample.m_velocities, iSS ); }
188 
189  // Could error check here.
190 
192  }
193 
195  {
196  Sample smp;
197  get( smp, iSS );
198  return smp;
199  }
200 
202  {
203  return m_positionsProperty;
204  }
205 
207  {
208  return m_velocitiesProperty;
209  }
210 
212  {
213  return m_idsProperty;
214  }
215 
217  {
218  return m_widthsParam;
219  }
220 
221  //-*************************************************************************
222  // ABC BASE MECHANISMS
223  // These functions are used by Abc to deal with errors, rewrapping,
224  // and so on.
225  //-*************************************************************************
226 
227  //! Reset returns this function set to an empty, default
228  //! state.
229  void reset()
230  {
231  m_positionsProperty.reset();
232  m_velocitiesProperty.reset();
233  m_idsProperty.reset();
234  m_widthsParam.reset();
235 
237  }
238 
239  //! Valid returns whether this function set is
240  //! valid.
241  bool valid() const
242  {
244  m_positionsProperty.valid() &&
245  m_idsProperty.valid() );
246  }
247 
248  //! unspecified-bool-type operator overload.
249  //! ...
251 
252 protected:
253  void init( const Abc::Argument &iArg0,
254  const Abc::Argument &iArg1 );
255 
260 };
261 
262 //-*****************************************************************************
264 
265 typedef Util::shared_ptr< IPoints > IPointsPtr;
266 
267 } // End namespace ALEMBIC_VERSION_NS
268 
269 using namespace ALEMBIC_VERSION_NS;
270 
271 } // End namespace AbcGeom
272 } // End namespace Alembic
273 
274 #endif
#define ALEMBIC_OPERATOR_BOOL(PASS_COND)
Definition: OperatorBool.h:42
Alembic::Util::shared_ptr< UInt64ArraySample > UInt64ArraySamplePtr
Abc::UInt64ArraySamplePtr getIds() const
Definition: IPoints.h:63
IPointsSchema(CPROP_PTR iParent, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition: IPoints.h:130
Alembic::Util::shared_ptr< V3fArraySample > V3fArraySamplePtr
Util::shared_ptr< IPoints > IPointsPtr
Definition: IPoints.h:265
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
Abc::IUInt64ArrayProperty getIdsProperty() const
Definition: IPoints.h:211
const hboost::disable_if_c< VecTraits< T >::IsVec, T >::type & max(const T &a, const T &b)
Definition: Composite.h:132
Abc::ISchemaObject< IPointsSchema > IPoints
Definition: IPoints.h:263
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
Abc::IV3fArrayProperty getVelocitiesProperty() const
Definition: IPoints.h:206
IPointsSchema(CPROP_PTR iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
Definition: IPoints.h:116
#define ALEMBIC_OVERRIDE_OPERATOR_BOOL(PASS_COND)
Definition: OperatorBool.h:56
#define ALEMBIC_ABC_SAFE_CALL_BEGIN(CONTEXT)
Definition: ErrorHandler.h:172
IPointsSchema(const IPointsSchema &iCopy)
Copy constructor.
Definition: IPoints.h:140
Box< V3d > Box3d
Definition: ImathBox.h:139
#define ALEMBIC_ABC_SAFE_CALL_END()
Definition: ErrorHandler.h:198
AbcA::TimeSamplingPtr getTimeSampling() const
Definition: IPoints.h:166
size_t getNumSamples() const
Default assignment operator used.
Definition: IPoints.h:156
Sample getValue(const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
Definition: IPoints.h:194
#define ALEMBIC_EXPORT
Definition: Export.h:51
Abc::IP3fArrayProperty getPositionsProperty() const
Definition: IPoints.h:201
Alembic::Util::shared_ptr< P3fArraySample > P3fArraySamplePtr
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:104