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

# fz_objt_edit_bool_split

Description

Splits object 1 with object 2.
The two objects must be of compatible types : solid + solid or surface + surface.
As it is possible that more than one object is created, the pointers of the resulting objects are stored in the entity list passed in.
If one_way is TRUE, object 1 is split with object 2. Otherwise both objects are split against each other (two way split).

Plugin Prototype

fzrt_error_td fz_objt_edit_bool_split(

fzrt_int | windex,
fz_objt_ptr | obj1,
fz_objt_ptr | obj2,
fzrt_boolean | one_way,
fzrt_boolean | join_volumes,
fz_enty_list_ptr | ent_list )

Parameters

windex [Input]

project window index

obj1 [Input]

object 1 (must be solid or surface and same type as object 2)

obj2 [Input]

object 2 (must be solid or surface and same type as object 1)

one_way [Input]

if TRUE, object 1 is split with object 2, otherwise both objects are split against each other (two way split)

join_volumes [Input]

If set to TRUE, all resulting volumes will be joined into one object. Otherwise, one object per volume will be created.

ent_list [Result]

list with new object pointers

Returns

Error codes

Availability

5.0.0.0

Example Files

util_objt_boolean.fsl

See Also

,,, fz_objt_edit_trim_with_surface,,, fz_objt_edit_split_with_line, fz_objt_edit_stitch_faces,, , fz_objt_edit_section3d, fz_objt_edit_section2d, fz_objt_edit_volumes_join,

Function Set

fz_model_fset

Defined in

fz_objt_api.h