Dynamic Monitor

This global provides access to Modeler’s Dynamic Monitor features.

class lwsdk.DynaMonitorFuncs(*args)

Bases: object

Proxy of C++ PCore::DynaMonitorFuncs class

 create(char title, char caption) → LWMonitor

Create a monitor. This function returns a LWMonitor class instance (described below) containing the actual progress display functions. The title text provided in arg0 is ordinarily displayed at the top of the monitor dialog, and the caption text in arg1 is displayed at the bottom. If create returns None, your plug-in should continue to run without reporting an error. Monitors are nice to have, but aren't essential.

 destroy(LWMonitor monitor)

Free a monitor obtained from DynaMonitorFuncs::create().

class lwsdk.LWMonitor(*args)

Bases: object

Proxy of C++ PCore::LWMonitor class

 data → void

An opaque pointer to private data. Pass this as the first argument to all of the monitor functions.

 done(void data)

Remove the progress display. This should always be called, even if the task doesn't finish.

 init(void data, unsigned int total)

Initialize the monitor. The total value is the number of steps in the task to be monitored. It's up to you to decide what constitutes a step.

 step(void data, unsigned int increment) → int

Advance the progress display by the fraction total / increment. When the sum of the steps reaches total, the progress display will indicate to the user that the task has finished. If step returns 1, the user has requested that the task be aborted.

Previous topic

PCore Console

Next topic

Animation Envelopes

This Page