formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Editing Operations

# fz_objt_edit_handle_status_of_opnd

Description

Handles the Operand functionality in the Status of Objects tab of tools. This function should be called by a tool plugin or script, after a new object was created from an existing object. The existing object will be deleted, kept or ghosted based on the setting in the Status tab of the respective tool options dialog. If the inherit_clone_data option is set to TRUE and the original object was a clone, the new object inherits the clone information from the original object. This option should only be set to TRUE, if the new object is not radically different from the original object (i.e. there is some resemblance left over, so that the use can see that the new object is derived from the original object). Note, that the tool also needs to initialize its status of objects options in the fz_tool_cbak_init callback function by calling the api fz_syst_cmnd_set_status_of_objt with the appropriate arguments.

Plugin Prototype

fzrt_error_td fz_objt_edit_handle_status_of_opnd(

fzrt_int | windex,
fz_objt_ptr | org_objt,
fz_objt_ptr | new_objt,
fzrt_boolean | inherit_clone_data )

Parameters

windex [Input]

project window index

org_objt [Input]

the original object

new_objt [Input, Optional]

the new object. if inherit_clone_data is set to TRUE, this argument cannot be NULL.

inherit_clone_data [Input]

TRUE, if clone information needs to be inherited by the new object, FALSE otherwise

Returns

Error codes

Availability

5.0.0.0

Function Set

fz_model_fset

Defined in

fz_objt_api.h