UT_VoxelVectorProbe< T, DoRead, DoWrite, TestForWrites > Class Template Reference

#include <UT_VoxelArray.h>

List of all members.

Public Member Functions

 UT_VoxelVectorProbe ()
 UT_VoxelVectorProbe (UT_VoxelArray< T > *vx, UT_VoxelArray< T > *vy, UT_VoxelArray< T > *vz)
virtual ~UT_VoxelVectorProbe ()
void setArray (UT_VoxelArray< T > *vx, UT_VoxelArray< T > *vy, UT_VoxelArray< T > *vz)
UT_Vector3 getValue () const
getValue (int axis) const
void setValue (const UT_Vector3 &v)
void setComponent (int axis, T val)
template<typename S >
bool setIndex (UT_VoxelArrayIterator< S > &vit)
bool setIndex (int x, int y, int z)
void advanceX ()

Protected Attributes

UT_VoxelProbe< T, DoRead,
DoWrite, TestForWrites > 
myLines [3]


Detailed Description

template<typename T, bool DoRead, bool DoWrite, bool TestForWrites>
class UT_VoxelVectorProbe< T, DoRead, DoWrite, TestForWrites >

The vector probe is three normal probes into separate voxel arrays making it easier to read and write to aligned vector fields. If the vector field is face-centered, see the UT_VoxelProbeFace.

Definition at line 1105 of file UT_VoxelArray.h.


Constructor & Destructor Documentation

template<typename T , bool DoRead, bool DoWrite, bool TestForWrites>
UT_VoxelVectorProbe< T, DoRead, DoWrite, TestForWrites >::UT_VoxelVectorProbe (  )  [inline]

Definition at line 1108 of file UT_VoxelArray.h.

template<typename T , bool DoRead, bool DoWrite, bool TestForWrites>
UT_VoxelVectorProbe< T, DoRead, DoWrite, TestForWrites >::UT_VoxelVectorProbe ( UT_VoxelArray< T > *  vx,
UT_VoxelArray< T > *  vy,
UT_VoxelArray< T > *  vz 
) [inline]

Definition at line 1110 of file UT_VoxelArray.h.

template<typename T , bool DoRead, bool DoWrite, bool TestForWrites>
virtual UT_VoxelVectorProbe< T, DoRead, DoWrite, TestForWrites >::~UT_VoxelVectorProbe (  )  [inline, virtual]

Definition at line 1112 of file UT_VoxelArray.h.


Member Function Documentation

template<typename T , bool DoRead, bool DoWrite, bool TestForWrites>
void UT_VoxelVectorProbe< T, DoRead, DoWrite, TestForWrites >::advanceX (  )  [inline]

Definition at line 1164 of file UT_VoxelArray.h.

template<typename T , bool DoRead, bool DoWrite, bool TestForWrites>
T UT_VoxelVectorProbe< T, DoRead, DoWrite, TestForWrites >::getValue ( int  axis  )  const [inline]

Definition at line 1126 of file UT_VoxelArray.h.

template<typename T , bool DoRead, bool DoWrite, bool TestForWrites>
UT_Vector3 UT_VoxelVectorProbe< T, DoRead, DoWrite, TestForWrites >::getValue (  )  const [inline]

Definition at line 1122 of file UT_VoxelArray.h.

template<typename T , bool DoRead, bool DoWrite, bool TestForWrites>
void UT_VoxelVectorProbe< T, DoRead, DoWrite, TestForWrites >::setArray ( UT_VoxelArray< T > *  vx,
UT_VoxelArray< T > *  vy,
UT_VoxelArray< T > *  vz 
) [inline]

Definition at line 1115 of file UT_VoxelArray.h.

template<typename T , bool DoRead, bool DoWrite, bool TestForWrites>
void UT_VoxelVectorProbe< T, DoRead, DoWrite, TestForWrites >::setComponent ( int  axis,
val 
) [inline]

Definition at line 1138 of file UT_VoxelArray.h.

template<typename T , bool DoRead, bool DoWrite, bool TestForWrites>
bool UT_VoxelVectorProbe< T, DoRead, DoWrite, TestForWrites >::setIndex ( int  x,
int  y,
int  z 
) [inline]

Definition at line 1151 of file UT_VoxelArray.h.

template<typename T , bool DoRead, bool DoWrite, bool TestForWrites>
template<typename S >
bool UT_VoxelVectorProbe< T, DoRead, DoWrite, TestForWrites >::setIndex ( UT_VoxelArrayIterator< S > &  vit  )  [inline]

Resets where we currently point to. Returns true if we had to reset our cache line. If we didn't, and you have multiple probes acting in-step, you can just advanceX() the other probes

Definition at line 1148 of file UT_VoxelArray.h.

template<typename T , bool DoRead, bool DoWrite, bool TestForWrites>
void UT_VoxelVectorProbe< T, DoRead, DoWrite, TestForWrites >::setValue ( const UT_Vector3 v  )  [inline]

Definition at line 1131 of file UT_VoxelArray.h.


Member Data Documentation

template<typename T , bool DoRead, bool DoWrite, bool TestForWrites>
UT_VoxelProbe<T, DoRead, DoWrite, TestForWrites> UT_VoxelVectorProbe< T, DoRead, DoWrite, TestForWrites >::myLines[3] [protected]

Definition at line 1168 of file UT_VoxelArray.h.


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

Generated on Fri May 25 00:10:56 2012 for HDK by  doxygen 1.5.9