formZ SDK | 5.0 API Reference | Project | Modeling | Lights Manager
Description
Gets one of the unique parameters of an area light.
If the display parameter is TRUE, the parameter value returned
reflects the light parameters as used when a scene is displayed.
That is, if the light is in a light group and the group's
override option is on for that parameter, the override
parameter is returned.
If the display parameter is FALSE, the true parameter of the light
is returned.
Not all parameters of a light have an equivalent override parameter
in the light group.
In that case, the true parameter of the light is always returned,
regardless of the display parameter.
Note: the object pointer retrieved from the area light needs to be
handled with care.
The content of this object cannot be edited, the object cannot be deleted.
This function is now obsolete. Use and instead.
Plugin Prototype
fzrt_error_td fz_lite_get_parm_area_obsolete(
fzrt_int | windex, |
lite, | |
which, | |
display, | |
data ) |
Parameters
windex [Input]
project window index
lite [Input]
area light
which [Input]
parameter identifier
display [Input]
if TRUE, the display parameter is returned, otherwise the true parameter is returned
data [Result]
parameter data
Returns
Error codes
Availability
5.0.0.0
Example Files
See Also
fz_lite_set_parm_area
Function Set
Defined in