UE3:LensFlare (UT3)

Object >> LensFlare

Package:

Engine

This class in other games:

UDK

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Properties

Property group 'Bounds'

bUseFixedRelativeBoundingBox

Type: bool

If TRUE, use the given bounds. If FALSE and a static mesh is set for the source, the static mesh bounds will be used. If FALSE and no static mesh is set, it will use the default bounds (likely not a good thing).

FixedRelativeBoundingBox

Type: Object.Box

The fixed bounding box to use when bUseFixedRelativeBoundingBox is TRUE

Property group 'Debug'

bRenderDebugLines

Type: bool

Debugging helpers

Property group 'Occlusion'

ScreenPercentageMap

Type: DistributionFloat.RawDistributionFloat

Occlusion.

Default value:

Member	Value
Distribution	DistributionScreenPercentageMap
LookupTable	1.0 1.0 1.0 1.0
LookupTableChunkSize	1
LookupTableNumElements	1
Op	1

Property group 'Reflections'

Reflections

Type: array<LensFlareElement>

Modifiers: editinline, export

The individual reflection elements of the lens flare

ReflectionsDPG

Type: Scene.ESceneDepthPriorityGroup

Modifiers: const

The scene depth priority group to draw the reflection primitive(s) in.

Default value: SDPG_Foreground

Property group 'Source'

SourceDPG

Type: Scene.ESceneDepthPriorityGroup

Modifiers: const

The scene depth priority group to draw the source primitive in.

Default value: SDPG_World

SourceElement

Type: LensFlareElement

Modifiers: editinline, export

The Source of the lens flare

Default value:

Member	Value
Alpha	Member Value Distribution DistributionAlpha LookupTable 1.0 1.0 1.0 1.0 LookupTableChunkSize 1 LookupTableNumElements 1 Op 1
AxisScaling	Member Value Distribution DistributionAxisScaling LookupTable 0.0 1.0 1.0 1.0 0.0 1.0 1.0 0.0 LookupTableChunkSize 3 LookupTableNumElements 1 Op 1
bIsEnabled	True
Color	Member Value Distribution DistributionColor LookupTable 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 LookupTableChunkSize 3 LookupTableNumElements 1 Op 1
ElementName	'Source'
LFMaterialIndex	Member Value Distribution DistributionLFMaterialIndex LookupTable 0.0 0.0 0.0 0.0 LookupTableChunkSize 1 LookupTableNumElements 1 Op 1
Offset	Member Value Distribution DistributionOffset LookupTable 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 LookupTableChunkSize 3 LookupTableNumElements 1 Op 1
Rotation	Member Value Distribution DistributionRotation LookupTable 0.0 0.0 0.0 0.0 LookupTableChunkSize 1 LookupTableNumElements 1 Op 1
Scaling	Member Value Distribution DistributionScaling LookupTable 1.0 1.0 1.0 1.0 LookupTableChunkSize 1 LookupTableNumElements 1 Op 1
Size	Member Value X 0.5 Y 0.5 Z 0.0

SourceMesh

Type: StaticMesh

The StaticMesh to use as the source (optional)

Property group 'Visibility'

ConeFudgeFactor

Type: float

Default value: 0.5

InnerCone

Type: float

OuterCone

Type: float

Viewing cone angles.

Radius

Type: float

Internal variables

CurveEdSetup

Type: InterpCurveEdSetup

Modifiers: export

Used for curve editor to remember curve-editing setup.

ReflectionCount

Type: int

Modifiers: transient

Internal variable used to initialize new entries in the Reflectsions array

ThumbnailAngle

Type: Object.Rotator

The angle to use when rendering the thumbnail image

ThumbnailDistance

Type: float

The distance to place the system when rendering the thumbnail image

ThumbnailImage

Type: Texture2D

Internal: The thumbnail image

ThumbnailImageOutOfDate

Type: bool

Internal: Indicates the thumbnail image is out of date

Structs

LensFlareElement

Modifiers: native

LensFlare Element

name ElementName

The name of the element. (Optional)

float RayDistance

The position along the ray from the source to the viewpoint to render the flare at.

0.0 = At the source 1.0 = The source point reflected about the view center. < 0 = The point along the ray going away from the center past the source. > 1 = The point along the ray beyond the 'end point' of the ray reflection.

bool bIsEnabled

Whether the element is enabled or not

bool bUseSourceDistance

Whether the element value look ups should use the radial distance

from the center to the edge of the screen or the ratio of the distance from the source element.

bool bNormalizeRadialDistance

Whether the radial distance should be normalized to a unit value.

Without this, the radial distance will be 0..1 in the horizontal and vertical cases. It will be 0..1.4 in the corners.

bool bModulateColorBySource

Whether the element color value should be scaled by the source color.

Object.Vector Size

The 'base' size of the element

array<MaterialInterface> LFMaterials

The material(s) to use for the flare element.

DistributionFloat.RawDistributionFloat LFMaterialIndex

Index of the material to use from the LFMaterial array.

DistributionFloat.RawDistributionFloat Scaling

Global scaling.

DistributionVector.RawDistributionVector AxisScaling

Anamorphic scaling.

DistributionFloat.RawDistributionFloat Rotation

Rotation.

DistributionVector.RawDistributionVector Color

Color.

DistributionFloat.RawDistributionFloat Alpha

DistributionVector.RawDistributionVector Offset

Offset.

DistributionVector.RawDistributionVector DistMap_Scale

Source to camera distance scaling.

DistributionVector.RawDistributionVector DistMap_Color

DistributionFloat.RawDistributionFloat DistMap_Alpha

Default values:

Property	Value
Alpha	Member Value Distribution DistributionAlpha
AxisScaling	Member Value Distribution DistributionAxisScaling
bNormalizeRadialDistance	True
Color	Member Value Distribution DistributionColor
DistMap_Alpha	Member Value Distribution DistributionDistMap_Alpha
DistMap_Color	Member Value Distribution DistributionDistMap_Color
DistMap_Scale	Member Value Distribution DistributionDistMap_Scale
LFMaterialIndex	Member Value Distribution DistributionLFMaterialIndex
Offset	Member Value Distribution DistributionOffset
RayDistance	0.0
Rotation	Member Value Distribution DistributionRotation
Scaling	Member Value Distribution DistributionScaling

LensFlareElementCurvePair

Modifiers: native, transient

Helper for getting curves from distributions

string CurveName

Object CurveObject