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

# fz_objt_edit_handle_new_objt_volms

Description

Handles the New Objects functionality in the Status of Objects tab of tools. This function should be called by a tool plugin or script, after two or more new objects were created. The new objects are left alone, or are joined into a single volume, based on the setting in the Status tab of the respective tool options dialog. The objects are passed in via the entity_list argument. If the objects are joined, the entity list will contain one final object, which is a new object. The original objects whose volumes were joined to the new object are deleted. The was_joined argument indicates whether anything was joined. 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_new_objt_volms(

fzrt_int | windex,
fz_enty_list_ptr | objt_list,
fzrt_boolean * | was_joined )

Parameters

windex [Input]

project window index

objt_list [Input, Result]

list with the object pointers

was_joined [Result, Optional]

TRUE if anything was joined, FALSE otherwise

Returns

Error codes

Availability

5.0.0.0

Function Set

fz_model_fset

Defined in

fz_objt_api.h