OpenVDB  5.2.0
Public Types | Public Member Functions | List of all members
VelocitySampler< GridT, Staggered, Order > Class Template Reference

#include <VelocityFields.h>

Public Types

typedef GridT::ConstAccessor AccessorType
 
typedef GridT::ValueType ValueType
 

Public Member Functions

 VelocitySampler (const GridT &grid)
 Constructor from a grid. More...
 
 VelocitySampler (const VelocitySampler &other)
 Copy-constructor. More...
 
template<typename LocationType >
bool sample (const LocationType &world, ValueType &result) const
 Samples the velocity at world position onto result. Supports both staggered (i.e. MAC) and collocated velocity grids. More...
 
template<typename LocationType >
ValueType sample (const LocationType &world) const
 Samples the velocity at world position onto result. Supports both staggered (i.e. MAC) and co-located velocity grids. More...
 

Detailed Description

template<typename GridT = Vec3fGrid, bool Staggered = false, size_t Order = 1>
class openvdb::v5_2::tools::VelocitySampler< GridT, Staggered, Order >

Class to hold a Vec3 field interpreted as a velocity field. Primarily exists to provide a method(s) that integrate a passive point forward in the velocity field for a single time-step (dt)

Member Typedef Documentation

typedef GridT::ConstAccessor AccessorType
typedef GridT::ValueType ValueType

Constructor & Destructor Documentation

VelocitySampler ( const GridT &  grid)
inline

Constructor from a grid.

VelocitySampler ( const VelocitySampler< GridT, Staggered, Order > &  other)
inline

Copy-constructor.

Member Function Documentation

bool sample ( const LocationType &  world,
ValueType result 
) const
inline

Samples the velocity at world position onto result. Supports both staggered (i.e. MAC) and collocated velocity grids.

Returns
true if any one of the sampled values is active.
Warning
Not threadsafe since it uses a ValueAccessor! So use one instance per thread (which is fine since its lightweight).
ValueType sample ( const LocationType &  world) const
inline

Samples the velocity at world position onto result. Supports both staggered (i.e. MAC) and co-located velocity grids.

Warning
Not threadsafe since it uses a ValueAccessor! So use one instance per thread (which is fine since its lightweight).

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