formZ SDK | 4.0 Call Back Reference | Command | Tool

# fz_tool_cbak_pick_valid_func

Description

Tool pick valid filter (Recommended). For the tool this function is called for each item in the pick buffer or items that could be added via post pick to determine if they are valid for the tool. If this function is not provided, all visible, pickable ettities can be picked by the user.

Plugin Prototype

fzrt_error_td fz_tool_cbak_pick_valid_func(

fzrt_int | windex,
fzrt_int | set_id,
fzrt_UUID_td | type,
fz_tag_td * | item_tag,
fzrt_UUID_td | part_class,
fzrt_int | part_id,
fzrt_UUID_td | sub_part_class,
fzrt_int | sub_part_id,
fzrt_boolean * | valid )

Parameters

windex [Input]

project window index

set_id [Input]

pick set id

type [Input]

pick canidate type

item_tag [Input]

pick canidate tag

part_class [Input]

pick canidate part type

part_id [Input]

pick canidate part id

sub_part_class [Input]

pick canidate sub part type

sub_part_id [Input]

pick canidate sub part id

valid [Result]

pick canidate is vbalie (TRUE/FALSE)

Returns

Error codes

Availability

7.0.0.0

See Also

fz_tool_cbak_info,

Function Set

Defined in

fz_tool_api.h