vrdLensFlareGhost

class vrdLensFlareGhost

(Inherits vrdLensFlareFxElement)

This class is used for a ghost effect in a ghost line. Ghost are elements that move with the light source. A short introduction can be found under https://help.autodesk.com/view/VREDPRODUCTS/2020/ENU/?guid=VRED_Lights_About_Lens_Flares_and_Elements_html.

Functions

vrdLensFlareGhost.getChromaticAberration()

Get used chromatic aberration values as RGB.

Returns:Used chromatic aberration
Return type:QVector3D
vrdLensFlareGhost.getDistance()

Get the lens flare effect distance from light source.

Returns:Distance from light source
Return type:float
vrdLensFlareGhost.getEdgeIntensity()

Get the edge color intensity of the Ghost Line element.

Returns:The edge color intensity
Return type:float
vrdLensFlareGhost.getEdgeThickness()

Get thickness of the edges of the Ghost Line element.

Returns:Thickness of the edges of the Ghost Line element
Return type:float
vrdLensFlareGhost.getImage()

Return the current used texture.

Returns:The current used image for texture. May be invalid, if no image is used.
Return type:vrdImage
vrdLensFlareGhost.getIsChromaticAberrationActive()

Get activation state the usage of chromatic aberration.

Returns:Activation state the usage of chromatic aberration
Return type:bool
vrdLensFlareGhost.getShape()

Give the current used shape for the ghost element.

Returns:Current used shape for the ghost element.
Return type:vrLensFlareTypes.ElementShape
vrdLensFlareGhost.setChromaticAberration(chromaticAberration)

Use chromatic aberration with the lens flare element to distort the colors.

Parameters:chromaticAberration (QVector3D) – New Chromatic Aberration
vrdLensFlareGhost.setDistance(distance)

Lens flare effect distance from light source. Must be between -5 and 5. Use a negative value for a position in front of the light source.

Parameters:distance (float) – New distance from light source
vrdLensFlareGhost.setEdgeIntensity(edgeIntensity)

Makes the edge color of the Ghost Line element more or less intense. Changing it to 0 will make the edge disappear.

Parameters:edgeIntensity (float) – New edge color intensity.
vrdLensFlareGhost.setEdgeThickness(thickness)

The thickness of the edges of the Ghost Line element. When Edge Intensity is high, it is much easier to see the difference.

Parameters:thickness (float) – New thickness of the rays of light.
vrdLensFlareGhost.setImage(image)

Set an image for this ghost element. You have to change the type to Texture to use the image for the ghost.

Parameters:image (vrdImage) – The image used for this ghost
vrdLensFlareGhost.setIsChromaticAberrationActive(isActive)

Activate the usage of chromatic aberration.

Parameters:isActive (bool) – New activation state the usage of chromatic aberration
vrdLensFlareGhost.setShape(shape)

Set a shape for the ghost element.

Circle = A circular shape
Triangle = Shape with 3 edges
Quad = Shape with 4 edges
Pentagon = Shape with 5 edges
Hexagon = Shape with 6 edges
Heptagon = Shape with 7 edges
Octagon = Shape with 8 edges
Nonagon = Shape with 9 edges
Decagon = Shape with 10 edges
Texture = Shape assigned to an image
Parameters:shape (vrLensFlareTypes.ElementShape) – New image type to be set