vrdAreaLightNode

class vrdAreaLightNode

(Inherits vrdBaseLightNode)

This is the base class for all area lights. These lights emit light from an entire area in contrast to point lights, which emit light from a single point.

class QualityMode

Area light evaluation method in Raytracing.

Accurate

Accurate: An accurate sampling of the light source is used.

Approximated

Approximated: An approximation based on linearly transformed cosines is used.

Summary

Functions:

• getAttenuation() → vrLightTypes.Attenuation
• getIlluminateScene() → bool
• getInteractiveMode() → vrdAreaLightNode.QualityMode
• getInteractiveQuality() → integer
• getLightProfile() → vrdLightProfile
• getLocalLight() → bool
• getPrimaryVisibility() → bool
• getShadowMap() → vrdShadowMap
• getStillFrameMode() → vrdAreaLightNode.QualityMode
• getStillFrameQuality() → integer
• getTexture() → vrdLightTexture
• getVisibleInReflections() → bool
• setAttenuation(attenuation)
• setIlluminateScene(illuminateScene)
• setInteractiveMode(value)
• setInteractiveQuality(quality)
• setLocalLight(isLocalLight)
• setPrimaryVisibility(visible)
• setStillFrameMode(value)
• setStillFrameQuality(quality)
• setVisibleInReflections(visible)

Functions

vrdAreaLightNode.getAttenuation()

Returns the attenuation mode.

Returns:The attenuation mode. Return type:vrLightTypes.Attenuation

vrdAreaLightNode.getIlluminateScene()

Returns the state of the illuminate scene flag..

Returns:True if illuminate scene is enabled, False otherwise. Return type:bool

vrdAreaLightNode.getInteractiveMode()

Get the value of the interactive quality mode.

Returns:Current value of the interactive quality mode. Return type:vrdAreaLightNode.QualityMode

vrdAreaLightNode.getInteractiveQuality()

Returns the raytracing quality level for the interactive mode.

Returns:The interactive quality level in the interval [0,8]. Return type:integer

vrdAreaLightNode.getLightProfile()

Returns the light profile.

Returns:The light profile. Return type:vrdLightProfile

vrdAreaLightNode.getLocalLight()

Returns the state of local lighting.

Returns:True if local light mode is enabled, False otherwise. Return type:bool

vrdAreaLightNode.getPrimaryVisibility()

Returns the state of the primary visibility.

Returns:True if primary visibility is turned on, False otherwise. Return type:bool

vrdAreaLightNode.getShadowMap()

Returns the shadow map of the light.

Returns:The shadow map. Return type:vrdShadowMap

vrdAreaLightNode.getStillFrameMode()

Get the value of the still frame quality mode.

Returns:Current value of the still frame quality mode. Return type:vrdAreaLightNode.QualityMode

vrdAreaLightNode.getStillFrameQuality()

Returns the ratracing still frame quality level.

Returns:The still frame quality level in the interval [0,8]. Return type:integer

vrdAreaLightNode.getTexture()

Returns the currently used light texture.

Returns:The light texture. Return type:vrdLightTexture

vrdAreaLightNode.getVisibleInReflections()

Returns if the light is visible in reflections (Raytracing only).

Returns:True if the light is visible in reflections, False otherwise. Return type:bool

vrdAreaLightNode.setAttenuation(attenuation)

Sets the attenuation mode. Attenuation is the falloff of the light intensity.

Parameters:attenuation (vrLightTypes.Attenuation) – The attenuation mode.

vrdAreaLightNode.setIlluminateScene(illuminateScene)

Toggles the illumination of objects on or off.

If switched off the light will add nothing to the scene. Lens flares are still active.

Parameters:illuminateScene (bool) – True to illuminate the scene, otherwise False.

vrdAreaLightNode.setInteractiveMode(value)

Defines the computation method used for evaluating the area light in interactive rendering.

Parameters:value (vrdAreaLightNode.QualityMode) – New value of the interactive quality mode.

vrdAreaLightNode.setInteractiveQuality(quality)

Sets the raytracing quality level for the interactive mode.

Parameters:quality (integer) – The interactive quality level in the interval [0,8].

vrdAreaLightNode.setLocalLight(isLocalLight)

Enables / disables local lighting.

If this is enabled and the light is part of a light link set then only the nodes in the light links set will be illuminated.

Parameters:isLocalLight (bool) – True enables local lighting, False disables it.

vrdAreaLightNode.setPrimaryVisibility(visible)

Sets the primary visibility of the light.

If this is off the light will not be rendered but it will still emit light into the scene.

Parameters:visible (bool) – True to turn the primary visibility on, False otherwise.

vrdAreaLightNode.setStillFrameMode(value)

Defines the computation method used for evaluating the area light in still frame rendering.

Parameters:value (vrdAreaLightNode.QualityMode) – New value of the still frame quality mode.

vrdAreaLightNode.setStillFrameQuality(quality)

Sets the raytracing quality level for still frame rendering.

Parameters:quality (integer) – The still frame quality level in the interval [0,8].

vrdAreaLightNode.setVisibleInReflections(visible)

Sets the visibility in reflections.

Note: this only works if raytracing is enabled.

Parameters:visible (bool) – True if the light should be visible in reflections, False otherwise.