Interface: DaylightSimulationUtilities

Core Interfaces - Quick Navigation

The DaylightSimulationUtilities Interface exposes methods used by the Light Analysis Utility to collect objects and ensure the validity of render effects, lights, materials and the renderer for performing Daylight Simulation.

Methods:

<node by value array>DaylightSimulationUtilities.FindValidLights() 	 

Returns an array of valid lights.

<node by value array>DaylightSimulationUtilities.FindInvalidLights()   

Returns an array of invalid lights.

<node by value array>DaylightSimulationUtilities.FindActiveLights() 

Returns an array of active lights.

<node by value array>DaylightSimulationUtilities.FindInactiveLights() 

Returns an array of inactive lights.

<node by value array>DaylightSimulationUtilities.FindLightsWithValidType() 

Returns an array of lights with valid type.

<node by value array>DaylightSimulationUtilities.FindLightsWithInvalidType() 

Returns an array of lights with invalid type.

<node by value array>DaylightSimulationUtilities.FindLightsWithShadowsOn() 

Returns an array of lights that have shadow casting enabled.

<node by value array>DaylightSimulationUtilities.FindLightsWithShadowsOff() 

Returns an array of lights that have shadow casting disabled.

<node by value array>DaylightSimulationUtilities.FindLightsUsingRaytracedShadows() 

Returns an array of lights that have shadow set to raytraced.

<node by value array>DaylightSimulationUtilities.FindLightsNotUsingRaytracedShadows() 

Returns an array of lights that have shadow set to any type but raytraced.

<node by value array>DaylightSimulationUtilities.FindRenderableObjects() 

Returns an array of all renderable objects in the scene.

<node by value array>DaylightSimulationUtilities.FindInvalidMaterials() 

Returns an array of objects that have materials that are invalid for daylight simulation.

<boolean>DaylightSimulationUtilities.FixInvalidMaterials() 

Fixed the materials that are invalid for daylight simulation. Returns true on success, false if nothing was fixed.

<node by value array>DaylightSimulationUtilities.FindDaylightSystems() 

Returns an array of daylight system lights.

<boolean>DaylightSimulationUtilities.LightAnalysisRenderEffectExists() 

Returns true if a Light Analysis Render Effect has already been added to the Effects list, false if it does not exist on the Effects list.

<boolean>DaylightSimulationUtilities.IsLightAnalysisRenderEffectActive() 

Returns true if a Light Analysis Render Effect has already been added to the Effects list and is active, false if it is not active.

<integer>DaylightSimulationUtilities.GetLightAnalysisRenderEffectCount() 

Returns the number of LightAnalysis Render Effects.

<boolean>DaylightSimulationUtilities.IsValidRenderer() 

Returns true if the current renderer is valid (mental ray), false if it is not valid (Default Scanline Renderer, 3 ^rd party renderers)

<boolean>DaylightSimulationUtilities.IsMentalRaySunDaylightSystem <Interface>daylightSystem 

Returns true if the supplied daylight system uses the mental ray Sun, false otherwise.

<boolean>DaylightSimulationUtilities.IsMentalRaySkyDaylightSystem <Interface>daylightSystem 

Returns true if the supplied daylight system uses the mental ray Sky, false otherwise.

<boolean>DaylightSimulationUtilities.IsShadowCastingDaylightSystem <Interface>daylightSystem 

Returns true if the supplied daylight system is set to cast shadows, false otherwise.

<boolean>DaylightSimulationUtilities.IsValidSunMultiplier <Interface>daylightSystem 

Returns true if the Sun Multiplier in the Daylight System represented by the given Interface is valid, false if it is invalid.

<boolean>DaylightSimulationUtilities.IsValidSkyMultiplier <Interface>daylightSystem 

Returns true if the Sky Multiplier in the Daylight System represented by the given Interface is valid, false if it is invalid.

<boolean>DaylightSimulationUtilities.IsSunOn <Interface>daylightSystem 

Returns true of the Sun in the Daylight System represented by the given interface is on, false if it is off.

<boolean>DaylightSimulationUtilities.IsSkyOn <Interface>daylightSystem 

Returns true of the Sky in the Daylight System represented by the given interface is on, false if it is off.

<void>DaylightSimulationUtilities.SetMentalRayAsProductionRenderer() 

Sets mental ray as the production renderer. Equivalent to assigning an instance of the mental_ray_renderer class to the production renderer.

<void>DaylightSimulationUtilities.OpenIndirectIlluminationRenderDialogPage() 

Opens the Render Dialog at the Indirect Illumination tab.

<boolean>DaylightSimulationUtilities.Is32bitFrameBuffer() 

Returns true if the frame buffer is using 32 bit per channel, false if using 16 bpc.

<boolean>DaylightSimulationUtilities.IsRenderIterative() 

Returns true if the renderer is set to Iterative mode, false if set to Production mode.

<void>DaylightSimulationUtilities.SetRenderIterative <boolean>renderIterative 

Sets the renderer to Iterative mode when the argument is true or to Production mode when the argument is supplied as false.

<void>DaylightSimulationUtilities.ApplyDefaultRenderPreset() 

Applies the default render preset to the renderer.

 Except where otherwise noted, this work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. Please see the Autodesk Creative Commons FAQ for more information.