HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::tools::DiscreteField< VelGridT, Interpolator > Class Template Reference

Thin wrapper class for a velocity grid. More...

#include <VelocityFields.h>

Public Types

typedef VelGridT::ValueType VectorType
 
typedef VectorType::ValueType ValueType
 

Public Member Functions

 HBOOST_STATIC_ASSERT (hboost::is_floating_point< ValueType >::value)
 
 DiscreteField (const VelGridT &vel)
 
 DiscreteField (const DiscreteField &other)
 Copy constructor. More...
 
const math::Transformtransform () const
 
VectorType operator() (const Vec3d &xyz, ValueType) const
 
VectorType operator() (const Coord &ijk, ValueType) const
 

Detailed Description

template<typename VelGridT, typename Interpolator = BoxSampler>
class openvdb::OPENVDB_VERSION_NAME::tools::DiscreteField< VelGridT, Interpolator >

Thin wrapper class for a velocity grid.

Note
Consider replacing BoxSampler with StaggeredBoxSampler

Definition at line 70 of file VelocityFields.h.

Member Typedef Documentation

template<typename VelGridT , typename Interpolator = BoxSampler>
typedef VectorType::ValueType openvdb::OPENVDB_VERSION_NAME::tools::DiscreteField< VelGridT, Interpolator >::ValueType

Definition at line 74 of file VelocityFields.h.

template<typename VelGridT , typename Interpolator = BoxSampler>
typedef VelGridT::ValueType openvdb::OPENVDB_VERSION_NAME::tools::DiscreteField< VelGridT, Interpolator >::VectorType

Definition at line 73 of file VelocityFields.h.

Constructor & Destructor Documentation

template<typename VelGridT , typename Interpolator = BoxSampler>
openvdb::OPENVDB_VERSION_NAME::tools::DiscreteField< VelGridT, Interpolator >::DiscreteField ( const VelGridT &  vel)
inline

Definition at line 77 of file VelocityFields.h.

template<typename VelGridT , typename Interpolator = BoxSampler>
openvdb::OPENVDB_VERSION_NAME::tools::DiscreteField< VelGridT, Interpolator >::DiscreteField ( const DiscreteField< VelGridT, Interpolator > &  other)
inline

Copy constructor.

Definition at line 84 of file VelocityFields.h.

Member Function Documentation

template<typename VelGridT , typename Interpolator = BoxSampler>
openvdb::OPENVDB_VERSION_NAME::tools::DiscreteField< VelGridT, Interpolator >::HBOOST_STATIC_ASSERT ( hboost::is_floating_point< ValueType >::value  )
template<typename VelGridT , typename Interpolator = BoxSampler>
VectorType openvdb::OPENVDB_VERSION_NAME::tools::DiscreteField< VelGridT, Interpolator >::operator() ( const Vec3d &  xyz,
ValueType   
) const
inline
Returns
the interpolated velocity at the world space position xyz
Warning
Not threadsafe since it uses a ValueAccessor! So use one instance per thread (which is fine since its lightweight).

Definition at line 99 of file VelocityFields.h.

template<typename VelGridT , typename Interpolator = BoxSampler>
VectorType openvdb::OPENVDB_VERSION_NAME::tools::DiscreteField< VelGridT, Interpolator >::operator() ( const Coord &  ijk,
ValueType   
) const
inline
Returns
the velocity at the coordinate space position ijk
Warning
Not threadsafe since it uses a ValueAccessor! So use one instance per thread (which is fine since its lightweight).

Definition at line 108 of file VelocityFields.h.

template<typename VelGridT , typename Interpolator = BoxSampler>
const math::Transform& openvdb::OPENVDB_VERSION_NAME::tools::DiscreteField< VelGridT, Interpolator >::transform ( ) const
inline
Returns
const reference to the transform between world and index space
Note
Use this method to determine if a client grid is aligned with the coordinate space of the velocity grid.

Definition at line 93 of file VelocityFields.h.


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