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

# fz_lite_get_parm_custom_data

Description

Gets a parameter of a custom light's distribution data. When retrieving the FZ_LITE_PARM_CUSTOM_DATA_VERTANG parameter, the data argument must contain a pointer to an array of doubles, which is large enough to hold FZ_LITE_PARM_CUSTOM_DATA_NUMVERT values. It is the responsibility of the calling function to allocate this array.
When retrieving the FZ_LITE_PARM_CUSTOM_DATA_HORIZANG parameter, the data argument must contain a pointer to an array of doubles, which is large enough to hold FZ_LITE_PARM_CUSTOM_DATA_NUMHORIZ values. It is the responsibility of the calling function to allocate this array.
When retrieving the FZ_LITE_PARM_CUSTOM_DATA_VALUES parameter, the data argument must contain a pointer to an array of doubles, which is large enough to hold FZ_LITE_PARM_CUSTOM_DATA_NUMVERT * FZ_LITE_PARM_CUSTOM_DATA_NUMHORIZ values. It is the responsibility of the calling function to allocate this array. The values will be ordered in vertical major order:
values[0] = value at vertical angle 0 , horizontal angle 0
values[1] = value at vertical angle 1 , horizontal angle 0
values[2] = value at vertical angle 2 , horizontal angle 0
.
.
.
values[numvert-1] = value at vertical angle numvert-1 , horizontal angle 0
values[numvert * 1 + 0] = value at vertical angle 0 , horizontal angle 1
values[numvert * 1 + 1] = value at vertical angle 1 , horizontal angle 1
values[numvert * 1 + 2] = value at vertical angle 2 , horizontal angle 1
.
.
.
values[numvert * 1 + numvert-1] = value at vertical angle numvert-1 , horizontal angle 1
values[numvert * 2 + 0] = value at vertical angle 0 , horizontal angle 2
values[numvert * 2 + 1] = value at vertical angle 1 , horizontal angle 2
values[numvert * 2 + 2] = value at vertical angle 2 , horizontal angle 2
.
.
.
values[numvert * 2 + numvert-1] = value at vertical angle numvert-1 , horizontal angle 2
values[numvert * (numhorz-1) + 0] = value at vertical angle 0 , horizontal angle numhorz-1
values[numvert * (numhorz-1) + 1] = value at vertical angle 1 , horizontal angle numhorz-1
values[numvert * (numhorz-1) + 2] = value at vertical angle 2 , horizontal angle numhorz-1
.
.
.
values[numvert * (numhorz-1) + numvert-1] = value at vertical angle numvert-1 , horizontal angle numhorz-1

Plugin Prototype

fzrt_error_td fz_lite_get_parm_custom_data(

fzrt_int | windex,
fz_lite_custom_data_ptr | cust_data,
fz_lite_parm_cust_data_enum | which,
fz_type_td * | data )

Parameters

windex [Input]

project window index

cust_data [Input]

edit options

which [Input]

parameter identifier

data [Result]

parameter data

Returns

Error codes

Availability

5.0.0.0

Example Files

util_lights.fsl

See Also

Function Set

fz_lite_fset

Defined in

fz_lite_api.h