vrdLensFlareStar¶

This class is used for a sun-like effect, made up of multiple streaks. Use it for things such as street lamps at night, objects with stationary lights, or a light source that’s partially obscured by an object, like a tree or building’s edge. A short introduction can be found under https://help.autodesk.com/view/VREDPRODUCTS/2020/ENU/?guid=VRED_Lights_About_Lens_Flares_and_Elements_html.

Summary¶

Functions:

vrdLensFlareStar.getImage()¶

Return the current used texture.

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

vrdLensFlareStar.getNumberOfBursts()¶

Get how many arms a Starburst element has.

Returns:	Count of arms a Starburst element
Return type:	integer

vrdLensFlareStar.getShape()¶

Get the current used shape.

Returns:	Current used shape
Return type:	vrLensFlareTypes.StarShape

vrdLensFlareStar.getThickness()¶

Get the current used thickness of the effect.

Returns:	Thickness of the effect
Return type:	float

vrdLensFlareStar.setImage(image)¶

Set an image for this element. You has to change the type to Texture to use the image for the star effect.

Parameters:	image (vrdImage) – The image used for this effect

vrdLensFlareStar.setNumberOfBursts(numberOfBursts)¶

Use to set how many arms a Starburst element has.

Parameters:	numberOfBursts (integer) – New count of arms a Starburst element

vrdLensFlareStar.setShape(shape)¶

Change current shape to a fan, spike, blade or texture.

Fan = fan,
Spike = spike,
Blade = blade,
Texture = Shape assigned to an image

Parameters:	shape (vrLensFlareTypes.StarShape) – New used shape

vrdLensFlareStar.setThickness(thickness)¶

Controls the thickness of the effect.

Parameters:	thickness (float) – New thickness of the effect