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

# fz_objt_edit_trim_with_line

Description

Trims object 1 with object 2.
Object 2 must be an open or closed planar wire. norm indicates the direction along which the cutting wire is projected. If keep_positive is TRUE, the part of object 1 which is on the positive side (relative to norm) of object 2 is kept. Otherwise the part of object 1 which is on the negative side of object 2 is kept. 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.

Plugin Prototype

fzrt_error_td fz_objt_edit_trim_with_line(

fzrt_int | windex,
fz_objt_ptr | obj1,
fz_objt_ptr | obj2,
fz_xyz_td * | norm,
fzrt_boolean | keep_positive,
fzrt_boolean | do_stitch,
fzrt_boolean | join_volumes,
fz_enty_list_ptr | ent_list )

Parameters

windex [Input]

project window index

obj1 [Input]

object 1

obj2 [Input]

object 2 (must be an open or closed planar wire)

norm [Input]

indicates the direction along which the cutting wire is projected

keep_positive [Input]

if TRUE, the part of object 1 which is on the positive side of object 2 is kept, otherwise the part of object 1 which is on the negative side of object 2 is kept

do_stitch [Input]

if TRUE, the part of object 1 which is kept, is stitched to the extruded line if the line of intersection between the objects is closed

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

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