SpotCutoff Property

The spot cutoff angle of the light source. With the help of this property you can make a positional light source act as a spot light.

Syntax

Visual Basic
C#

'Declaration
 
<CategoryAttribute("Spotlight")>

<DefaultValueAttribute()>

<DescriptionAttribute("The spot cutoff angle of the light source.")>

Public Property SpotCutoff As Single

'Usage
 
Dim instance As LightSource

Dim value As Single

 

instance.SpotCutoff = value

 

value = instance.SpotCutoff

[Category("Spotlight")]

[DefaultValue()]

[Description("The spot cutoff angle of the light source.")]

public float SpotCutoff {get; set;}

Remarks

The spot cutoff angle is the maximum value of the angle between the vector defined from the light position and the light direction and the vector defined from the light position and the object. If the value of this angle is bigger than the SpotCutoff the light becomes completely masked. With the help of this property you can achieve directed lights. For example a regular torch has a SpotCuttoff angle of around 45 degrees. When this property is set to 180.0 the light source is not considered a spot light and the light is distributed uniformly. If you set the SpotCutoff angle in the range of [0, 90] you specify that it is emitting light in the direction specified by the direction properties. All values not equal to 180 and not in the range of [0, 90] are automatically clamped to the range [0, 90].

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

LightSource Class
LightSource Members