OpenVDB  6.2.1
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
 
Interrupteroperator= (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 ( const char *  title = nullptr)
inlineexplicit
~Interrupter ( )
inline
Interrupter ( const Interrupter )
default

Member Function Documentation

void end ( )
inline

Signal the end of an interruptible operation.

Interrupter& operator= ( const Interrupter )
default
void start ( const char *  name = nullptr)
inline

Signal the start of an interruptible operation.

Parameters
namean optional descriptive name for the operation
bool wasInterrupted ( int  percent = -1)
inline

Check if an interruptible operation should be aborted.

Parameters
percentan 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: