formZ SDK | 5.0 API Reference | Project | Modeling | Lights Manager
Description
Parameter identifiers for a distant light. Used for the "which" argument of fz_lite_get_parm_dist and fz_lite_set_parm_dist
enum fz_lite_parm_dist_enum {
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_ON_OBSOLETE,
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_SIMPLE_ON_OBSOLETE,
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_ACC_QUALITY_OBSOLETE,
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_ACC_LUMINANCE_OBSOLETE,
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_ACC_COVER_OBSOLETE,
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_ACC_COLOR_OBSOLETE,
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_SIMPLE_INTENS_OBSOLETE,
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_SIMPLE_NOISE_OBSOLETE,
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_SIMPLE_SAMPLES_OBSOLETE,
FZ_LITE_PARM_DIST_SUN,
FZ_LITE_PARM_DIST_SKY_ON,
FZ_LITE_PARM_DIST_SKY_SIMPLE_ON,
FZ_LITE_PARM_DIST_SKY_ACC_QUALITY,
FZ_LITE_PARM_DIST_SKY_ACC_LUMINANCE,
FZ_LITE_PARM_DIST_SKY_ACC_COVER,
FZ_LITE_PARM_DIST_SKY_ACC_COLOR_BY_TEMP,
FZ_LITE_PARM_DIST_SKY_ACC_COLOR_TEMP,
FZ_LITE_PARM_DIST_SKY_ACC_COLOR_PRESET,
FZ_LITE_PARM_DIST_SKY_SIMPLE_INTENS,
FZ_LITE_PARM_DIST_SKY_SIMPLE_SAMPLES,
FZ_LITE_PARM_DIST_SKY_COLOR,
FZ_LITE_PARM_DIST_SKY_NOISE };
Members
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_ON_OBSOLETE
Use the atmospheric option for accurate distant light intensity. Obsolete: 6.5.0.0. Replaced by FZ_LITE_PARM_DIST_SKY_ON.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_SIMPLE_ON_OBSOLETE
Use the simple atmospheric parameters . Obsolete: 6.5.0.0. Replaced by FZ_LITE_PARM_DIST_SKY_SIMPLE_ON.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_ACC_QUALITY_OBSOLETE
Accurate sky parameter : Quality of the atmospheric light. Obsolete: 6.5.0.0. Replaced by FZ_LITE_PARM_DIST_SKY_ACC_QUALITY.
Type: double
Default Value: 0.5
Range: 0.0 <= value <= 1.0
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_ACC_LUMINANCE_OBSOLETE
Accurate sky parameter : Luminance value of the atmospheric light in candelas / sqft or candelas / sqMeter. Obsolete: 6.5.0.0. Replaced by FZ_LITE_PARM_DIST_SKY_ACC_LUMINANCE.
Type: double
Default Value: 50
Range: value >= 0.0
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_ACC_COVER_OBSOLETE
Accurate sky parameter : Cloud coverage type of the atmospheric light. Obsolete: 6.5.0.0. Replaced by FZ_LITE_PARM_DIST_SKY_ACC_COVER.
Type: fz_lite_parm_sky_intens_enum
Default Value: FZ_LITE_DIST_ACCURATE_INTENS_SKY_OVERCAST
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_ACC_COLOR_OBSOLETE
Accurate sky parameter : Color type of the atmospheric light. Obsolete: 6.5.0.0. Replaced by FZ_LITE_PARM_DIST_SKY_ACC_COLOR_PRESET.
Type: fz_lite_parm_sky_color_enum
Default Value: FZ_LITE_DIST_ACCURATE_INTENS_SKY_LIGHTBLUE
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_SIMPLE_INTENS_OBSOLETE
Simple sky parameter : sky intensity. Obsolete: 6.5.0.0. Replaced by FZ_LITE_PARM_DIST_SKY_SIMPLE_INTENS.
Type: double
Range: value >= 0.0
Default Value: 1.0
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_SIMPLE_NOISE_OBSOLETE
Simple sky parameter : sky noise. Obsolete: 6.5.0.0. Replaced by FZ_LITE_PARM_DIST_SKY_NOISE.
Type: double
Range: 0.0 <= value <= 1.0
Default Value: 0.0
FZ_LITE_PARM_DIST_ACCURATE_INTENS_SKY_SIMPLE_SAMPLES_OBSOLETE
Simple sky parameter : # of samples. Obsolete: 6.5.0.0. Replaced by FZ_LITE_PARM_DIST_SKY_SIMPLE_SAMPLES.
Type: fzrt_int
Range: value >= 3
Default Value: 10
FZ_LITE_PARM_DIST_SUN
The sun data of a distant light.
Type: fz_lite_sun_ptr
FZ_LITE_PARM_DIST_SKY_ON
Apply the atmospheric light also for this distant light.
Type: fzrt_boolean
Default Value: FALSE
Availability: 6.5.0.0
FZ_LITE_PARM_DIST_SKY_SIMPLE_ON
Use the simple atmospheric parameters. If FALSE, then the accurate atmospheric parameters are used.
Type: fzrt_boolean
Default Value: TRUE
Availability: 6.5.0.0
FZ_LITE_PARM_DIST_SKY_ACC_QUALITY
Accurate sky parameter : Quality of the atmospheric light.
Type: double
Default Value: 0.5
Range: 0.0 <= value <= 1.0
Availability: 6.5.0.0
FZ_LITE_PARM_DIST_SKY_ACC_LUMINANCE
Accurate sky parameter : Luminance value of the atmospheric light (in candelas / sqft or candelas / sqMeter).
Type: double
Default Value: 50
Range: value >= 0.0
Availability: 6.5.0.0
FZ_LITE_PARM_DIST_SKY_ACC_COVER
Accurate sky parameter : Cloud coverage type of the atmospheric light.
Type: fz_lite_parm_sky_intens_enum
Default Value: FZ_LITE_DIST_ACCURATE_INTENS_SKY_OVERCAST
Availability: 6.5.0.0
FZ_LITE_PARM_DIST_SKY_ACC_COLOR_BY_TEMP
Accurate sky parameter : If TRUE, the color of sky is determined by color temperature (in Kelvin) of FZ_LITE_PARM_DIST_SKY_ACC_COLOR_TEMP. If FALSE, the color is determined by the specified color of FZ_LITE_PARM_DIST_SKY_COLOR.
Type: fzrt_boolean
Default Value: FALSE
Availability: 6.5.0.0
FZ_LITE_PARM_DIST_SKY_ACC_COLOR_TEMP
Accurate sky parameter : Color of sky is determined by this color temperature (in kelvin) if FZ_LITE_PARM_DIST_SKY_ACC_COLOR_BY_TEMP is TRUE.
Type: float
Default Value: 6500
Availability: 6.5.0.0
FZ_LITE_PARM_DIST_SKY_ACC_COLOR_PRESET
Accurate sky parameter : Color temperature preset of the atmospheric light. This assigns the color temperature to a preset value. Useful only if the FZ_LITE_PARM_DIST_SKY_ACC_COLOR_BY_TEMP parameter is set to TRUE.
Type: fz_lite_parm_sky_color_enum
Default Value: FZ_LITE_DIST_ACCURATE_INTENS_SKY_LIGHTBLUE
Availability: 6.5.0.0
FZ_LITE_PARM_DIST_SKY_SIMPLE_INTENS
Simple sky parameter : sky intensity.
Type: double
Range: value >= 0.0
Default Value: 1.0
Availability: 6.5.0.0
FZ_LITE_PARM_DIST_SKY_SIMPLE_SAMPLES
Simple sky parameter : # of samples.
Type: fzrt_int
Range: value >= 3
Default Value: 10
Availability: 6.5.0.0
FZ_LITE_PARM_DIST_SKY_COLOR
Sky parameter : sky color.
Type: fz_rgb_float_td
Default Value: white (1,1,1)
Availability: 6.5.0.0
FZ_LITE_PARM_DIST_SKY_NOISE
Sky parameter : sky noise.
Type: double
Range: 0.0 <= value <= 1.0
Default Value: 0.0
Availability: 6.5.0.0
Availability
5.0.0.0
See Also
Defined in