MatrixFieldMapping Class Reference

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

#include <FieldMapping.h>

Inheritance diagram for MatrixFieldMapping:

Public Types
typedef MatrixFieldMapping	class_type
typedef Curve< Imath::M44d >	MatrixCurve
	Time-varying matrix. More...
typedef boost::intrusive_ptr< MatrixFieldMapping >	Ptr
	Convenience typedef. More...
Public Types inherited from FieldMapping
typedef FieldMapping	class_type
typedef boost::intrusive_ptr< FieldMapping >	Ptr
Public Types inherited from RefBase
typedef boost::intrusive_ptr< RefBase >	Ptr
typedef boost::weak_ptr< RefBase >	WeakPtr

Public Member Functions
const M44d &	localToWorld () const
	Returns a reference to the local to world transform. More...
const MatrixCurve::SampleVec &	localToWorldSamples () 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 M44d &	voxelToWorld () const
	Returns a reference to the voxel to world space transform. More...
const M44d &	worldToVoxel () const
	Returns a reference to the world to voxel space transform. More...
M44d	worldToVoxel (float time) const
	Returns the world to voxel space transform at a given time. 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 V3d &	origin () const
	Returns the origin. More...
const V3d &	resolution () 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...
WeakPtr	weakPtr () const
	RefBase ()
	RefBase (const RefBase &)
	Copy constructor. More...
RefBase &	operator= (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 *	staticClassType ()
Static Public Member Functions inherited from FieldMapping
static const char *	staticClassType ()
Static Public Member Functions inherited from RefBase
static const char *	staticClassType ()

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 334 of file FieldMapping.h.

Member Typedef Documentation

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

Convenience typedef.

Definition at line 341 of file FieldMapping.h.

typedef Curve<Imath::M44d> MatrixFieldMapping::MatrixCurve

Time-varying matrix.

Definition at line 343 of file FieldMapping.h.

typedef MatrixFieldMapping MatrixFieldMapping::class_type

Definition at line 347 of file FieldMapping.h.

typedef FieldMapping MatrixFieldMapping::base

private

Convenience typedef for referring to base class.

Definition at line 530 of file FieldMapping.h.

Constructor & Destructor Documentation

MatrixFieldMapping::MatrixFieldMapping

(

)

Definition at line 253 of file FieldMapping.cpp.

References makeIdentity().

Referenced by clone().

  : FieldMapping()
{ 
  makeIdentity();
}

MatrixFieldMapping::MatrixFieldMapping

(

const Box3i &

extents

)

Definition at line 261 of file FieldMapping.cpp.

References makeIdentity().

  : FieldMapping(extents)
{ 
  makeIdentity();
}

Member Function Documentation

static const char* MatrixFieldMapping::staticClassType ( )

inlinestatic

Definition at line 350 of file FieldMapping.h.

Referenced by className().

  {
    return "MatrixFieldMapping";
  }

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 269 of file FieldMapping.cpp.

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

{
  if (m_lsToWsCurve.numSamples() > 0) {
    makeIdentity();
  }
  setLocalToWorld(0.0f, lsToWs);
}

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

Sets the local to world transform at a given time.

Definition at line 279 of file FieldMapping.cpp.

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

{
  m_lsToWsCurve.addSample(t, lsToWs);
  updateTransform();
}

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 376 of file FieldMapping.h.

  { return m_lsToWs; }

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 381 of file FieldMapping.h.

Referenced by FieldWrapper< Field_T >::setWsBoundsOptimization(), and MIPFieldWrapper< Field_T >::setWsBoundsOptimization().

  { return m_wsToVs; }

M44d MatrixFieldMapping::worldToVoxel ( float  time ) const

inline

Returns the world to voxel space transform at a given time.

Definition at line 385 of file FieldMapping.h.

  {
    if (!m_isTimeVarying) {
      return m_wsToVs;
    } else {
      return m_vsToWsCurve.linear(time).inverse();
    }
  }

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 396 of file FieldMapping.h.

  { return m_vsToWs; }

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

inline

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

Definition at line 400 of file FieldMapping.h.

  { return m_lsToWsCurve.samples(); } 

void MatrixFieldMapping::makeIdentity

(

)

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

Definition at line 287 of file FieldMapping.cpp.

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

Referenced by MatrixFieldMapping(), and setLocalToWorld().

{
  m_lsToWsCurve.clear();
  updateTransform();
}

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

inlinevirtual

Transform from world space position into voxel space.

Implements FieldMapping.

Definition at line 412 of file FieldMapping.h.

  { m_wsToVs.multVecMatrix(wsP, vsP); }

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

inlinevirtual

Implements FieldMapping.

Definition at line 414 of file FieldMapping.h.

  { 
    if (!m_isTimeVarying) {
      m_wsToVs.multVecMatrix(wsP, vsP);
    } else {
      M44d wsToVs = m_vsToWsCurve.linear(time).inverse();
      wsToVs.multVecMatrix(wsP, vsP);
    }
  }

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

inlinevirtual

Transform from voxel space position into world space.

Implements FieldMapping.

Definition at line 424 of file FieldMapping.h.

  { m_vsToWs.multVecMatrix(vsP, wsP); }

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

inlinevirtual

Implements FieldMapping.

Definition at line 426 of file FieldMapping.h.

  { 
    if (!m_isTimeVarying) {
      m_vsToWs.multVecMatrix(vsP, wsP); 
    } else {
      M44d vsToWs = m_vsToWsCurve.linear(time);
      vsToWs.multVecMatrix(vsP, wsP);
    }
  }

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

inlinevirtual

Transform from world space position into local space.

Implements FieldMapping.

Definition at line 436 of file FieldMapping.h.

Referenced by FieldGroup< BaseTypeList_T, Dims_T >::GetIntersections::intersectMatrixMapping().

  { m_wsToLs.multVecMatrix(wsP, lsP); }

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

inlinevirtual

Implements FieldMapping.

Definition at line 438 of file FieldMapping.h.

  { 
    if (!m_isTimeVarying) {
      m_wsToLs.multVecMatrix(wsP, lsP); 
    } else {
      M44d wsToLs = m_lsToWsCurve.linear(time).inverse();
      wsToLs.multVecMatrix(wsP, lsP);
    }
  }

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

inlinevirtual

Transform from local space position into world space.

Implements FieldMapping.

Definition at line 449 of file FieldMapping.h.

  { m_lsToWs.multVecMatrix(lsP, wsP); }

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

inlinevirtual

Implements FieldMapping.

Definition at line 451 of file FieldMapping.h.

  { 
    if (!m_isTimeVarying) {
      m_lsToWs.multVecMatrix(lsP, wsP); 
    } else {
      M44d lsToWs = m_lsToWsCurve.linear(time);
      lsToWs.multVecMatrix(lsP, wsP);
    }
  }

void MatrixFieldMapping::worldToVoxelDir ( const V3d &  wsV, V3d &  vsV  ) const

inline

Todo:

Generalize and make time-dependent.

Definition at line 462 of file FieldMapping.h.

  { m_wsToVs.multDirMatrix(wsV, vsV); }

void MatrixFieldMapping::voxelToWorldDir ( const V3d &  vsV, V3d &  wsV  ) const

inline

Todo:

Generalize and make time-dependent.

Definition at line 466 of file FieldMapping.h.

  { m_vsToWs.multDirMatrix(vsV, wsV); }

void MatrixFieldMapping::worldToLocalDir ( const V3d &  wsV, V3d &  lsV  ) const

inline

Todo:

Generalize and make time-dependent.

Definition at line 470 of file FieldMapping.h.

Referenced by FieldGroup< BaseTypeList_T, Dims_T >::GetIntersections::intersectMatrixMapping().

  { m_wsToLs.multDirMatrix(wsV, lsV); }

void MatrixFieldMapping::localToWorldDir ( const V3d &  lsV, V3d &  wsV  ) const

inline

Todo:

Generalize and make time-dependent.

Definition at line 474 of file FieldMapping.h.

  { m_lsToWs.multDirMatrix(lsV, wsV); }

void MatrixFieldMapping::extentsChanged ( )

virtual

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

Reimplemented from FieldMapping.

Definition at line 295 of file FieldMapping.cpp.

References updateTransform().

{ 
  updateTransform();
}

std::string MatrixFieldMapping::className ( ) const

virtual

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

Implements FieldMapping.

Definition at line 302 of file FieldMapping.cpp.

References staticClassType().

{
  return std::string(staticClassType());
}

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 309 of file FieldMapping.cpp.

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

{
  typedef MatrixFieldMapping::MatrixCurve::SampleVec SampleVec;

  if (other->className() != k_matrixMappingName) {
    return false;
  } else {

    MatrixFieldMapping::Ptr mm = 
      FIELD_DYNAMIC_CAST<MatrixFieldMapping>(other);

    if (mm) {

      const SampleVec lsToWs1 = m_lsToWsCurve.samples();
      const SampleVec lsToWs2 = mm->m_lsToWsCurve.samples();
      const SampleVec vsToWs1 = m_vsToWsCurve.samples();
      const SampleVec vsToWs2 = mm->m_vsToWsCurve.samples();

      size_t numSamples = lsToWs1.size();
      
      // First check if time sample counts differ
      // lsToWs and vsToWs are guaranteed to have same sample count.
      if (lsToWs1.size() != lsToWs2.size()) {
        return false;
      }
      
      // Then check if all time samples match, then check localToWorld 
      // and voxelToWorld matrices
      for (size_t i = 0; i < numSamples; ++i) {
        if (lsToWs1[i].first != lsToWs2[i].first) {
          return false;
        }
        if (!checkMatricesIdentical(lsToWs1[i].second, lsToWs2[i].second,
                                    tolerance)) {
          return false;
        }
        if (!checkMatricesIdentical(vsToWs1[i].second, vsToWs2[i].second,
                                    tolerance)) {
          return false;        
        }
      }

      return true;

    } else {
      return false;
    }
  }
  return false;
}

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 484 of file FieldMapping.h.

Referenced by FieldGroup< BaseTypeList_T, Dims_T >::GetIntersections::intersectMatrixMapping().

  { return m_wsVoxelSize; }

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 414 of file FieldMapping.cpp.

References MatrixFieldMapping().

{
  return Ptr(new MatrixFieldMapping(*this));
}

void MatrixFieldMapping::updateTransform ( )

private

Updates the local to world transformation matrix.

Definition at line 363 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().

{
  typedef MatrixCurve::SampleVec::const_iterator SampleIter;

  // Build the voxel to world space transforms ---
  M44d lsToVs;
  getLocalToVoxelMatrix(lsToVs);
  M44d vsToLs = lsToVs.inverse();
  // Loop over all samples in lsToWs, append vsToLs and create new curve
  // Also handle the special case where lsToWs has no samples. In that
  // case m_vsToWsCurve still has to have one sample.
  const MatrixCurve::SampleVec &lsToWs = m_lsToWsCurve.samples();
  m_vsToWsCurve.clear();
  for (SampleIter i = lsToWs.begin(), end = lsToWs.end(); i != end; i++) {
    m_vsToWsCurve.addSample(i->first, vsToLs * i->second);
  }

  // See if the curve has more than just a single sample
  m_isTimeVarying = m_lsToWsCurve.numSamples() > 1;

  // Sample the time-varying transforms at time=0.0
  m_lsToWs = m_lsToWsCurve.linear(0.0);
  m_wsToLs = m_lsToWs.inverse();
  m_vsToWs = vsToLs * m_lsToWs;
  m_wsToVs = m_vsToWs.inverse();

  // Precompute the voxel size
  V3d voxelOrigin, nextVoxel;
  m_vsToWs.multVecMatrix(V3d(0, 0, 0), voxelOrigin);
  m_vsToWs.multVecMatrix(V3d(1, 0, 0), nextVoxel);
  m_wsVoxelSize.x = (nextVoxel - voxelOrigin).length();
  m_vsToWs.multVecMatrix(V3d(0, 1, 0), nextVoxel);
  m_wsVoxelSize.y = (nextVoxel - voxelOrigin).length();
  m_vsToWs.multVecMatrix(V3d(0, 0, 1), nextVoxel);
  m_wsVoxelSize.z = (nextVoxel - voxelOrigin).length();
}

void MatrixFieldMapping::getLocalToVoxelMatrix ( M44d &  result )

private

Todo:

Unit test this

Definition at line 402 of file FieldMapping.cpp.

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

Referenced by updateTransform().

{
  // Local to voxel is a scale by the resolution of the field, offset
  // to the origin of the extents
  M44d scaling, translation;
  scaling.setScale(m_res);
  translation.setTranslation(m_origin);
  result = scaling * translation;
}

Member Data Documentation

MatrixFieldMapping::DEFINE_FIELD_RTTI_CONCRETE_CLASS

Definition at line 348 of file FieldMapping.h.

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 503 of file FieldMapping.h.

Referenced by updateTransform().

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 506 of file FieldMapping.h.

Referenced by updateTransform().

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 509 of file FieldMapping.h.

Referenced by updateTransform().

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 512 of file FieldMapping.h.

Referenced by updateTransform().

MatrixCurve MatrixFieldMapping::m_lsToWsCurve

private

Time-varying local to world space transform.

Definition at line 515 of file FieldMapping.h.

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

MatrixCurve MatrixFieldMapping::m_vsToWsCurve

private

Time-varying voxel to world space transform.

Definition at line 517 of file FieldMapping.h.

Referenced by isIdentical(), and updateTransform().

bool MatrixFieldMapping::m_isTimeVarying

private

Stores whether the curve has more than one time sample.

Note

This is set by updateTransform().

Definition at line 521 of file FieldMapping.h.

Referenced by updateTransform().

V3d MatrixFieldMapping::m_wsVoxelSize

private

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

Definition at line 525 of file FieldMapping.h.

Referenced by updateTransform().

---

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

• export/FieldMapping.h
• src/FieldMapping.cpp