OpenVDB: GridOperator< InGridT, MaskGridType, OutGridT, MapT, OperatorT, InterruptT > Class Template Reference

OpenVDB 5.0.0

Public Types | Public Member Functions | Protected Types | Protected Attributes | List of all members
GridOperator< InGridT, MaskGridType, OutGridT, MapT, OperatorT, InterruptT > Class Template Reference

Apply an operator to an input grid to produce an output grid with the same active voxel topology but a potentially different value type. More...

`#include <GridOperators.h>`

## Public Types
typedef OutGridT::TreeType | OutTreeT
typedef OutTreeT::LeafNodeType | OutLeafT
typedef tree::LeafManager< OutTreeT > | LeafManagerT

## Public Member Functions
| GridOperator (const InGridT &grid, const MaskGridType *mask, const MapT &map, InterruptT *interrupt=nullptr, bool densify=true)
| GridOperator (const GridOperator &)=default
GridOperator & | operator= (const GridOperator &)=default
virtual | ~GridOperator ()=default
OutGridT::Ptr | process (bool threaded=true)
void | operator() (const typename LeafManagerT::LeafRange &range) const
| Iterate sequentially over LeafNodes and voxels in the output grid and apply the operator using a value accessor for the input grid. More...

## Protected Types
typedef InGridT::ConstAccessor | AccessorT

## Protected Attributes
AccessorT | mAcc
const MapT & | mMap
InterruptT * | mInterrupt
const MaskGridType * | mMask
const bool | mDensify

## Detailed Description

### template<typename InGridT, typename MaskGridType, typename OutGridT, typename MapT, typename OperatorT, typename InterruptT = util::NullInterrupter>
class openvdb::v5_0::tools::gridop::GridOperator< InGridT, MaskGridType, OutGridT, MapT, OperatorT, InterruptT >

Apply an operator to an input grid to produce an output grid with the same active voxel topology but a potentially different value type.

To facilitate inlining, this class is also templated on a Map type.

Note
  This is a helper class and should never be used directly.

## Member Typedef Documentation

## ◆ AccessorT

typedef InGridT::ConstAccessor AccessorT
| protected

## ◆ LeafManagerT

typedef tree::LeafManager<OutTreeT> LeafManagerT

## ◆ OutLeafT

typedef OutTreeT::LeafNodeType OutLeafT

## ◆ OutTreeT

typedef OutGridT::TreeType OutTreeT

## Constructor & Destructor Documentation

## ◆ GridOperator() [1/2]

GridOperator | ( | const InGridT & | grid,
|  | const MaskGridType * | mask,
|  | const MapT & | map,
|  | InterruptT * | interrupt = `nullptr`,
|  | bool | densify = `true`
| ) |  |
| inline

## ◆ GridOperator() [2/2]

GridOperator | ( | const GridOperator< InGridT, MaskGridType, OutGridT, MapT, OperatorT, InterruptT > & |  | ) |
| default

## ◆ ~GridOperator()

virtual ~GridOperator | ( |  | ) |
| virtualdefault

## Member Function Documentation

## ◆ operator()()

void operator() | ( | const typename LeafManagerT::LeafRange & | range | ) | const
| inline

Iterate sequentially over LeafNodes and voxels in the output grid and apply the operator using a value accessor for the input grid.

Note
  Never call this public method directly - it is called by TBB threads only!

## ◆ operator=()

GridOperator& operator= | ( | const GridOperator< InGridT, MaskGridType, OutGridT, MapT, OperatorT, InterruptT > & |  | ) |
| default

## ◆ process()

OutGridT::Ptr process | ( | bool | threaded = `true` | ) |
| inline

## Member Data Documentation

## ◆ mAcc

AccessorT mAcc
| mutableprotected

## ◆ mDensify

const bool mDensify
| protected

## ◆ mInterrupt

InterruptT* mInterrupt
| protected

## ◆ mMap

const MapT& mMap
| protected

## ◆ mMask

const MaskGridType* mMask
| protected

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

- GridOperators.h