formZ SDK | 4.0 Call Back Reference | Command | Tool
Description
Tool Undo (Optional). This function is called by formZ when the user selects the undo menu
item from the Edit menu during the execution of the tool. This function is used to back the input
up to the state of the previous click. If this function is not provided, the tool does not perform undos
during the use of the tool.
The click_count parameter is the number of clicks which will be one less than the last call to the
click or prompt functions. The click_wait parameter tells formZ to wait until a specific type of
click happens before calling the click function again. The done parameter determines the completion
of the tool. A value of TRUE indicates that the tool is done, a value of FALSE indicates that the tool
expects more clicks. The default is FALSE.
Plugin Prototype
fzrt_error_td fz_tool_cbak_undo(
fzrt_int | windex, |
where, | |
where_3d, | |
map_plane, | |
fzrt_int | click_count, |
click_wait, | |
done ) |
Parameters
windex [Input]
project window index
where [Input]
point on screen where is currently located
where_3d [Input]
point in world space (on active reference plan or snapped location)
map_plane [Input]
active map plane
click_count [Input]
count of clicks for tool (1 for first click, 2 for second etc...)
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
Function Set
Defined in