Documentation/Entity Types/Base/LensFlareManager.type

From NeoAxis 3D Engine Wiki

Jump to: navigation, search
Go to higher level

Contents

Description

LensFlareManager is an object that helps adding some flares from the camera lens.

LensFlareManager 01.jpg

Creating

In order to create the object, you should select the LensFlareManager object in the Base\Types folder of the Object Creation window. The object could be added to the map by one click in the workspace area.

LensFlareManager 02.jpg

To configure lens flare textures you should select the LensFlareManager entity and click the "..." button next to the Flares field.

LensFlareManager 03.jpg

You can add, delete and change flare settings in the open window. The full description of flare attributes goes below.

LensFlareManager 04.jpg

Properties

Parameter Description
class Entity
Components List of attached components.
LogicClass Reference to the Logic Editor class. Read more about how to work with the Logic Editor class.
Name Object name.
Tags User defined information. Defined as keyvalue pairs. It is used for user's needs.
Type Object type. It can not be changed.
class LensFlareManager
Color Color multiplier of the flare.
Enabled Enables/Disables the object.
FadeSpeed The fade rate of the lens flares.
Flares The list of all flares. Settings of a certain flare are described below.
VisibilityCheckStartDistance The distance to the camera when visibility check for the flares is activated. This parameter allows ignoring very close objects like the character object when calculating visibility.

Flare properties

Parameter Description
Misc
Blending A blending method to use for the lens flare texture. It could be either the AlphaAdd mode (adding) or AlphaBlend mode (the blending based on the alpha channel).
Color The color of the flare.
DistanceFactor The position of the flare.
FadeSpeedFactor The modifier for fade rate of the flare.
Size The size of the flare. The size is proportional to the vertical size of the screen. The value of "1 1" corresponds to full screen.
Texture The path to the texture of the flare.