formZ SDK | 5.0 API Reference | Project | Modeling | Lights Manager
Description
Performs a pick action among the lights 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 light was clicked on with the screen point, the light may be picked or unpicked, based on the previous pick status of the light. If no light was picked, lite will be passed back as NULL. If a valid light was picked or unpicked it is passed back. The api function can then be called to determine the pick status of the light.
Plugin Prototype
fzrt_error_td fz_lite_pick(
fzrt_int | windex, |
screen_pnt, | |
lite ) |
Parameters
windex [Input]
project window index
screen_pnt [Input]
the screen point where the mouse was clicked
lite [Result]
the light which was picked or unpicked by the mouse click
Returns
Error codes
Availability
6.0.0.5
Example Files
Function Set
Defined in