vrdAreaLightCone

class vrdAreaLightCone

(Inherits vrdSceneObject)

This class provides control of the light cone of an area light.

You can customize the cone angle of vrdRectangularLightNode and vrdDiskLightNode.

Summary

Functions:

• getConeAngle() → float
• getPenumbraAngle() → float
• getUseConeAngle() → bool
• setConeAngle(angle)
• setPenumbraAngle(angle)
• setUseConeAngle(use)

Functions

vrdAreaLightCone.getConeAngle()

Returns the light cone angle.

Returns:The angle in degrees Return type:float

vrdAreaLightCone.getPenumbraAngle()

Returns: Return type:float

vrdAreaLightCone.getUseConeAngle()

Returns if custom light cone and penumbra angles are enabled.

Returns:True if custom angles are enabled, False otherwise Return type:bool

vrdAreaLightCone.setConeAngle(angle)

Sets the light cone angle.

The cone angle is the light beam’s angle from the middle of the beam to the outer edge, measured in degrees.

Parameters:angle (float) – The angle in degrees (interval: [0.01, 89.99])

vrdAreaLightCone.setPenumbraAngle(angle)

Sets the penumbra angle.

The penumbra angle softens the light by blurring the outside edge of the light cone.

Parameters:angle (float) – The penumbra angle in degrees (interval: [0.01, 89.99])

vrdAreaLightCone.setUseConeAngle(use)

Enable usage of custom light cone and penumbra angles.

Parameters:use (bool) – True to enable custom angles, False otherwise