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

# fz_lite_parm_sun_enum

Description

Parameter identifiers for a sun light. Used for the "which" argument of and fz_lite_set_parm_sun.

enum fz_lite_parm_sun_enum {

FZ_LITE_PARM_SUN_ANGLE_NORTH,

FZ_LITE_PARM_SUN_BY_SITE_ON,

FZ_LITE_PARM_SUN_SITE_FROM_CITY_ON,

FZ_LITE_PARM_SUN_CITY_ID,

FZ_LITE_PARM_SUN_LATITUDE,

FZ_LITE_PARM_SUN_LONGITUDE,

FZ_LITE_PARM_SUN_TIMEZONE,

FZ_LITE_PARM_SUN_DLST,

FZ_LITE_PARM_SUN_YEAR,

FZ_LITE_PARM_SUN_MONTH,

FZ_LITE_PARM_SUN_DAY,

FZ_LITE_PARM_SUN_HOUR,

FZ_LITE_PARM_SUN_MINUTE,

FZ_LITE_PARM_SUN_SECOND,

FZ_LITE_PARM_SUN_FROM_SOUTH_ON,

FZ_LITE_PARM_SUN_ALTITUDE,

FZ_LITE_PARM_SUN_AZIMUTH };

Members

FZ_LITE_PARM_SUN_ANGLE_NORTH

Sun's north angle, measured relative to the world's positive y axis.

Type: double

Default Value: PI/2.0 (90 degrees)

FZ_LITE_PARM_SUN_BY_SITE_ON

Define sun direction by site on/off.

Type: fzrt_boolean

Default Value: FALSE

FZ_LITE_PARM_SUN_SITE_FROM_CITY_ON

Define sun direction from a city on/off

Type: fzrt_boolean

Default Value: FALSE

FZ_LITE_PARM_SUN_CITY_ID

city id

Type: fzrt_int

Range: value >= 0

FZ_LITE_PARM_SUN_LATITUDE

Sun latitude angle (in radians), when specifying sun direction latitude/longitude/time zone (by city is off).

Type: double

Range: -PI/2 <= value <= PI/2

FZ_LITE_PARM_SUN_LONGITUDE

Sun longitude angle (in radians), when specifying sun direction latitude/longitude/time zone (by city is off)

Type: double

Range: -PI <= value <= PI

FZ_LITE_PARM_SUN_TIMEZONE

Sun time zone (hours), when specifying sun direction latitude/longitude/time zone (by city is off)

Type: double

Range: -12.0 <= value <= 12.0

FZ_LITE_PARM_SUN_DLST

Time specification: Daylight savings time on/off.

Type: fzrt_boolean

Default Value: FALSE

FZ_LITE_PARM_SUN_YEAR

Time specification: year

Type: fzrt_int

Range: value >= 1900

FZ_LITE_PARM_SUN_MONTH

Time specification: month

Type: fzrt_int

Range: 1 <= value <= 12

FZ_LITE_PARM_SUN_DAY

Time specification: day

Type: fzrt_int

Range: 1 <= value <= 31,30,29,28, depending on month

FZ_LITE_PARM_SUN_HOUR

Time specification: hour

Type: fzrt_int

Range: 0 <= value <= 23

FZ_LITE_PARM_SUN_MINUTE

Time specification: minute

Type: fzrt_int

Range: 0 <= value <= 59

FZ_LITE_PARM_SUN_SECOND

Time specification: second

Type: fzrt_int

Range: 0 <= value <= 59

FZ_LITE_PARM_SUN_FROM_SOUTH_ON

Sun azimuth angle measured from south on/off. Used when specifying the sun direction by azimuth/altitude.

Type: fzrt_boolean

Default Value: TRUE

FZ_LITE_PARM_SUN_ALTITUDE

Sun altitude angle. Used when specifying the sun direction by azimuth/altitude.

Type: double

Range: -PI <= value <= PI

FZ_LITE_PARM_SUN_AZIMUTH

Sun azimuth angle. Used when specifying the sun direction by azimuth/altitude.

Type: double

Range: -PI <= value <= PI

Availability

5.0.0.0

See Also

fz_lite_set_parm_sun

Defined in

fz_lite_api.h