Specifies a custom progress indicator. More...
Typedefs | |
typedef A3DVoid(* | A3DCallbackProgressStart )(A3DInt32) |
typedef A3DVoid(* | A3DCallbackProgressSize )(A3DInt32) |
typedef A3DVoid(* | A3DCallbackProgressIncrement )(A3DInt32) |
typedef A3DVoid(* | A3DCallbackProgressEnd )() |
typedef A3DVoid(* | A3DCallbackProgressTitle )(A3DUTF8Char *msg) |
Functions | |
A3DStatus | A3DDllSetCallbacksProgress (A3DCallbackProgressStart, A3DCallbackProgressSize, A3DCallbackProgressIncrement, A3DCallbackProgressEnd, A3DCallbackProgressTitle, A3DInt32 *) |
Sets callbacks for progress bar facility. More... | |
Specifies a custom progress indicator.
This section describes the function and types that enable you to specify a custom progress indicator, such as a status bar.
A callback function the A3DLIBS invokes as it prepares to perform a potentially time-consuming process. The argument identifies the processing phase, as follows:
Processing phase | Description |
---|---|
1 | Parsing the file |
2 | Writing file |
3 | Reading or building the model, which follows the parsing of the file (processing phase 1) |
A callback function the A3DLIBS invokes to report an approximate size of the PRC stream being processed. The size is independent of units and is bounded only by the limit of the A3DInt32 type.
A callback function the A3DLIBS intermittently invokes while processing the PRC stream. As processing proceeds, the argument increments from 0 to a maximum of Size, where Size is the argument provided in A3DCallbackProgressSize.
typedef A3DVoid(* A3DCallbackProgressEnd)() |
A callback function the A3DLIBS invokes when it finishes the process.
typedef A3DVoid(* A3DCallbackProgressTitle)(A3DUTF8Char *msg) |
A callback function the A3DLIBS invokes to provide a text string relevant to the processing phase. In the case of reading PRC data from a file, the argument provides the name of the file containing the PRC stream.
A3DStatus A3DDllSetCallbacksProgress | ( | A3DCallbackProgressStart | fnPrgStart, |
A3DCallbackProgressSize | fnPrgSize, | ||
A3DCallbackProgressIncrement | fnPrgIncrement, | ||
A3DCallbackProgressEnd | fnPrgEnd, | ||
A3DCallbackProgressTitle | fnPrgTitle, | ||
A3DInt32 * | piBreak | ||
) |
Sets callbacks for progress bar facility.
This function configures the A3DLIBS with the callback functions that implement a custom progress indicator, such as a status bar.
The last argument passed to this function sets a break. The A3DLIBS checks this variable at every significant step in processing the PRC. If the value is non-zero, the A3DLIBS stops processing the PRC data.