formZ SDK | 5.0 API Reference | Project | Modeling | View Manager

# fz_view_pick

Description

Performs a pick action among the views of a project, based on the screen point passed in. This screen point is usually supplied by formZ in a click callback function such as the click function of a tool plugin. Note, that if a view was clicked on with the screen point, the view may be picked or unpicked, based on the previous pick status of the view. If no view was picked, view will be passed back as NULL. If a valid view was picked or unpicked it is passed back. The api function can then be called to determine the pick status of the view.

Plugin Prototype

fzrt_error_td fz_view_pick(

fzrt_int | windex,
fzrt_point * | screen_pnt,
fz_view_ptr * | view )

Parameters

windex [Input]

project window index

screen_pnt [Input]

the screen point where the mouse was clicked

view [Result]

the view which was picked or unpicked by the mouse click

Returns

Error codes

Availability

6.0.0.5

Example Files

util_views.fsl

Function Set

fz_view_fset

Defined in

fz_view_api.h