formZ SDK | 5.0 API Reference | Project | Modeling | Rendering | Render Materials

# fz_rmtl_iface_pview_interrupt

Description

This function is intended to be only called from the callback function of a Surface Style Representation plugin. It returns TRUE, if during the generation fo the preview, an event occurred, that requires that the preview rendering is interrupted and FALSE if the preview rendering can continue.
The function should call fz_rmtl_iface_pview_interrupt frequently. If it returns TRUE, the preview rendering needs to be interrupted and the preview function must return FALSE for the complete argument. For example, the user may have selected an dialog item while the rendering is executing. In order to do this, the rendering needs to stop, controll needs to be returned to the dialog driver, which will handle the user's click. If the user changed a setting, the preview function will be called again with TRUE for the dirty argument, meaning ,that a new image needs to be started. If the user did not make any changes, the preview function will be called with FALSE for the dirty argument. The preview function may then continue the rendering, where it was previously interrupted. If a preview rendering is completed, the complete argument must be returned as TRUE. Again, it is important, that interrupting is handled properly and in a responsive manner to allow the user to interact with the dialog while the rendering is proceeding.

Plugin Prototype

fzrt_error_td fz_rmtl_iface_pview_interrupt(

fz_fuim_tmpl_ptr | fuim_tmpl,
fzrt_boolean * | interrupt )

Parameters

fuim_tmpl [Input]

pointer to fuim template.

interrupt [Result]

TRUE, if there was an event that requires that the preview rendering needs to be interrupted. FALSE othrwise.

Returns

Error codes

Availability

6.0.0.2

See Also

, fz_rmtl_iface_pview_update

Function Set

fz_rmtl_fset

Defined in

fz_rmtl_api.h