DaylightAssemblyHead : Helper

DaylightAssemblyHead - superclass: Helper; super-superclass: Node - classID: #(1243508203, 835157335)

Helpers - Quick Navigation

Constructor:

Class instances not creatable by MAXScript.

See Interface: DaylightSystemFactory2 for a method to construct a Daylight System.

Properties:

<DaylightAssemblyHead>.sun Max_object

Get/setthe Sun objectusedin the Assembly.

Setting this property to undefined will set the Daylight system to "No Sunlight" mode.

<DaylightAssemblyHead>.sky Max_object

Containsthe Sky objectusedin the Assembly.

Setting this property to undefined will set the Daylight system to "No Skylight" mode.

<DaylightAssemblyHead>.manual Integer default:0

The property controls the way the Daylight_Slave_Controller calculates the position of the Daylight.

Corresponds to the Manual/Date,Time and Location radio buttons in the UI.

The accepted values are:

0 - Date,Time and Location

1 - Manual

2 - Weather file (available in 3ds Max 2009 and higher.)

<DaylightAssemblyHead>.weatherFileName Filename

Get/set the weather file name.

Available in 3ds Max 2009 and higher.

DaylightAssemblyHead interfaces:

Interface:IDaylightSystem

Methods:

<object>GetSun()

Returns thelightobjects usedas Sunin the Assembly.

Available in 3ds Max 2009 and higher.

<object>SetSun<class>sunClass

Sets the Sun objects in the Assembly to an instance of the given class.

Other than the.sunproperty documented above, this method expects a class of the light object and not an instance of a light class.

Possible classes are:

DirectionalLight- corresponds to Standard entry in the Daylight System UI

IES_Sun

mr_Sun

Available in 3ds Max 2009 and higher.

<object>GetSky()

Returns thelightobject usedas Skyin the Assembly.

Available in 3ds Max 2009 and higher.

<object>SetSky <class>skyClass

Sets the Sky objects in the Assembly to an instance of the given class.

Other than the.skyproperty documented above, this method expects a class of the light object and not an instance of a light class.

Possible classes are:

IES_Sky

mr_Sky

Skylight

Available in 3ds Max 2009 and higher.

<integer>GetDaylightControlType()

Returns the DaylightControl Type.

Possible values are:

0 - Date,Time and Location

1 - Manual

2 - Weather File

Available in 3ds Max 2009 and higher.

<void>SetDaylightControlType <integer>type

Sets theDaylightControl Type.

Possible values are:

0 - Date,Time and Location

1 - Manual

2 - Weather File

Available in 3ds Max 2009 and higher.

<String>GetLocation()

Returns the location as string.

Available in 3ds Max 2009 and higher.

<void>GetAltitudeAzimuth <time>time <&float>altitude <&float>azimuth 

altitude is In and Out parameter 
azimuth is In and Out parameter

Returns the altitude and azimuth values corresponding to the time given as first argument into the by-reference variables given by the second and third argument.

Available in 3ds Max 2009 and higher.

<filename>GetWeatherFileName()

Returns the filename of the weather file.

Available in 3ds Max 2009 and higher.

<void>OpenWeatherFileDlg()

Opens the Weather File dialog.The Daylight Control Type must be set to 2 - Weather file for the dialog to open.

Available in 3ds Max 2009 and higher.

<void>MatchTimeLine()

Matches the time line.

Available in 3ds Max 2009 and higher.

<void>LoadWeatherFile <filename>file

Loads the given weather file.

Available in 3ds Max 2009 and higher.

<void>SetWeatherFileFilterAnimated <boolean>animated

Sets weather to filter animated data from the Weather file. Default is false.

Available in 3ds Max 2009 and higher.

<boolean>GetWeatherFileFilterAnimated()

Returns weather animated data from the Weather file will be filtered.

Available in 3ds Max 2009 and higher.

<void>SetWeatherFileSpecificTimeAndDate <&point3>timeOfDay <&point3>date 

timeOfDay is In and Out parameter 
date is In and Out parameter

Sets specific time and date for the weatherfile using the twoPoint3by-reference arguments.

The three components of the timeOfDay argument specify hours, minutes and seconds.

The three components of the date argument specify the day, month and year.

Available in 3ds Max 2009 and higher.

<void>GetWeatherFileSpecificTimeAndDate <&point3>timeOfDay <&point3>date 

timeOfDay is In and Out parameter 
date is In and Out parameter

Getsthe specific time and date for the date file intothe twoPoint3by-reference arguments.

The three components of the timeOfDay argument specify hours, minutes and seconds.

The three components of the date argument specify the day, month and year.

Available in 3ds Max 2009 and higher.

EXAMPLE

aTime = point3 0 0 0
[0,0,0]
aDate = point3 0 0 0
[0,0,0]
$Daylight01.GetWeatherFileSpecificTimeAndDate &aTime &aDate
OK
aTime
[12,0,0]
aDate
[1,1,2007]

<void>SetWeatherFileAnimStartTimeAndDate <&point3>timeOfDay <&point3>date 

timeOfDay is In and Out parameter 
date is In and Out parameter

Sets the weather file animation start time and date using the two Point3 by-reference arguments.

The three components of the timeOfDay argument specify hours, minutes and seconds.

The three components of the date argument specify the day, month and year.

Available in 3ds Max 2009 and higher.

<void>GetWeatherFileAnimStartTimeAndDate <&point3>timeOfDay <&point3>date 

timeOfDay is In and Out parameter 
date is In and Out parameter

Gets the weather file animation start time and date into the two Point3 by-reference arguments.

The three components of the timeOfDay argument specify hours, minutes and seconds.

The three components of the date argument specify the day, month and year.

Available in 3ds Max 2009 and higher.

<void>SetWeatherFileAnimEndTimeAndDate <&point3>timeOfDay <&point3>date 

timeOfDay is In and Out parameter 
date is In and Out parameter

Sets the weather file animation end time and date using the two Point3 by-reference arguments.

The three components of the timeOfDay argument specify hours, minutes and seconds.

The three components of the date argument specify the day, month and year.

Available in 3ds Max 2009 and higher.

<void>GetWeatherFileAnimEndTimeAndDate <&point3>timeOfDay <&point3>date 

timeOfDay is In and Out parameter 
date is In and Out parameter

Gets the weather file animation end time and date into the two Point3 by-reference arguments.

The three components of the timeOfDay argument specify hours, minutes and seconds.

The three components of the date argument specify the day, month and year.

Available in 3ds Max 2009 and higher.

<void>SetWeatherFileSkipHours <boolean>skipHours <integer>startHour <integer>endHour

Sets the weather file skip hours, start hour and end hour values.

Available in 3ds Max 2009 and higher.

<void>GetWeatherFileSkipHours <&boolean>skipHours <&integer>startHour <&integer>endHour 

skipHoursis In and Out parameter 
startHouris In and Out parameter 
endHouris In and Out parameter

Gets the weather file skip hours, start hour and end hour values into the three by-reference arguments.

Available in 3ds Max 2009 and higher.

<void>SetWeatherFileSkipWeekend <boolean>skipWeekend

Sets the weather file to skip weekends.

Available in 3ds Max 2009 and higher.

<boolean>GetWeatherFileSkipWeekend()

Gets the state of the weather file's skip weekends option.

Available in 3ds Max 2009 and higher.

<void>SetWeatherFileSkipFramePer <integer>framePer

Sets the index of the weather file skip period drop-down list.

Possible values are:

0 - Period

1 - Day

2 - Week

3 - Month

4 - Season

Available in 3ds Max 2009 and higher.

<integer>GetWeatherFileSkipFramePer()

Gets the index of the weather file skip period drop-down list.

Possible values are:

0 - Period

1 - Day

2 - Week

3 - Month

4 - Season

Available in 3ds Max 2009 and higher.

DaylightAssemblyHead : Helper

DaylightAssemblyHead interfaces:

See Also