Language:
Discover
By Skill Level
By Category

UAtmosphericFogComponent

Choose your OS:

Inheritance Hierarchy

Syntax

class UAtmosphericFogComponent : public USceneComponent

Remarks

Used to create fogging effects such as clouds.

Variables

Name Description

Public variable

float

 

AltitudeScale

Altitude scale (only Z scale).

Public variable

uint32 : 1

 

bDisableGroundScattering

Disable Color scattering from ground.

Public variable

uint32 : 1

 

bDisableSunDisk

Disable Sun Disk rendering.

Public variable

float

 

DefaultBrightness

Default light brightness. Used when there is no sunlight placed in the level. Unit is lumens

Public variable

FColor

 

DefaultLightColor

Default light color. Used when there is no sunlight placed in the level.

Public variable

float

 

DensityMultiplier

Fog density control factor.

Public variable

float

 

DensityOffset

Fog density offset to control opacity [-1.f ~ 1.f].

Public variable

float

 

DistanceOffset

Distance offset, in km (to handle large distance)

Public variable

float

 

DistanceScale

Distance scale.

Public variable

float

 

FogMultiplier

Scattering factor on object.

Public variable

FThreadSafeCoun ...

 

GameThreadServiceRequest

When non-zero, the component should flush rendering commands and see if there is any atmosphere stuff to deal with, then decrement it.

Public variable

float

 

GroundOffset

Ground offset.

Public variable

FByteBulkData

 

InscatterData

Public variable

FAtmosphereText...

 

InscatterResource

Public variable

FByteBulkData

 

IrradianceData

Public variable

FAtmosphereText...

 

IrradianceResource

Public variable

uint32

 

PrecomputeCounter

This is mostly a legacy thing, it is only modified by the game thread

Protected variable

FAtmospherePrec ...

 

PrecomputeParams

Public variable

float

 

StartDistance

Start Distance.

Public variable

float

 

SunDiscScale

Distance offset, in km (to handle large distance)

Public variable

float

 

SunMultiplier

Global scattering factor.

Public variable

FByteBulkData

 

TransmittanceData

Source vector data.

Public variable

FAtmosphereText...

 

TransmittanceResource

The resource for Inscatter.

Constructors

Name Description

Public function

UAtmosphericFogComponent

(
    const FObjectInitializer & ObjectIn...
)

Destructors

Name Description

Public function

~UAtmosphericFogComponent()

Functions

Name Description

Protected function

void

 

AddFogIfNeeded()

Public function

void

 

ApplyComponentInstanceData

(
    FAtmospherePrecomputeInstanceData&...
)

Restore the precomputed data after re-running Blueprint construction script.

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

DisableGroundScattering

(
    bool NewGroundScattering
)

Set DisableGroundScattering

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

DisableSunDisk

(
    bool NewSunDisk
)

Set DisableSunDisk

Public function

const FAtmos ...

 

GetPrecomputeParameters()

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

InitResource()

On CPU.

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

ReleaseResource()

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

SetAltitudeScale

(
    float NewAltitudeScale
)

Set AltitudeScale

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

SetDefaultBrightness

(
    float NewBrightness
)

Set brightness of the light

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

SetDefaultLightColor

(
    FLinearColor NewLightColor
)

Set color of the light

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

SetDensityMultiplier

(
    float NewDensityMultiplier
)

Set DensityMultiplier

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

SetDensityOffset

(
    float NewDensityOffset
)

Set DensityOffset

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

SetDistanceOffset

(
    float NewDistanceOffset
)

Set DistanceOffset

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

SetDistanceScale

(
    float NewDistanceScale
)

Set DistanceScale

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

SetFogMultiplier

(
    float NewFogMultiplier
)

Set FogMultiplier

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

SetPrecomputeParams

(
    float DensityHeight,
    int32 MaxScatteringOrder,
    int32 InscatterAltitudeSampleNum
)

Set PrecomputeParams, only valid in Editor mode

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

SetStartDistance

(
    float NewStartDistance
)

Set StartDistance

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

SetSunMultiplier

(
    float NewSunMultiplier
)

Set SunMultiplier

Public function

void

 

StartPrecompute()

Public function

void

 

UpdatePrecomputedData()

Overridden from UActorComponent

Name Description

Protected function Virtual

void

 

CreateRenderState_Concurrent()

Used to create any rendering thread information for this component

Protected function Virtual

void

 

DestroyRenderState_Concurrent()

Used to shut down any rendering thread structure for this component

Public function Virtual

FActorCompon ...

 

GetComponentInstanceData()

Backup the precomputed data before re-running Blueprint construction script.

Protected function Virtual

void

 

SendRenderTransform_Concurrent()

Called to send a transform update for this component to the rendering thread

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent & PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInterpChange

(
    UProperty * PropertyThatChanged
)

WITH_EDITOR.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object, and immediately after any undo/redo.

Public function Virtual

void

 

Serialize

(
    FArchive & Ar
)

UObject serializer.

Enums

Name

Description

Public enum

EPrecomputeState

References

Module

Engine

Header

Runtime/Engine/Classes/Atmosphere/AtmosphericFogComponent.h