This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

LightLensFlare Class

Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

This class is used to manage billboards used for the per-light lens flares effect.

Notice
The lens flare effect must be enabled for the light source. This feature is available only for: Omni Lights, Projected Lights and World Lights.

See Also#

Description of lens flare settings.

LightLensFlare Class

Members


void setName ( string name ) #

Sets a new name for the lens flare billboard.

Arguments

  • string name - Billboard name to be set.

string getName ( ) #

Returns the current name of the lens flare billboard.

Return value

Current billboard name.

void setColor ( vec4 color ) #

Sets a new color for the lens flare billboard.

Arguments

  • vec4 color - Billboard color to be set.

vec4 getColor ( ) #

Returns the current color of the lens flare billboard.

Return value

Current billboard color.

void setSize ( float size ) #

Sets a new size for the lens flare billboard.

Arguments

  • float size - Billboard size to be set.

float getSize ( ) #

Returns the current size of the lens flare billboard.

Return value

Current billboard size.

void setIntensity ( float intensity ) #

Sets a new intensity value for the lens flare billboard.

Arguments

  • float intensity - Billboard intensity to be set. The color of the billboard is multiplied by this value. The higher the value, the brighter the flare will be.

float getIntensity ( ) #

Returns the current intensity of the lens flare billboard.

Return value

Current billboard intensity. The color of the billboard is multiplied by this value. The higher the value, the brighter the flare will be.

void setOffset ( float offset ) #

Sets a new offset value for the lens flare billboard. The offset determines the distance from the light source along the vector oriented from the light source to the screen center.

Arguments

  • float offset - Billboard offset value to be set. The lower the absolute value is, the closer to the light source the billboard will be. Negative values indicate that the distance is measured in the opposite direction.

float getOffset ( ) #

Returns the current offset value for the lens flare billboard. It is the offset from the light source along the direction of the light ray.

Return value

Current billboard offset value. The lower the absolute value is, the closer to the light source the billboard will be. Negative values indicate that the distance is measured in the opposite direction.

void setOffsetScale ( float scale ) #

Sets the offset-dependent scale factor for the lens flare billboard.

Arguments

  • float scale - Scale factor to be used. As the offset from the light source increases:
    • values less than 1.0f will make the billboard shrink.
    • values greater than 1.0f will make the billboard grow.

float getOffsetScale ( ) #

Returns the current offset-dependent scale factor for the lens flare billboard.

Return value

Current scale factor. As the offset from the light source increases:
  • values less than 1.0f will make the billboard shrink.
  • values greater than 1.0f will make the billboard grow.

void setUVLowerLeft ( vec2 left ) #

Sets the UV texture coordinates of the lower left corner of the lens flare billboard.

Arguments

  • vec2 left - UV texture coordinates of the lower left corner of the lens flare billboard.

vec2 getUVLowerLeft ( ) #

Returns the current UV texture coordinates of the lower left corner of the lens flare billboard.

Return value

Current UV texture coordinates of the lower left corner of the lens flare billboard.

void setUVUpperRight ( vec2 right ) #

Sets the UV texture coordinates of the upper right corner of the lens flare billboard.

Arguments

  • vec2 right - UV texture coordinates of the the upper right corner of the lens flare billboard.

vec2 getUVUpperRight ( ) #

Returns the current UV texture coordinates of the upper rightcorner of the lens flare billboard.

Return value

Current UV texture coordinates of the the upper right corner of the lens flare billboard.

void setRotate ( int rotate ) #

Enables or disables rotation of the lens flare billboard. When enabled the top of the billboard will always face the center of the screen.

Arguments

  • int rotate - 1 to rotation of the lens flare billboard, 0 to disable. The default value is 0.

int isRotate ( ) #

Returns a value indicating if rotation of the lens flare billboard is enabled. When enabled the top of the billboard will always face the center of the screen.

Return value

1 if rotation of the lens flare billboard is enabled; otherwise, 0.
Last update: 2021-12-13
Build: ()