formZ SDK | 4.0 Call Back Reference | Command | Tool

# fz_tool_cbak_action

Description

Tool info (Required if fz_tool_cbak_info not defined, else Recommended). The function is called at various times for formZ to get information about the characteristics of the tool. This function is called once by formZ as soon as the tool is registered and initialized with which == FZ_TOOL_INFO_LEVEL and which == FZ_TOOL_INFO_KIND. Returning and error other than TRUE will cause the tool NOT to be registered It establishes the level and kind of the tool. The level distinguishes the context of the tool (, modeling, drafting, window etc.). The kind tells formZ if the tool is an operator or a modifier.

Plugin Prototype

fzrt_boolean fz_tool_cbak_action(

fzrt_int | windex,
fz_tool_action_enum | which,
fzrt_int | set_id,
fzrt_int | click_count,
char * | action_string,
fzrt_int | action_string_length )

Parameters

windex [Input]

project window index

which [Input]

parameter identifier

set_id [Input]

pick set id

click_count [Input]

count of clicks for tool (1 for first click, 2 for second etc...)

action_string [Input]

parameter data

action_string_length [Input]

parameter data

Returns

TRUE if handled which, else FALSE

Availability

7.0.0.0

See Also

fz_tool_cbak_info,,

Function Set

fz_tool_cbak_fset

Defined in

fz_tool_api.h