Field3D
MatrixFieldMapping Class Reference

Represents the mapping of a field by a matrix transform. More...

#include <FieldMapping.h>

Inheritance diagram for MatrixFieldMapping:
FieldMapping RefBase

Public Types

typedef MatrixFieldMapping class_type
 
typedef Curve< Imath::M44dMatrixCurve
 Time-varying matrix. More...
 
typedef boost::intrusive_ptr< MatrixFieldMappingPtr
 Convenience typedef. More...
 
- Public Types inherited from FieldMapping
typedef FieldMapping class_type
 
typedef boost::intrusive_ptr< FieldMappingPtr
 
- Public Types inherited from RefBase
typedef boost::intrusive_ptr< RefBasePtr
 

Public Member Functions

const M44dlocalToWorld () const
 Returns a reference to the local to world transform. More...
 
const MatrixCurve::SampleVeclocalToWorldSamples () const
 Returns a vector of all motion samples for local to world transform. More...
 
void makeIdentity ()
 Sets the transform to identity. This makes it functionally equivalent to a NullFieldMapping. More...
 
void setLocalToWorld (const M44d &lsToWs)
 Sets the local to world transform. All other matrices will be updated based on this. More...
 
void setLocalToWorld (float t, const M44d &lsToWs)
 Sets the local to world transform at a given time. More...
 
const M44dvoxelToWorld () const
 Returns a reference to the voxel to world space transform. More...
 
const M44dworldToVoxel () const
 Returns a reference to the world to voxel space transform. More...
 
Constructors & destructor
 MatrixFieldMapping ()
 
 MatrixFieldMapping (const Box3i &extents)
 
From FieldMapping
virtual void worldToVoxel (const V3d &wsP, V3d &vsP) const
 Transform from world space position into voxel space. More...
 
virtual void worldToVoxel (const V3d &wsP, V3d &vsP, float time) const
 
virtual void voxelToWorld (const V3d &vsP, V3d &wsP) const
 Transform from voxel space position into world space. More...
 
virtual void voxelToWorld (const V3d &vsP, V3d &wsP, float time) const
 
virtual void worldToLocal (const V3d &wsP, V3d &lsP) const
 Transform from world space position into local space. More...
 
virtual void worldToLocal (const V3d &wsP, V3d &lsP, float time) const
 
virtual void localToWorld (const V3d &lsP, V3d &wsP) const
 Transform from local space position into world space. More...
 
virtual void localToWorld (const V3d &lsP, V3d &wsP, float time) const
 
void worldToVoxelDir (const V3d &wsV, V3d &vsV) const
 
void voxelToWorldDir (const V3d &vsV, V3d &wsV) const
 
void worldToLocalDir (const V3d &wsV, V3d &lsV) const
 
void localToWorldDir (const V3d &lsV, V3d &wsV) const
 
virtual void extentsChanged ()
 Implement this if the subclass needs to update itself when the resolution changes. More...
 
virtual std::string className () const
 Returns the FieldMapping type name. Used when writing/reading from disk. More...
 
virtual bool isIdentical (FieldMapping::Ptr other, double tolerance=0.0) const
 Whether the mapping is identical to another mapping. More...
 
virtual V3d wsVoxelSize (int, int, int) const
 Returns world-space size of a voxel at the specified coordinate. More...
 
virtual FieldMapping::Ptr clone () const
 Returns a pointer to a copy of the mapping, pure virtual so ensure derived classes properly implement it. More...
 
- Public Member Functions inherited from FieldMapping
const V3dorigin () const
 Returns the origin. More...
 
const V3dresolution () const
 Returns the resolution. More...
 
void setExtents (const Box3i &extents)
 This sets the field extents information to use for defining the local coordinate space. More...
 
 FieldMapping ()
 Constructor. More...
 
 FieldMapping (const Box3i &extents)
 Construct with known extents. More...
 
virtual ~FieldMapping ()
 Destructor. More...
 
void localToVoxel (const V3d &lsP, V3d &vsP) const
 Transform from local space to voxel space. This is just a multiplication by the resolution of the Field that we're mapping. More...
 
void voxelToLocal (const V3d &vsP, V3d &lsP) const
 Inverse of localToVoxel. More...
 
- Public Member Functions inherited from RefBase
void ref () const
 Used by boost::intrusive_pointer. More...
 
size_t refcnt ()
 Used by boost::intrusive_pointer. More...
 
void unref () const
 Used by boost::intrusive_pointer. More...
 
 RefBase ()
 
 RefBase (const RefBase &)
 Copy constructor. More...
 
RefBaseoperator= (const RefBase &)
 Assignment operator. More...
 
virtual ~RefBase ()
 Destructor. More...
 
virtual bool checkRTTI (const char *typenameStr)=0
 This function is only implemented by concrete classes and triggers the actual RTTI check through matchRTTI();. More...
 
bool matchRTTI (const char *typenameStr)
 Performs a check to see if the given typename string matches this class' This needs to be implemented in -all- subclasses, even abstract ones. More...
 

Static Public Member Functions

static const char * classType ()
 
- Static Public Member Functions inherited from FieldMapping
static const char * classType ()
 
- Static Public Member Functions inherited from RefBase
static const char * classType ()
 

Public Attributes

 DEFINE_FIELD_RTTI_CONCRETE_CLASS
 
- Public Attributes inherited from FieldMapping
 DEFINE_FIELD_RTTI_ABSTRACT_CLASS
 

Private Types

typedef FieldMapping base
 Convenience typedef for referring to base class. More...
 

Private Member Functions

void getLocalToVoxelMatrix (M44d &result)
 
void updateTransform ()
 Updates the local to world transformation matrix. More...
 

Private Attributes

bool m_isTimeVarying
 Stores whether the curve has more than one time sample. More...
 
M44d m_lsToWs
 Local space to world space. More...
 
MatrixCurve m_lsToWsCurve
 Time-varying local to world space transform. More...
 
M44d m_vsToWs
 Voxel space to world space. More...
 
MatrixCurve m_vsToWsCurve
 Time-varying voxel to world space transform. More...
 
M44d m_wsToLs
 World space to local space. More...
 
M44d m_wsToVs
 World space to voxel space. More...
 
V3d m_wsVoxelSize
 Precomputed world-space voxel size. Calculations may assume orthogonal transformation for efficiency. More...
 

Additional Inherited Members

- Protected Attributes inherited from FieldMapping
V3d m_origin
 The integer voxel-space origin of the underlying Field object. Is equal to field.extents.min. More...
 
V3d m_res
 The integer voxel-space resolution of the underlying Field object. Is equal to field.extents.max - field.extents.min + 1. More...
 

Detailed Description

Represents the mapping of a field by a matrix transform.

Refer to using_mappings for examples of how to use this in your code.

Note
Regarding time-varying matrices. If setLocalToWorld(M44d) is called, an underlying Curve object is created with just one sample at time=0.0.
Todo:
Add calls for easily specifying the transform given grid size, offset, rotation, etc.

Definition at line 316 of file FieldMapping.h.

Member Typedef Documentation

◆ Ptr

typedef boost::intrusive_ptr<MatrixFieldMapping> MatrixFieldMapping::Ptr

Convenience typedef.

Definition at line 323 of file FieldMapping.h.

◆ MatrixCurve

Time-varying matrix.

Definition at line 325 of file FieldMapping.h.

◆ class_type

◆ base

Convenience typedef for referring to base class.

Definition at line 502 of file FieldMapping.h.

Constructor & Destructor Documentation

◆ MatrixFieldMapping() [1/2]

MatrixFieldMapping::MatrixFieldMapping ( )

Definition at line 196 of file FieldMapping.cpp.

References makeIdentity().

Referenced by clone().

197  : FieldMapping()
198 {
199  makeIdentity();
200 }
FieldMapping()
Constructor.
void makeIdentity()
Sets the transform to identity. This makes it functionally equivalent to a NullFieldMapping.

◆ MatrixFieldMapping() [2/2]

MatrixFieldMapping::MatrixFieldMapping ( const Box3i extents)

Definition at line 204 of file FieldMapping.cpp.

References makeIdentity().

205  : FieldMapping(extents)
206 {
207  makeIdentity();
208 }
FieldMapping()
Constructor.
void makeIdentity()
Sets the transform to identity. This makes it functionally equivalent to a NullFieldMapping.

Member Function Documentation

◆ classType()

static const char* MatrixFieldMapping::classType ( )
inlinestatic

Definition at line 332 of file FieldMapping.h.

Referenced by className().

333  {
334  return "MatrixFieldMapping";
335  }

◆ setLocalToWorld() [1/2]

void MatrixFieldMapping::setLocalToWorld ( const M44d lsToWs)

Sets the local to world transform. All other matrices will be updated based on this.

Note
This resets the Curve to contain just one sample at time=0.0

Definition at line 212 of file FieldMapping.cpp.

References m_lsToWsCurve, makeIdentity(), and Curve< T >::numSamples().

213 {
214  if (m_lsToWsCurve.numSamples() > 0) {
215  makeIdentity();
216  }
217  setLocalToWorld(0.0f, lsToWs);
218 }
void setLocalToWorld(const M44d &lsToWs)
Sets the local to world transform. All other matrices will be updated based on this.
size_t numSamples() const
Returns the number of samples in the curve.
Definition: Curve.h:99
MatrixCurve m_lsToWsCurve
Time-varying local to world space transform.
Definition: FieldMapping.h:487
void makeIdentity()
Sets the transform to identity. This makes it functionally equivalent to a NullFieldMapping.

◆ setLocalToWorld() [2/2]

void MatrixFieldMapping::setLocalToWorld ( float  t,
const M44d lsToWs 
)

Sets the local to world transform at a given time.

Definition at line 222 of file FieldMapping.cpp.

References Curve< T >::addSample(), m_lsToWsCurve, and updateTransform().

223 {
224  m_lsToWsCurve.addSample(t, lsToWs);
225  updateTransform();
226 }
MatrixCurve m_lsToWsCurve
Time-varying local to world space transform.
Definition: FieldMapping.h:487
void addSample(const float t, const T &value)
Adds a sample point to the curve.
Definition: Curve.h:172
void updateTransform()
Updates the local to world transformation matrix.

◆ localToWorld() [1/3]

const M44d& MatrixFieldMapping::localToWorld ( ) const
inline

Returns a reference to the local to world transform.

Note
This assumes the query to be at time=0.0

Definition at line 358 of file FieldMapping.h.

Referenced by convertCellCenteredToMAC(), and convertMACToCellCentered().

359  { return m_lsToWs; }
M44d m_lsToWs
Local space to world space.
Definition: FieldMapping.h:475

◆ worldToVoxel() [1/3]

const M44d& MatrixFieldMapping::worldToVoxel ( ) const
inline

Returns a reference to the world to voxel space transform.

Note
This assumes the query to be at time=0.0

Definition at line 363 of file FieldMapping.h.

364  { return m_wsToVs; }
M44d m_wsToVs
World space to voxel space.
Definition: FieldMapping.h:484

◆ voxelToWorld() [1/3]

const M44d& MatrixFieldMapping::voxelToWorld ( ) const
inline

Returns a reference to the voxel to world space transform.

Note
This assumes the query to be at time=0.0

Definition at line 368 of file FieldMapping.h.

369  { return m_vsToWs; }
M44d m_vsToWs
Voxel space to world space.
Definition: FieldMapping.h:481

◆ localToWorldSamples()

const MatrixCurve::SampleVec& MatrixFieldMapping::localToWorldSamples ( ) const
inline

Returns a vector of all motion samples for local to world transform.

Definition at line 372 of file FieldMapping.h.

373  { return m_lsToWsCurve.samples(); }
MatrixCurve m_lsToWsCurve
Time-varying local to world space transform.
Definition: FieldMapping.h:487
const SampleVec & samples() const
Returns a const reference to the samples in the curve.
Definition: Curve.h:103

◆ makeIdentity()

void MatrixFieldMapping::makeIdentity ( )

Sets the transform to identity. This makes it functionally equivalent to a NullFieldMapping.

Definition at line 230 of file FieldMapping.cpp.

References Curve< T >::clear(), m_lsToWsCurve, and updateTransform().

Referenced by MatrixFieldMapping(), and setLocalToWorld().

231 {
233  updateTransform();
234 }
MatrixCurve m_lsToWsCurve
Time-varying local to world space transform.
Definition: FieldMapping.h:487
void updateTransform()
Updates the local to world transformation matrix.
void clear()
Clears all samples in curve.
Definition: Curve.h:107

◆ worldToVoxel() [2/3]

virtual void MatrixFieldMapping::worldToVoxel ( const V3d wsP,
V3d vsP 
) const
inlinevirtual

Transform from world space position into voxel space.

Implements FieldMapping.

Definition at line 384 of file FieldMapping.h.

385  { m_wsToVs.multVecMatrix(wsP, vsP); }
M44d m_wsToVs
World space to voxel space.
Definition: FieldMapping.h:484

◆ worldToVoxel() [3/3]

virtual void MatrixFieldMapping::worldToVoxel ( const V3d wsP,
V3d vsP,
float  time 
) const
inlinevirtual

Implements FieldMapping.

Definition at line 386 of file FieldMapping.h.

387  {
388  if (!m_isTimeVarying) {
389  m_wsToVs.multVecMatrix(wsP, vsP);
390  } else {
391  M44d wsToVs = m_vsToWsCurve.linear(time).inverse();
392  wsToVs.multVecMatrix(wsP, vsP);
393  }
394  }
T linear(const float t) const
Linearly interpolates a value from the curve.
Definition: Curve.h:199
Imath::M44d M44d
Definition: SpiMathLib.h:82
MatrixCurve m_vsToWsCurve
Time-varying voxel to world space transform.
Definition: FieldMapping.h:489
bool m_isTimeVarying
Stores whether the curve has more than one time sample.
Definition: FieldMapping.h:493
M44d m_wsToVs
World space to voxel space.
Definition: FieldMapping.h:484

◆ voxelToWorld() [2/3]

virtual void MatrixFieldMapping::voxelToWorld ( const V3d vsP,
V3d wsP 
) const
inlinevirtual

Transform from voxel space position into world space.

Implements FieldMapping.

Definition at line 396 of file FieldMapping.h.

397  { m_vsToWs.multVecMatrix(vsP, wsP); }
M44d m_vsToWs
Voxel space to world space.
Definition: FieldMapping.h:481

◆ voxelToWorld() [3/3]

virtual void MatrixFieldMapping::voxelToWorld ( const V3d vsP,
V3d wsP,
float  time 
) const
inlinevirtual

Implements FieldMapping.

Definition at line 398 of file FieldMapping.h.

399  {
400  if (!m_isTimeVarying) {
401  m_vsToWs.multVecMatrix(vsP, wsP);
402  } else {
403  M44d vsToWs = m_vsToWsCurve.linear(time);
404  vsToWs.multVecMatrix(vsP, wsP);
405  }
406  }
T linear(const float t) const
Linearly interpolates a value from the curve.
Definition: Curve.h:199
Imath::M44d M44d
Definition: SpiMathLib.h:82
M44d m_vsToWs
Voxel space to world space.
Definition: FieldMapping.h:481
MatrixCurve m_vsToWsCurve
Time-varying voxel to world space transform.
Definition: FieldMapping.h:489
bool m_isTimeVarying
Stores whether the curve has more than one time sample.
Definition: FieldMapping.h:493

◆ worldToLocal() [1/2]

virtual void MatrixFieldMapping::worldToLocal ( const V3d wsP,
V3d lsP 
) const
inlinevirtual

Transform from world space position into local space.

Implements FieldMapping.

Definition at line 408 of file FieldMapping.h.

409  { m_wsToLs.multVecMatrix(wsP, lsP); }
M44d m_wsToLs
World space to local space.
Definition: FieldMapping.h:478

◆ worldToLocal() [2/2]

virtual void MatrixFieldMapping::worldToLocal ( const V3d wsP,
V3d lsP,
float  time 
) const
inlinevirtual

Implements FieldMapping.

Definition at line 410 of file FieldMapping.h.

412  {
413  if (!m_isTimeVarying) {
414  m_wsToLs.multVecMatrix(wsP, lsP);
415  } else {
416  M44d wsToLs = m_lsToWsCurve.linear(time).inverse();
417  wsToLs.multVecMatrix(wsP, lsP);
418  }
419  }
T linear(const float t) const
Linearly interpolates a value from the curve.
Definition: Curve.h:199
Imath::M44d M44d
Definition: SpiMathLib.h:82
MatrixCurve m_lsToWsCurve
Time-varying local to world space transform.
Definition: FieldMapping.h:487
bool m_isTimeVarying
Stores whether the curve has more than one time sample.
Definition: FieldMapping.h:493
M44d m_wsToLs
World space to local space.
Definition: FieldMapping.h:478

◆ localToWorld() [2/3]

virtual void MatrixFieldMapping::localToWorld ( const V3d lsP,
V3d wsP 
) const
inlinevirtual

Transform from local space position into world space.

Implements FieldMapping.

Definition at line 421 of file FieldMapping.h.

422  { m_lsToWs.multVecMatrix(lsP, wsP); }
M44d m_lsToWs
Local space to world space.
Definition: FieldMapping.h:475

◆ localToWorld() [3/3]

virtual void MatrixFieldMapping::localToWorld ( const V3d lsP,
V3d wsP,
float  time 
) const
inlinevirtual

Implements FieldMapping.

Definition at line 423 of file FieldMapping.h.

424  {
425  if (!m_isTimeVarying) {
426  m_lsToWs.multVecMatrix(lsP, wsP);
427  } else {
428  M44d lsToWs = m_lsToWsCurve.linear(time);
429  lsToWs.multVecMatrix(lsP, wsP);
430  }
431  }
T linear(const float t) const
Linearly interpolates a value from the curve.
Definition: Curve.h:199
Imath::M44d M44d
Definition: SpiMathLib.h:82
MatrixCurve m_lsToWsCurve
Time-varying local to world space transform.
Definition: FieldMapping.h:487
M44d m_lsToWs
Local space to world space.
Definition: FieldMapping.h:475
bool m_isTimeVarying
Stores whether the curve has more than one time sample.
Definition: FieldMapping.h:493

◆ worldToVoxelDir()

void MatrixFieldMapping::worldToVoxelDir ( const V3d wsV,
V3d vsV 
) const
inline
Todo:
Generalize and make time-dependent.

Definition at line 434 of file FieldMapping.h.

435  { m_wsToVs.multDirMatrix(wsV, vsV); }
M44d m_wsToVs
World space to voxel space.
Definition: FieldMapping.h:484

◆ voxelToWorldDir()

void MatrixFieldMapping::voxelToWorldDir ( const V3d vsV,
V3d wsV 
) const
inline
Todo:
Generalize and make time-dependent.

Definition at line 438 of file FieldMapping.h.

439  { m_vsToWs.multDirMatrix(vsV, wsV); }
M44d m_vsToWs
Voxel space to world space.
Definition: FieldMapping.h:481

◆ worldToLocalDir()

void MatrixFieldMapping::worldToLocalDir ( const V3d wsV,
V3d lsV 
) const
inline
Todo:
Generalize and make time-dependent.

Definition at line 442 of file FieldMapping.h.

443  { m_wsToLs.multDirMatrix(wsV, lsV); }
M44d m_wsToLs
World space to local space.
Definition: FieldMapping.h:478

◆ localToWorldDir()

void MatrixFieldMapping::localToWorldDir ( const V3d lsV,
V3d wsV 
) const
inline
Todo:
Generalize and make time-dependent.

Definition at line 446 of file FieldMapping.h.

References FieldMapping::className(), FieldMapping::extentsChanged(), and FieldMapping::isIdentical().

447  { m_lsToWs.multDirMatrix(lsV, wsV); }
M44d m_lsToWs
Local space to world space.
Definition: FieldMapping.h:475

◆ extentsChanged()

void MatrixFieldMapping::extentsChanged ( )
virtual

Implement this if the subclass needs to update itself when the resolution changes.

Reimplemented from FieldMapping.

Definition at line 238 of file FieldMapping.cpp.

References updateTransform().

239 {
240  updateTransform();
241 }
void updateTransform()
Updates the local to world transformation matrix.

◆ className()

std::string MatrixFieldMapping::className ( ) const
virtual

Returns the FieldMapping type name. Used when writing/reading from disk.

Implements FieldMapping.

Definition at line 245 of file FieldMapping.cpp.

References classType().

246 {
247  return std::string(classType());
248 }
static const char * classType()
Definition: FieldMapping.h:332

◆ isIdentical()

bool MatrixFieldMapping::isIdentical ( FieldMapping::Ptr  other,
double  tolerance = 0.0 
) const
virtual

Whether the mapping is identical to another mapping.

Implements FieldMapping.

Definition at line 252 of file FieldMapping.cpp.

References FIELD3D_NAMESPACE_OPEN::checkMatricesIdentical(), FIELD3D_NAMESPACE_OPEN::k_matrixMappingName(), m_lsToWsCurve, m_vsToWsCurve, and Curve< T >::samples().

254 {
256 
257  if (other->className() != k_matrixMappingName) {
258  return false;
259  } else {
260 
262  FIELD_DYNAMIC_CAST<MatrixFieldMapping>(other);
263 
264  if (mm) {
265 
266  const SampleVec lsToWs1 = m_lsToWsCurve.samples();
267  const SampleVec lsToWs2 = mm->m_lsToWsCurve.samples();
268  const SampleVec vsToWs1 = m_vsToWsCurve.samples();
269  const SampleVec vsToWs2 = mm->m_vsToWsCurve.samples();
270 
271  size_t numSamples = lsToWs1.size();
272 
273  // First check if time sample counts differ
274  // lsToWs and vsToWs are guaranteed to have same sample count.
275  if (lsToWs1.size() != lsToWs2.size()) {
276  return false;
277  }
278 
279  // Then check if all time samples match, then check localToWorld
280  // and voxelToWorld matrices
281  for (size_t i = 0; i < numSamples; ++i) {
282  if (lsToWs1[i].first != lsToWs2[i].first) {
283  return false;
284  }
285  if (!checkMatricesIdentical(lsToWs1[i].second, lsToWs2[i].second,
286  tolerance)) {
287  return false;
288  }
289  if (!checkMatricesIdentical(vsToWs1[i].second, vsToWs2[i].second,
290  tolerance)) {
291  return false;
292  }
293  }
294 
295  return true;
296 
297  } else {
298  return false;
299  }
300  }
301  return false;
302 }
const string k_matrixMappingName("MatrixFieldMapping")
MatrixCurve m_vsToWsCurve
Time-varying voxel to world space transform.
Definition: FieldMapping.h:489
MatrixCurve m_lsToWsCurve
Time-varying local to world space transform.
Definition: FieldMapping.h:487
const SampleVec & samples() const
Returns a const reference to the samples in the curve.
Definition: Curve.h:103
std::vector< Sample > SampleVec
Definition: Curve.h:85
boost::intrusive_ptr< MatrixFieldMapping > Ptr
Convenience typedef.
Definition: FieldMapping.h:323
bool checkMatricesIdentical(const Matrix_T &m1, const Matrix_T &m2, double tolerance)

◆ wsVoxelSize()

virtual V3d MatrixFieldMapping::wsVoxelSize ( int  i,
int  j,
int  k 
) const
inlinevirtual

Returns world-space size of a voxel at the specified coordinate.

Implements FieldMapping.

Definition at line 456 of file FieldMapping.h.

References FieldMapping::clone().

457  { return m_wsVoxelSize; }
V3d m_wsVoxelSize
Precomputed world-space voxel size. Calculations may assume orthogonal transformation for efficiency...
Definition: FieldMapping.h:497

◆ clone()

FieldMapping::Ptr MatrixFieldMapping::clone ( ) const
virtual

Returns a pointer to a copy of the mapping, pure virtual so ensure derived classes properly implement it.

Implements FieldMapping.

Definition at line 357 of file FieldMapping.cpp.

References MatrixFieldMapping().

358 {
359  return Ptr(new MatrixFieldMapping(*this));
360 }
boost::intrusive_ptr< MatrixFieldMapping > Ptr
Convenience typedef.
Definition: FieldMapping.h:323

◆ updateTransform()

void MatrixFieldMapping::updateTransform ( )
private

Updates the local to world transformation matrix.

Definition at line 306 of file FieldMapping.cpp.

References Curve< T >::addSample(), Curve< T >::clear(), getLocalToVoxelMatrix(), Curve< T >::linear(), m_isTimeVarying, m_lsToWs, m_lsToWsCurve, m_vsToWs, m_vsToWsCurve, m_wsToLs, m_wsToVs, m_wsVoxelSize, Curve< T >::numSamples(), and Curve< T >::samples().

Referenced by extentsChanged(), makeIdentity(), and setLocalToWorld().

307 {
308  typedef MatrixCurve::SampleVec::const_iterator SampleIter;
309 
310  // Build the voxel to world space transforms ---
311  M44d lsToVs;
312  getLocalToVoxelMatrix(lsToVs);
313  M44d vsToLs = lsToVs.inverse();
314  // Loop over all samples in lsToWs, append vsToLs and create new curve
315  // Also handle the special case where lsToWs has no samples. In that
316  // case m_vsToWsCurve still has to have one sample.
317  const MatrixCurve::SampleVec &lsToWs = m_lsToWsCurve.samples();
319  for (SampleIter i = lsToWs.begin(), end = lsToWs.end(); i != end; i++) {
320  m_vsToWsCurve.addSample(i->first, vsToLs * i->second);
321  }
322 
323  // See if the curve has more than just a single sample
325 
326  // Sample the time-varying transforms at time=0.0
328  m_wsToLs = m_lsToWs.inverse();
329  m_vsToWs = vsToLs * m_lsToWs;
330  m_wsToVs = m_vsToWs.inverse();
331 
332  // Precompute the voxel size
333  V3d voxelOrigin, nextVoxel;
334  m_vsToWs.multVecMatrix(V3d(0, 0, 0), voxelOrigin);
335  m_vsToWs.multVecMatrix(V3d(1, 0, 0), nextVoxel);
336  m_wsVoxelSize.x = (nextVoxel - voxelOrigin).length();
337  m_vsToWs.multVecMatrix(V3d(0, 1, 0), nextVoxel);
338  m_wsVoxelSize.y = (nextVoxel - voxelOrigin).length();
339  m_vsToWs.multVecMatrix(V3d(0, 0, 1), nextVoxel);
340  m_wsVoxelSize.z = (nextVoxel - voxelOrigin).length();
341 }
T linear(const float t) const
Linearly interpolates a value from the curve.
Definition: Curve.h:199
Imath::M44d M44d
Definition: SpiMathLib.h:82
M44d m_vsToWs
Voxel space to world space.
Definition: FieldMapping.h:481
MatrixCurve m_vsToWsCurve
Time-varying voxel to world space transform.
Definition: FieldMapping.h:489
size_t numSamples() const
Returns the number of samples in the curve.
Definition: Curve.h:99
MatrixCurve m_lsToWsCurve
Time-varying local to world space transform.
Definition: FieldMapping.h:487
M44d m_lsToWs
Local space to world space.
Definition: FieldMapping.h:475
const SampleVec & samples() const
Returns a const reference to the samples in the curve.
Definition: Curve.h:103
void addSample(const float t, const T &value)
Adds a sample point to the curve.
Definition: Curve.h:172
Imath::V3d V3d
Definition: SpiMathLib.h:74
void getLocalToVoxelMatrix(M44d &result)
bool m_isTimeVarying
Stores whether the curve has more than one time sample.
Definition: FieldMapping.h:493
std::vector< Sample > SampleVec
Definition: Curve.h:85
V3d m_wsVoxelSize
Precomputed world-space voxel size. Calculations may assume orthogonal transformation for efficiency...
Definition: FieldMapping.h:497
void clear()
Clears all samples in curve.
Definition: Curve.h:107
M44d m_wsToLs
World space to local space.
Definition: FieldMapping.h:478
M44d m_wsToVs
World space to voxel space.
Definition: FieldMapping.h:484

◆ getLocalToVoxelMatrix()

void MatrixFieldMapping::getLocalToVoxelMatrix ( M44d result)
private
Todo:
Unit test this

Definition at line 345 of file FieldMapping.cpp.

References FieldMapping::m_origin, and FieldMapping::m_res.

Referenced by updateTransform().

346 {
347  // Local to voxel is a scale by the resolution of the field, offset
348  // to the origin of the extents
349  M44d scaling, translation;
350  scaling.setScale(m_res);
351  translation.setTranslation(m_origin);
352  result = scaling * translation;
353 }
Imath::M44d M44d
Definition: SpiMathLib.h:82
V3d m_origin
The integer voxel-space origin of the underlying Field object. Is equal to field.extents.min.
Definition: FieldMapping.h:190
V3d m_res
The integer voxel-space resolution of the underlying Field object. Is equal to field.extents.max - field.extents.min + 1.
Definition: FieldMapping.h:193

Member Data Documentation

◆ DEFINE_FIELD_RTTI_CONCRETE_CLASS

MatrixFieldMapping::DEFINE_FIELD_RTTI_CONCRETE_CLASS

Definition at line 330 of file FieldMapping.h.

◆ m_lsToWs

M44d MatrixFieldMapping::m_lsToWs
private

Local space to world space.

Note
This is used only when m_lsToWsCurve has zero or one samples.

Definition at line 475 of file FieldMapping.h.

Referenced by updateTransform().

◆ m_wsToLs

M44d MatrixFieldMapping::m_wsToLs
private

World space to local space.

Note
This is used only when m_lsToWsCurve has zero or one samples.

Definition at line 478 of file FieldMapping.h.

Referenced by updateTransform().

◆ m_vsToWs

M44d MatrixFieldMapping::m_vsToWs
private

Voxel space to world space.

Note
This is used only when m_lsToWsCurve has zero or one samples.

Definition at line 481 of file FieldMapping.h.

Referenced by updateTransform().

◆ m_wsToVs

M44d MatrixFieldMapping::m_wsToVs
private

World space to voxel space.

Note
This is used only when m_lsToWsCurve has zero or one samples.

Definition at line 484 of file FieldMapping.h.

Referenced by updateTransform().

◆ m_lsToWsCurve

MatrixCurve MatrixFieldMapping::m_lsToWsCurve
private

Time-varying local to world space transform.

Definition at line 487 of file FieldMapping.h.

Referenced by isIdentical(), makeIdentity(), setLocalToWorld(), and updateTransform().

◆ m_vsToWsCurve

MatrixCurve MatrixFieldMapping::m_vsToWsCurve
private

Time-varying voxel to world space transform.

Definition at line 489 of file FieldMapping.h.

Referenced by isIdentical(), and updateTransform().

◆ m_isTimeVarying

bool MatrixFieldMapping::m_isTimeVarying
private

Stores whether the curve has more than one time sample.

Note
This is set by updateTransform().

Definition at line 493 of file FieldMapping.h.

Referenced by updateTransform().

◆ m_wsVoxelSize

V3d MatrixFieldMapping::m_wsVoxelSize
private

Precomputed world-space voxel size. Calculations may assume orthogonal transformation for efficiency.

Definition at line 497 of file FieldMapping.h.

Referenced by updateTransform().


The documentation for this class was generated from the following files: