vrdLensFlareEffect

class vrdLensFlareEffect

(Inherits vrdSceneObject)

Functions

vrdLensFlareEffect.createLensFlareElement(name, type)
Parameters:
Returns:
Return type:

vrdLensFlareElement
vrdLensFlareEffect.getAngularIntensity()

Returns the angular intensity.

Returns:Angular intensity
Return type:float
vrdLensFlareEffect.getColor()

Returns the lens flare color.

Returns:Color
Return type:QVector3D
vrdLensFlareEffect.getIntensity()

Returns the brightness of all lens flares.

Returns:Intensity
Return type:float
vrdLensFlareEffect.getIsActive()

Returns if the lens flare effect is enabled.

Returns:True if enabled.
Return type:bool
vrdLensFlareEffect.getLensFlareElements()
Returns:
Return type:List[vrdLensFlareElement]
vrdLensFlareEffect.getPresetType()
Returns:
Return type:vrLensFlareTypes.PresetType
vrdLensFlareEffect.getRadius()

Returns the radius.

Returns:Radius
Return type:float
vrdLensFlareEffect.getSize()

Returns the size of all lens flares.

Returns:Size
Return type:float
vrdLensFlareEffect.getUseLightProperties()

Returns if the intensity of the light is used.

Returns:True, if the intensity of the light is used.
Return type:bool
vrdLensFlareEffect.removeElements(elements)
Parameters:elements (List[vrdLensFlareElement]) –
vrdLensFlareEffect.setAngularIntensity(angularIntensity)

Changes the brightness of the flare, as the angle changes. As the light source is rotated toward the viewer, becoming perpendicular to the view, its intensity increases. It is like how intense a sunset gets as it reaches the horizon, just before setting. Another example would be turning a flashlight’s beam toward you. From your point of view, as the light aligns with your view, it becomes more intense, to the point of blinding.

Parameters:angularIntensity (float) – Angular intensity
vrdLensFlareEffect.setColor(color)

Sets the color of all lens flares. The color is multiplied with any element color already assigned. Note: If Use Light Properties is enabled, the color set here is ignored and the light color is used. Note: Since this color is multiplied with element color assignments, there may be instances where a lens flare disappears, due to the multiply operation. If this occurs, try changing the color of the individual lens flares (instead of using this option) or change the color of this option. If there are no element assigned colors, this color is assigned to all lens flares.

Parameters:color (QVector3D) – Color for all lens flares
vrdLensFlareEffect.setIntensity(intensity)

Changes the brightness of all lens flares.

Parameters:intensity (float) – Intensity
vrdLensFlareEffect.setIsActive(active)

Enables or disables the lens flare effect.

Parameters:active (bool) – If set to True, the lens flare effect is enabled.
vrdLensFlareEffect.setPresetType(type)
Parameters:type (vrLensFlareTypes.PresetType) –
vrdLensFlareEffect.setRadius(radius)

Changes how dispersed the flare is for all lens flares. The radius represents the virtual size of the light sources, since the lights do not have geometry. A larger radius requires a larger object to completely occlude the effect. Shrinking of the lens flare will start when the radius around the light source starts to get occluded by an object. That occlusion also decreases the intensity of the ghosts. As the radius increases, the intensity of the light decreases. As the radius decreases, the flare becomes more intense and defined.

Parameters:radius (float) – Radius
vrdLensFlareEffect.setSize(size)

Changes the size of all lens flares.

Parameters:size (float) – Size
vrdLensFlareEffect.setUseLightProperties(use)

Use the intensity of the light settings instead of the local setting. This only affects the color. When disabled, the local color is used.

Parameters:use (bool) – Use the intensity of the light.