formZ SDK | 5.0 API Reference | System | System

# fz_syst_cmnd_set_status_of_objt

Description

Determines whether a tool uses the status of objects option in its tool palette. This function is designed to be called from the fz_tool_cbak_init callback function of a plugin or script tool. if it is not called, the tool identified by its uuid is assumed not to use the status of objects functionality. If this function is called, the opnd_opt and volm_opt parameters determine, whether the Operand option is used (opnd_opt == TRUE) or not (opnd_opt == FALSE) and whether the New Objects option is used (volm_opt == TRUE) or not (volm_opt == FALSE). These options are equivalent to the options presented in the Status Of Objects tabs of the respective modeling tools (Revolve for example). It is up to the tool to make sure, that the status of objects options are also executed by calling the respective API function (, fz_objt_edit_handle_new_objt_volms).

Plugin Prototype

fzrt_error_td fz_syst_cmnd_set_status_of_objt(

fzrt_UUID_td | uuid,
fzrt_boolean | opnd_opt,
fzrt_boolean | volm_opt )

Parameters

uuid [Input]

The uuid of the tool for which to set the status of objects options.

opnd_opt [Input]

Set to TRUE, if the tool will be using the Operands option and FALSE otherwise.

volm_opt [Input]

Set to TRUE, if the tool will be using the New Objects option and FALSE otherwise.

Returns

Error codes

Availability

5.0.0.0

Example Files

util_system_opts.fsl

See Also

fz_syst_get_color_paste

Function Set

fz_syst_fset

Defined in

fz_syst_api.h