vrdLensFlareGhostLine

class vrdLensFlareGhostLine

(Inherits vrdLensFlareElement)

This class is used for collection ghost effects. Objects of this class acts as a container for vrdLensFlareGhost objects. But it is an effect too. This class has a name and if becomes inactive, all ghosts of this line becomes inactive.

Summary

Functions:

• createGhost(distance) → vrdLensFlareGhost
• getGhosts() → List[vrdLensFlareGhost]
• removeGhosts(ghosts)

Functions

vrdLensFlareGhostLine.createGhost(distance=0.0)

A new ghost will be created for this line. The new ghost object has default properties. A ‘ghost’ property signal is emitted for the line object.

Parameters:distance (float) – Distance between the ghost and the light on the ghost line in a range between -5.0 and 5.0. Returns:The new created ghost Return type:vrdLensFlareGhost

vrdLensFlareGhostLine.getGhosts()

Get a list of all ghost of this line.

Returns:All ghosts of this line Return type:List[vrdLensFlareGhost]

vrdLensFlareGhostLine.removeGhosts(ghosts)

Remove some ghosts of this line. It will be checked, if the given ghosts are in this line. A ‘ghost’ property signal is emitted for the line object. But this only happens when ghosts have been removed. If the parameter list was empty, the signal is not sent. If the ghosts were not in this line, the signal will not be sent either.

Parameters:ghosts (List[vrdLensFlareGhost]) – All ghost to be removed from this line