OpenVDB  5.2.0
Public Types | Public Member Functions | Public Attributes | List of all members
CheckMax< GridT, TreeIterT > Struct Template Reference

Checks a value against a maximum. More...

#include <Diagnostics.h>

Public Types

using ElementType = typename VecTraits< typename GridT::ValueType >::ElementType
 
using TileIterT = TreeIterT
 
using VoxelIterT = typename tree::IterTraits< typename TreeIterT::NodeT, typename TreeIterT::ValueIterT >::template NodeConverter< typename GridT::TreeType::LeafNodeType >::Type
 

Public Member Functions

 CheckMax (const ElementType &_max)
 Constructor taking a maximum to be tested against. More...
 
bool operator() (const ElementType &v) const
 Return true if the value is larger than max. More...
 
template<typename T >
std::enable_if< VecTraits< T >::IsVec, bool >::type operator() (const T &v) const
 Return true if any of the vector components are larger than max. More...
 
bool operator() (const TreeIterT &iter) const
 Return true if the tile at the iterator location is larger than max. More...
 
bool operator() (const VoxelIterT &iter) const
 Return true if the voxel at the iterator location is larger than max. More...
 
std::string str () const
 Return a string describing a failed check. More...
 

Public Attributes

const ElementType maxVal
 

Detailed Description

template<typename GridT, typename TreeIterT = typename GridT::ValueOnCIter>
struct openvdb::v5_2::tools::CheckMax< GridT, TreeIterT >

Checks a value against a maximum.

Member Typedef Documentation

using ElementType = typename VecTraits<typename GridT::ValueType>::ElementType
using TileIterT = TreeIterT
using VoxelIterT = typename tree::IterTraits<typename TreeIterT::NodeT, typename TreeIterT::ValueIterT> ::template NodeConverter< typename GridT::TreeType::LeafNodeType>::Type

Constructor & Destructor Documentation

CheckMax ( const ElementType _max)
inline

Constructor taking a maximum to be tested against.

Member Function Documentation

bool operator() ( const ElementType v) const
inline

Return true if the value is larger than max.

std::enable_if<VecTraits<T>::IsVec, bool>::type operator() ( const T &  v) const
inline

Return true if any of the vector components are larger than max.

bool operator() ( const TreeIterT &  iter) const
inline

Return true if the tile at the iterator location is larger than max.

bool operator() ( const VoxelIterT iter) const
inline

Return true if the voxel at the iterator location is larger than max.

std::string str ( ) const
inline

Return a string describing a failed check.

Member Data Documentation

const ElementType maxVal

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