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

# fz_lite_get_pick_status

Description

Checks whether a light is picked. The picked parameter also returns whether the coi or the eye or both are picked. For eye, bit 1 (0x00000001) is set, for coi bit 2 (0x00000002) is set. For light types that don't have a specific light vector, such as area lights, this parameter always has both bits set (0x00000001 | 0x00000002) if the light is picked.

Plugin Prototype

fzrt_error_td fz_lite_get_pick_status(

fzrt_int | windex,
fz_lite_ptr | lite,
fzrt_int * | picked )

Parameters

windex [Input]

project window index

lite [Input]

the light for which to get the pick status

picked [Result]

the bit encoded pick status of the light. bit 1 = eye is picked, bit 2 = coi is picked. No bits set = light is not picked

Returns

Error codes

Availability

6.0.0.5

Example Files

util_lights.fsl

Function Set

fz_lite_fset

Defined in

fz_lite_api.h