vrdLensFlareElement

class vrdLensFlareElement

(Inherits vrdSceneObject)

This is the base class of all lens flare effect classes. The Light Service works with objects of this class, but behind which objects derived from this class are hidden.

Summary

Functions:

• getIsActive() → bool
• getName() → string
• setIsActive(active)
• setName(name)

Functions

vrdLensFlareElement.getIsActive()

Returns activation state of the lens flare element.

Returns:Activation state of the lens flare element Return type:bool

vrdLensFlareElement.getName()

Returns name of this lens flare element.

Returns:Name of this lens flare element Return type:string

vrdLensFlareElement.setIsActive(active)

Each lens flare element can be inactive for a while. The element will be hidden if is inactive. This method set the activation state of a lens flare element.

Parameters:active (bool) – New activation state of the lens flare element

vrdLensFlareElement.setName(name)

Each lens flare has a name. The name must not be unique. This method set the name.

Parameters:name (string) – The new name of the lens flare element.