formZ SDK | 5.0 API Reference | Project | Modeling | Lights Manager
Description
Parameter identifiers for a light group. Used for the "which" argument of fz_lite_grup_get_parm and fz_lite_grup_set_parm. When getting the FZ_LITE_GROUP_PARM_VISIBILITY, FZ_LITE_GROUP_PARM_LOCKED_ON, FZ_LITE_GROUP_PARM_SHINING_ON or FZ_LITE_GROUP_PARM_SHADOWS_ON parameters through fz_lite_grup_get_parm, the value may be -1 if the status of the respective attribute is different between the individual lights contained in the group.
enum fz_lite_parm_grup_enum {
FZ_LITE_GROUP_PARM_NAME,
FZ_LITE_GROUP_PARM_VISIBILITY,
FZ_LITE_GROUP_PARM_LOCKED_ON,
FZ_LITE_GROUP_PARM_SHINING_ON,
FZ_LITE_GROUP_PARM_SHADOWS_ON,
FZ_LITE_GROUP_PARM_OVERRIDE_COLOR_ON,
FZ_LITE_GROUP_PARM_OVERRIDE_COLOR,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_ON,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ON,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_SIMPLE_ON_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_SIMPLE_FACTOR,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_FALLOFF,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_RADIOS_ON_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_WATTS_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_EFFICIENCY_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_COLTEMP_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_LUMENS_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_SKY_ON_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_SKY_QUALITY_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_SKY_LUMINANCE_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_SKY_COVER_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_SKY_COLOR_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_SCALE_FACTOR,
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_ON_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_TYPE_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_TRANSP_ON_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_MAP_QUALITY_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_MAP_SOFTNESS_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_MAP_TOLERANCE_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_MAP_FIXED_RES_ON_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_MAP_RES_IMAGESIZE_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_MAP_RES_FIXED_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_MAP_LIMIT_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ON_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_GLOW_ON_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_ON_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_SIMPLE_INTENS_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_SIMPLE_FALLOFF_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_SIMPLE_LIGHT_DIST_ON_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_SIMPLE_DIST_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_INTENS_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_ATTENUATION_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_MAX_DIST_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_QUALITY_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_NOISE_ON_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_NOISE_SIZE_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_NOISE_TYPE_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_NOISE_NIMPULSE_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_NOISE_CONTRAST_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_NOISE_DETAIL_OBSOLETE,
FZ_LITE_GROUP_PARM_OVERRIDE_RADANG_ON,
FZ_LITE_GROUP_PARM_OVERRIDE_RADANG_RADIUS,
FZ_LITE_GROUP_PARM_OVERRIDE_RADANG_OUTER_ANGLE,
FZ_LITE_GROUP_PARM_OVERRIDE_RADANG_INNER_ANGLE };
Members
FZ_LITE_GROUP_PARM_NAME
Light group name (32 characters max).
Type: char*
FZ_LITE_GROUP_PARM_VISIBILITY
Light group visibility status.
Type: fz_lite_visible_enum or -1 when getting this parameter
Default Value: FZ_LITE_VISIBILITY_INVISIBLE
FZ_LITE_GROUP_PARM_LOCKED_ON
Light group locked on status.
Type: fzrt_int, TRUE/FALSE or -1 when getting this parameter
Default Value: FALSE
FZ_LITE_GROUP_PARM_SHINING_ON
Light group shining on status.
Type: fzrt_int, TRUE/FALSE or -1 when getting this parameter
Default Value: TRUE
FZ_LITE_GROUP_PARM_SHADOWS_ON
Light group shadows on status.
Type: fzrt_int, TRUE/FALSE or -1 when getting this parameter
Default Value: TRUE
FZ_LITE_GROUP_PARM_OVERRIDE_COLOR_ON
Light group override color (on/off)
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_GROUP_PARM_OVERRIDE_COLOR
Light group override color
Type: fz_rgb_float_td
Default Value: white {1.0,1.0,1.0}
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_ON
Light group override intensity (on/off)
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ON
Light group override: replace intensity (on/off)
Type: fzrt_boolean
Default Value: TRUE
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_SIMPLE_ON_OBSOLETE
Light group override: replace intensity by specifying a new simple intensity value (on/off). Obsolete: 7.0.0.0. Now longer available.
Type: fzrt_boolean
Default Value: TRUE
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_SIMPLE_FACTOR
Light group override: replace intensity by specifying a new simple intensity value.
Type: double
Default Value: 1.0
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_FALLOFF
Light group override: replace falloff by specifying a new falloff value
Type: fz_lite_falloff_enum
Default Value: FZ_LITE_FALLOFF_CONSTANT
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_RADIOS_ON_OBSOLETE
Light group override: replace intensity by using a new radiometric intensity value (on) or photometric intensity value (off) Obsolete: 7.0.0.0. Now longer available.
Type: fzrt_boolean
Default Value: TRUE
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_WATTS_OBSOLETE
Light group override: replace intensity by using a new radiometric intensity value in watts Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: 100.0
Range: value >= 0.0
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_EFFICIENCY_OBSOLETE
Light group override: replace efficiency by using a new efficiency value Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: 0.5
Range: 0.0 <= value <= 1.0
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_COLTEMP_OBSOLETE
Light group override: replace color temperature by using a new color temperature value. Meaningful values are in the range of 1000 to 10000 degrees Kelvin, but larger values are allowed. Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: 2000
Range: value >= 1000
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_LUMENS_OBSOLETE
Light group override: replace intensity by using a new photometric intensity value in lumens Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: 1000
Range: value >= 0.0
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_SKY_ON_OBSOLETE
Light group override: when replacing the intensity of distant lights turn the atmospheric light on/off. Obsolete: 7.0.0.0. Now longer available.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_SKY_QUALITY_OBSOLETE
Light group override when replacing the intensity of distant lights and the atmospheric light is used, this is the override quality value of the atmospheric light. Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: 0.5
Range: 0.0 <= value <= 1.0
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_SKY_LUMINANCE_OBSOLETE
Light group override: when replacing the intensity of distant lights and the atmospheric light is used, this is the override luminance of the atmospheric light. Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: 50
Range: value >= 0.0
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_SKY_COVER_OBSOLETE
Light group override: when replacing the intensity of distant lights and the atmospheric light is used, this is the override cloud coverage of the atmospheric light. Obsolete: 7.0.0.0. Now longer available.
Type: fz_lite_parm_sky_intens_enum
Default Value: FZ_LITE_DIST_ACCURATE_INTENS_SKY_OVERCAST
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_REPL_ACC_SKY_COLOR_OBSOLETE
Light group override: when replacing the intensity of distant lights and the atmospheric light is used, this is the override sky color of the atmospheric light. Obsolete: 7.0.0.0. Now longer available.
Type: fz_lite_parm_sky_color_enum
Default Value: FZ_LITE_DIST_ACCURATE_INTENS_SKY_LIGHTBLUE
FZ_LITE_GROUP_PARM_OVERRIDE_INTENS_SCALE_FACTOR
Light group override: replace intensity by specifying a scale factor by which all intensities of the lights in a group are multiplied.
Type: double
Default Value: 1.0
Range: value >= 0.0
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_ON_OBSOLETE
Light group override: turn shadow type override on/off Obsolete: 7.0.0.0. Now longer available.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_TYPE_OBSOLETE
Light group override: when overriding the shadow type, this is the new shadow type. Obsolete: 7.0.0.0. Now longer available.
Type: fz_lite_smap_type_enum
Default Value: FZ_LITE_SHAD_TYPE_MAP
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_TRANSP_ON_OBSOLETE
Light group override: when overriding the shadow type, this is the new value for transparent shadows (on/off). Obsolete: 7.0.0.0. Now longer available. Obsolete: 7.0.0.0. Now longer available.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_MAP_QUALITY_OBSOLETE
Light group override: when overriding the shadow type, this is the new value for the shadow map quality. Obsolete: 7.0.0.0. Now longer available.
Type: fz_lite_smap_quality_enum
Default Value: FZ_LITE_SHAD_MAP_QUALITY_MEDIUM
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_MAP_SOFTNESS_OBSOLETE
Light group override: when overriding the shadow type, this is the new value for the shadow map softness. Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: 0.0
Range: value >= 0.0
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_MAP_TOLERANCE_OBSOLETE
Light group override: when overriding the shadow type, this is the new value for the shadow map tolerance. Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: 0.0
Range: value >= 0.0
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_MAP_FIXED_RES_ON_OBSOLETE
Light group override: when overriding the shadow type, this is the new value for the fixed resolution on/off option. Obsolete: 7.0.0.0. Now longer available.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_MAP_RES_IMAGESIZE_OBSOLETE
Light group override: when overriding the shadow type, this is the new value for the shadow map resolution, as a factor of the image size. Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: 1.0
Range: value > 0.0
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_MAP_RES_FIXED_OBSOLETE
Light group override: when overriding the shadow type, this is the new value for the shadow map fixed resolution. Obsolete: 7.0.0.0. Now longer available.
Type: fzrt_int
Default Value: 512
Range: value >= 64
FZ_LITE_GROUP_PARM_OVERRIDE_SHADTYPE_MAP_LIMIT_OBSOLETE
Light group override: when overriding the shadow type, this is the new value for the shadow map limit option. Obsolete: 7.0.0.0. Now longer available.
Type: fz_lite_smap_limit_enum
Default Value: FZ_LITE_SHAD_MAP_LIMIT_ALL
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ON_OBSOLETE
Light group override: turn glow override on/off Obsolete: 7.0.0.0. Now longer available.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_GLOW_ON_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the glow option (on/off). Obsolete: 7.0.0.0. Now longer available.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_ON_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the accurate glow option (on/off). Obsolete: 7.0.0.0. Now longer available.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_SIMPLE_INTENS_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the simple glow intensity. Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: 0.5
Range: value >= 0.0
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_SIMPLE_FALLOFF_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the simple glow falloff. Obsolete: 7.0.0.0. Now longer available.
Type: fz_lite_glow_falloff_enum
Default Value: FZ_LITE_GLOW_SIMPLE_FALLOF_SQUARE
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_SIMPLE_LIGHT_DIST_ON_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the simple glow by distance option (on/off). Obsolete: 7.0.0.0. Now longer available.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_SIMPLE_DIST_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the simple glow distance. Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: English 120.0 in, Metric 500.0 cm
Range: value > 0.0
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_INTENS_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the accurate glow intensity. Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: 0.5
Range: value >= 0.0
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_ATTENUATION_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the accurate glow attenuation. Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: 0.0
Range: 0.0 <= value <= 1.0
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_MAX_DIST_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the accurate glow maximum distance. Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: English 1200.0 in, Metric 5000.0 cm
Range: value > 0.0
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_QUALITY_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the accurate glow quality. Obsolete: 7.0.0.0. Now longer available.
Type: fzrt_int
Default Value: 5
Range: 1 <= value <= 10
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_NOISE_ON_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the accurate glow noise option (on/off). Obsolete: 7.0.0.0. Now longer available.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_NOISE_SIZE_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the accurate glow noise size. Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: English 48.0 in, Metric 100.0 cm
Range: value > 0.0
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_NOISE_TYPE_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the accurate glow noise type. Obsolete: 7.0.0.0. Now longer available.
Type: fz_lite_glow_noise_enum
Default Value: FZ_LITE_GLOW_ACCURATE_NOISE_TYPE_BETTER
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_NOISE_NIMPULSE_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the accurate glow noise number of impulses. Obsolete: 7.0.0.0. Now longer available.
Type: fzrt_int
Default Value: 3
Range: 1 <= value <= 10
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_NOISE_CONTRAST_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the accurate glow noise contrast. Obsolete: 7.0.0.0. Now longer available.
Type: double
Default Value: 1.0
Range: 0.0 <= value <= 1.0
FZ_LITE_GROUP_PARM_OVERRIDE_GLOW_ACCURATE_NOISE_DETAIL_OBSOLETE
Light group override: when overriding the glow option, this is the new value for the accurate glow noise detail. Obsolete: 7.0.0.0. Now longer available.
Type: fzrt_int
Default Value: 3
Range: 1 <= value <= 10
FZ_LITE_GROUP_PARM_OVERRIDE_RADANG_ON
Light group override: turn radius / angle override on/off.
Type: fzrt_boolean
Default Value: FALSE
FZ_LITE_GROUP_PARM_OVERRIDE_RADANG_RADIUS
when overriding the radius / angle parameters, this is the new value for the radius.
Type: double
Default Value: English 120.0 in, Metric 500.0 cm
Range: value > 0.0
FZ_LITE_GROUP_PARM_OVERRIDE_RADANG_OUTER_ANGLE
when overriding the radius / angle parameters, this is the new value for the outer angle of cone lights and the angle of projector lights.
Type: double
Default Value: PI/3.0 (60 degrees)
Range: 0.0 < value < PI
FZ_LITE_GROUP_PARM_OVERRIDE_RADANG_INNER_ANGLE
when overriding the radius / angle parameters, this is the new value for the inner angle of cone lights.
Type: double
Default Value: PI/4.0 (45 degrees)
Range: 0.0 < value < PI
Availability
5.0.0.0
Defined in