formZ SDK | 4.0 Call Back Reference | Command | Tool

fz_tool_cbak_click

Description

Tool click. This function is called by formZ for FZ_TOOL_KIND_OPERATOR tools when the tool is the active tool and the mouse is clicked.

Plugin Prototype

fzrt_error_td fz_tool_cbak_click(

fzrt_int

windex,

fzrt_point *

where,

fz_xyz_td *

where_3d,

fz_map_plane_td *

map_plane,

fz_fuim_click_enum

clicks,

fzrt_int

click_count,

fzrt_boolean *

click_handled,

fz_fuim_click_wait_enum *

click_wait,

fzrt_boolean *

done )

Parameters

windex [Input]

project window index

where [Input]

point on screen where mouse was clicked

where_3d [Input]

point in world space (on active reference plane or snapped location)

map_plane [Input]

active map plane

clicks [Input]

current clicks

click_count [Input]

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

click_handled [Result]

TRUE for clicked handled, FALSE if NOT

click_wait [Result]

wait status for next click (default = FZ_FUIM_CLICK_WAIT_NOT)

done [Result]

TRUE for tool complete, FALSE if not complete

Returns

Error codes

Availability

5.0.0.0

See Also

fz_tool_cbak_click_up, fz_tool_cbak_track,fz_tool_cbak_prompt, fz_tool_cbak_cancel, fz_fuim_prompt_line

Function Set

fz_tool_cbak_fset


Defined in

fz_tool_api.h