formZ SDK | 5.0 API Reference | Project | Modeling | Lights Manager
Description
Common parameter identifiers for a light. Used for the "which" argument of fz_lite_get_parm_common and fz_lite_set_parm_common
enum fz_lite_parm_common_enum {
FZ_LITE_PARM_NAME,
FZ_LITE_PARM_TYPE,
FZ_LITE_PARM_COLOR,
FZ_LITE_PARM_ACCURATE_INTENS_ON,
FZ_LITE_PARM_ACCURATE_INTENS_RADIOS_ON,
FZ_LITE_PARM_ACCURATE_INTENS_WATTS,
FZ_LITE_PARM_ACCURATE_INTENS_EFFICIENCY,
FZ_LITE_PARM_ACCURATE_INTENS_COLTEMP,
FZ_LITE_PARM_ACCURATE_INTENS_LUMENS,
FZ_LITE_PARM_SIMPLE_INTENS,
FZ_LITE_PARM_SIMPLE_FALLOFF,
FZ_LITE_PARM_ORIGIN,
FZ_LITE_PARM_COI,
FZ_LITE_PARM_VISIBILITY,
FZ_LITE_PARM_LOCKED_ON,
FZ_LITE_PARM_SHINING_ON,
FZ_LITE_PARM_LENSFLARE_ON,
FZ_LITE_PARM_GLOW_ON,
FZ_LITE_PARM_SHADOWS_ON,
FZ_LITE_PARM_SHADOW_TYPE,
FZ_LITE_PARM_TRANS_SHADOWS_ON,
FZ_LITE_PARM_SHADOW_MAP_QUALITY,
FZ_LITE_PARM_SHADOW_MAP_SOFTNESS,
FZ_LITE_PARM_SHADOW_MAP_TOLERANCE,
FZ_LITE_PARM_SHADOW_MAP_FIXED_RES_ON,
FZ_LITE_PARM_SHADOW_MAP_RES_IMAGESIZE,
FZ_LITE_PARM_SHADOW_MAP_RES_FIXED,
FZ_LITE_PARM_SHADOW_MAP_LIMIT,
FZ_LITE_PARM_GLOW_ACCURATE_ON,
FZ_LITE_PARM_GLOW_SIMPLE_INTENS,
FZ_LITE_PARM_GLOW_SIMPLE_FALLOFF,
FZ_LITE_PARM_GLOW_SIMPLE_LIGHT_DIST_ON,
FZ_LITE_PARM_GLOW_SIMPLE_DIST,
FZ_LITE_PARM_GLOW_ACCURATE_INTENS,
FZ_LITE_PARM_GLOW_ACCURATE_ATTENUATION,
FZ_LITE_PARM_GLOW_ACCURATE_MAX_DIST,
FZ_LITE_PARM_GLOW_ACCURATE_QUALITY,
FZ_LITE_PARM_GLOW_ACCURATE_NOISE_ON,
FZ_LITE_PARM_GLOW_ACCURATE_NOISE_SIZE,
FZ_LITE_PARM_GLOW_ACCURATE_NOISE_TYPE,
FZ_LITE_PARM_GLOW_ACCURATE_NOISE_NUM_IMPULSE,
FZ_LITE_PARM_GLOW_ACCURATE_NOISE_CONTRAST,
FZ_LITE_PARM_GLOW_ACCURATE_NOISE_DETAIL,
FZ_LITE_PARM_ACCURATE_INTENS_COLTEMP_ON };
Members
FZ_LITE_PARM_NAME
Light name (32 characters max)
Type: char*
FZ_LITE_PARM_TYPE
Light type
Type: fz_lite_type_enum
Default Value: FZ_LITE_TYPE_DISTANT
FZ_LITE_PARM_COLOR
Light color
Type: fz_rgb_float_td
Default Value: white {1.0,1.0,1.0}
FZ_LITE_PARM_ACCURATE_INTENS_ON
Use Light's accurate intensity
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_PARM_ACCURATE_INTENS_RADIOS_ON
If on, accurate radiometric intensity (Watts) is used. Otherwise the photometric intensity (lumens, candelas) is used.
Type: fzrt_boolean
Default Value: TRUE
FZ_LITE_PARM_ACCURATE_INTENS_WATTS
Radiometric light intensity, expressed in watts.
Type: double
Default Value: 100.0
Range: value >= 0.0
FZ_LITE_PARM_ACCURATE_INTENS_EFFICIENCY
Efficiency of a light's radiometric intensity.
Type: double
Default Value: 0.5
Range: 0.0 <= value <= 1.0
FZ_LITE_PARM_ACCURATE_INTENS_COLTEMP
The photometric intensity's color temperature in degrees Kelvin. Meaningful values are in the range of 1000 to 10000 degrees Kelvin, but larger values are allowed.
Type: double
Default Value: 2000
Range: value >= 1000
FZ_LITE_PARM_ACCURATE_INTENS_LUMENS
Photometric light intensity, expressed in lumens.
Type: double
Default Value: 1000
Range: value >= 0.0
FZ_LITE_PARM_SIMPLE_INTENS
Simple light intensity. A value of 1.0 means 100%. Negative values are allowed, meaning that the light source will suck light away from the scene, instead of adding to it.
Type: double
Default Value: 1.0
FZ_LITE_PARM_SIMPLE_FALLOFF
Light falloff.
Type: fz_lite_falloff_enum
Default Value: FZ_LITE_FALLOFF_CONSTANT
FZ_LITE_PARM_ORIGIN
The coordinates of the light's origin.
Type: fz_xyz_td
FZ_LITE_PARM_COI
The coordinates of the light's center of interest.
Type: fz_xyz_td
FZ_LITE_PARM_VISIBILITY
The light's visibility status, when drawn in an interactive rendering mode.
Type: fz_lite_visible_enum
Default Value: FZ_LITE_VISIBILITY_INVISIBLE
FZ_LITE_PARM_LOCKED_ON
The light's lock status.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_PARM_SHINING_ON
The light's shining status.
Type: fzrt_boolean
Default Value: TRUE
FZ_LITE_PARM_LENSFLARE_ON
Light lens flares on/off
Type: fzrt_boolean
Default Value: TRUE
FZ_LITE_PARM_GLOW_ON
Light glow on/off
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_PARM_SHADOWS_ON
Light shadows on/off
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_PARM_SHADOW_TYPE
Light shadow type
Type: fz_lite_smap_type_enum
Default Value: FZ_LITE_SHAD_TYPE_MAP
FZ_LITE_PARM_TRANS_SHADOWS_ON
Transparent shadows on/off
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_PARM_SHADOW_MAP_QUALITY
Shadow map quality
Type: fz_lite_smap_quality_enum
Default Value: FZ_LITE_SHAD_MAP_QUALITY_MEDIUM
FZ_LITE_PARM_SHADOW_MAP_SOFTNESS
Shadow map softness. 1.0 mean 100%. Meaningful values are in the range of 0.0 to 1.0.
Type: double
Default Value: 0.0
Range: value >= 0.0
FZ_LITE_PARM_SHADOW_MAP_TOLERANCE
Shadow map tolerance. 1.0 mean 100%. Meaningful values are in the range of 0.0 to 1.0.
Type: double
Default Value: 0.0
Range: value >= 0.0
FZ_LITE_PARM_SHADOW_MAP_FIXED_RES_ON
Shadow map fixed resolution on/off. If FALSE, the shadow map resolution is determined as a factor of the image size. if TRUE, the resolution is defined by a fixed number.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_PARM_SHADOW_MAP_RES_IMAGESIZE
Shadow map resolution as a factor of the image size.
Type: double
Default Value: 1.0
Range: value > 0.0
FZ_LITE_PARM_SHADOW_MAP_RES_FIXED
Shadow map resolution as a fixed value.
Type: fzrt_int
Default Value: 512
Range: value >= 64
FZ_LITE_PARM_SHADOW_MAP_LIMIT
The type of shadow map limit for a distant light.
Type: fz_lite_smap_limit_enum
Default Value: FZ_LITE_SHAD_MAP_LIMIT_ALL
FZ_LITE_PARM_GLOW_ACCURATE_ON
Accurate light glow on/off.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_PARM_GLOW_SIMPLE_INTENS
Simple glow intensity. A value of 1.0 means 100%.
Type: double
Default Value: 0.5
Range: value >= 0.0
FZ_LITE_PARM_GLOW_SIMPLE_FALLOFF
Simple glow falloff
Type: fz_lite_glow_falloff_enum
Default Value: FZ_LITE_GLOW_SIMPLE_FALLOF_SQUARE
FZ_LITE_PARM_GLOW_SIMPLE_LIGHT_DIST_ON
Simple glow by user specified distance on/off.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_PARM_GLOW_SIMPLE_DIST
User specified simple glow distance.
Type: double
Default Value: English 120.0 in, Metric 500.0 cm
Range: value > 0.0
FZ_LITE_PARM_GLOW_ACCURATE_INTENS
Accurate glow intensity. A value of 1.0 means 100%.
Type: double
Default Value: 0.5
Range: value >= 0.0
FZ_LITE_PARM_GLOW_ACCURATE_ATTENUATION
Accurate glow attenuation. A value of 1.0 means 100%.
Type: double
Default Value: 0.0
Range: 0.0 <= value <= 1.0
FZ_LITE_PARM_GLOW_ACCURATE_MAX_DIST
Accurate glow maximum distance.
Type: double
Default Value: English 1200.0 in, Metric 5000.0 cm
Range: value > 0.0
FZ_LITE_PARM_GLOW_ACCURATE_QUALITY
Accurate glow quality.
Type: fzrt_int
Default Value: 5
Range: 1 <= value <= 10
FZ_LITE_PARM_GLOW_ACCURATE_NOISE_ON
Accurate glow noise on/off.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_PARM_GLOW_ACCURATE_NOISE_SIZE
Accurate glow noise size interval.
Type: double
Default Value: English 48.0 in, Metric 100.0 cm
Range: value > 0.0
FZ_LITE_PARM_GLOW_ACCURATE_NOISE_TYPE
Accurate glow noise type.
Type: fz_lite_glow_noise_enum
Default Value: FZ_LITE_GLOW_ACCURATE_NOISE_TYPE_BETTER
FZ_LITE_PARM_GLOW_ACCURATE_NOISE_NUM_IMPULSE
Accurate glow noise, # of impulses.
Type: fzrt_int
Default Value: 3
Range: 1 <= value <= 10
FZ_LITE_PARM_GLOW_ACCURATE_NOISE_CONTRAST
Accurate glow noise contrast.
Type: double
Default Value: 1.0
Range: 0.0 <= value <= 1.0
FZ_LITE_PARM_GLOW_ACCURATE_NOISE_DETAIL
Accurate glow noise detail.
Type: fzrt_int
Default Value: 3
Range: 1 <= value <= 10
FZ_LITE_PARM_ACCURATE_INTENS_COLTEMP_ON
Whether or not the Color Temperature is used for the Photometric Accurate light intensity
Type: fzrt_boolean
Default Value: FALSE
Availability: 6.1.2.0
Availability
5.0.0.0
See Also
Defined in