OpenVDB
12.0.0
|
Base class for interrupters. More...
#include <openvdb/util/NullInterrupter.h>
Public Member Functions | |
NullInterrupter ()=default | |
Default constructor. More... | |
virtual | ~NullInterrupter ()=default |
virtual void | start (const char *name=nullptr) |
virtual void | end () |
Signal the end of an interruptible operation. More... | |
virtual bool | wasInterrupted (int percent=-1) |
virtual NullInterrupter & | interrupter () final |
Convenience method to return a reference to the base class from a derived class. More... | |
Base class for interrupters.
The host application calls start() at the beginning of an interruptible operation, end() at the end of the operation, and wasInterrupted() periodically during the operation. If any call to wasInterrupted() returns true
, the operation will be aborted.
|
default |
Default constructor.
|
virtualdefault |
|
inlinevirtual |
Signal the end of an interruptible operation.
|
inlinefinalvirtual |
Convenience method to return a reference to the base class from a derived class.
|
inlinevirtual |
Signal the start of an interruptible operation.
name | an optional descriptive name for the operation |
|
inlinevirtual |
Check if an interruptible operation should be aborted.
percent | an optional (when >= 0) percentage indicating the fraction of the operation that has been completed |