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

# fz_lite_set_pick_status

Description

Sets the pick status of a light. If picked is passed as 0, the light is unpicked. For lights with a direction vector, such as a cone light, the eye and coi can be picked separately. If the 1 bit is set (0x00000001) the eye is picked. If bit 2 is set (0x00000002) the coi is picked. For ligths without a direction vector, such as area lights, no such distinction is necessary and picked must be passed as 1 for all cases. Note, that only bits 1 and 2 are checked. Any other bits are ignored.

Plugin Prototype

fzrt_error_td fz_lite_set_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 set the pick status

picked [Input]

the bit encoded pick status of the light. bit 1 = set pick of eye, bit 2 = set pick of coi. not bits set = set light to 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