HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::tools::CheckMagnitude< GridT, TreeIterT > Struct Template Reference

Check that the magnitude of a value, a, is close to a fixed magnitude, b, given a fixed tolerance c. That is | |a| - |b| | <= c. 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

 CheckMagnitude (const ElementType &a, const ElementType &t=math::Tolerance< ElementType >::value())
 Default constructor. More...
 
bool operator() (const ElementType &v) const
 
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 infinite. More...
 
bool operator() (const TreeIterT &iter) const
 Return true if the tile at the iterator location is infinite. More...
 
bool operator() (const VoxelIterT &iter) const
 Return true if the tile at the iterator location is infinite. More...
 
std::string str () const
 Return a string describing a failed check. More...
 

Public Attributes

const ElementType absVal
 
const ElementType tolVal
 

Detailed Description

template<typename GridT, typename TreeIterT = typename GridT::ValueOffCIter>
struct openvdb::OPENVDB_VERSION_NAME::tools::CheckMagnitude< GridT, TreeIterT >

Check that the magnitude of a value, a, is close to a fixed magnitude, b, given a fixed tolerance c. That is | |a| - |b| | <= c.

Definition at line 250 of file Diagnostics.h.

Member Typedef Documentation

template<typename GridT, typename TreeIterT = typename GridT::ValueOffCIter>
using openvdb::OPENVDB_VERSION_NAME::tools::CheckMagnitude< GridT, TreeIterT >::ElementType = typename VecTraits<typename GridT::ValueType>::ElementType

Definition at line 252 of file Diagnostics.h.

template<typename GridT, typename TreeIterT = typename GridT::ValueOffCIter>
using openvdb::OPENVDB_VERSION_NAME::tools::CheckMagnitude< GridT, TreeIterT >::TileIterT = TreeIterT

Definition at line 253 of file Diagnostics.h.

template<typename GridT, typename TreeIterT = typename GridT::ValueOffCIter>
using openvdb::OPENVDB_VERSION_NAME::tools::CheckMagnitude< GridT, TreeIterT >::VoxelIterT = typename tree::IterTraits<typename TreeIterT::NodeT, typename TreeIterT::ValueIterT> ::template NodeConverter< typename GridT::TreeType::LeafNodeType>::Type

Definition at line 256 of file Diagnostics.h.

Constructor & Destructor Documentation

template<typename GridT, typename TreeIterT = typename GridT::ValueOffCIter>
openvdb::OPENVDB_VERSION_NAME::tools::CheckMagnitude< GridT, TreeIterT >::CheckMagnitude ( const ElementType a,
const ElementType t = math::Tolerance<ElementType>::value() 
)
inline

Default constructor.

Definition at line 259 of file Diagnostics.h.

Member Function Documentation

template<typename GridT, typename TreeIterT = typename GridT::ValueOffCIter>
bool openvdb::OPENVDB_VERSION_NAME::tools::CheckMagnitude< GridT, TreeIterT >::operator() ( const ElementType v) const
inline

Return true if the magnitude of the value is not approximately equal to totVal.

Definition at line 267 of file Diagnostics.h.

template<typename GridT, typename TreeIterT = typename GridT::ValueOffCIter>
template<typename T >
std::enable_if<VecTraits<T>::IsVec, bool>::type openvdb::OPENVDB_VERSION_NAME::tools::CheckMagnitude< GridT, TreeIterT >::operator() ( const T &  v) const
inline

Return true if any of the vector components are infinite.

Definition at line 275 of file Diagnostics.h.

template<typename GridT, typename TreeIterT = typename GridT::ValueOffCIter>
bool openvdb::OPENVDB_VERSION_NAME::tools::CheckMagnitude< GridT, TreeIterT >::operator() ( const TreeIterT &  iter) const
inline

Return true if the tile at the iterator location is infinite.

Definition at line 282 of file Diagnostics.h.

template<typename GridT, typename TreeIterT = typename GridT::ValueOffCIter>
bool openvdb::OPENVDB_VERSION_NAME::tools::CheckMagnitude< GridT, TreeIterT >::operator() ( const VoxelIterT iter) const
inline

Return true if the tile at the iterator location is infinite.

Definition at line 285 of file Diagnostics.h.

template<typename GridT, typename TreeIterT = typename GridT::ValueOffCIter>
std::string openvdb::OPENVDB_VERSION_NAME::tools::CheckMagnitude< GridT, TreeIterT >::str ( ) const
inline

Return a string describing a failed check.

Definition at line 288 of file Diagnostics.h.

Member Data Documentation

template<typename GridT, typename TreeIterT = typename GridT::ValueOffCIter>
const ElementType openvdb::OPENVDB_VERSION_NAME::tools::CheckMagnitude< GridT, TreeIterT >::absVal

Definition at line 295 of file Diagnostics.h.

template<typename GridT, typename TreeIterT = typename GridT::ValueOffCIter>
const ElementType openvdb::OPENVDB_VERSION_NAME::tools::CheckMagnitude< GridT, TreeIterT >::tolVal

Definition at line 295 of file Diagnostics.h.


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