OpenVDB: Interrupter Class Reference

OpenVDB 8.0.0

Public Member Functions | List of all members
Interrupter Class Reference

Wrapper class that adapts a Houdini `UT_Interrupt` object for use with OpenVDB library routines. More...

`#include <Utils.h>`

## Public Member Functions
| Interrupter (const char *title=nullptr)
| ~Interrupter ()
| Interrupter (const Interrupter &)=default
Interrupter & | operator= (const Interrupter &)=default
void | start (const char *name=nullptr)
| Signal the start of an interruptible operation. More...
void | end ()
| Signal the end of an interruptible operation. More...
bool | wasInterrupted (int percent=-1)
| Check if an interruptible operation should be aborted. More...

## Detailed Description

Wrapper class that adapts a Houdini `UT_Interrupt` object for use with OpenVDB library routines.

See also
  openvdb/util/NullInterrupter.h

## Constructor & Destructor Documentation

## ◆ Interrupter() [1/2]

Interrupter | ( | const char * | title = `nullptr` | ) |
| inlineexplicit

## ◆ ~Interrupter()

~Interrupter | ( |  | ) |
| inline

## ◆ Interrupter() [2/2]

Interrupter | ( | const Interrupter & |  | ) |
| default

## Member Function Documentation

## ◆ end()

void end | ( |  | ) |
| inline

Signal the end of an interruptible operation.

## ◆ operator=()

Interrupter& operator= | ( | const Interrupter & |  | ) |
| default

## ◆ start()

void start | ( | const char * | name = `nullptr` | ) |
| inline

Signal the start of an interruptible operation.

Parameters

  name | an optional descriptive name for the operation

## ◆ wasInterrupted()

bool wasInterrupted | ( | int | percent = `-1` | ) |
| inline

Check if an interruptible operation should be aborted.

Parameters

  percent | an optional (when >= 0) percentage indicating the fraction of the operation that has been completed

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

- openvdb_houdini/openvdb_houdini/Utils.h