| UObjectBase
|
Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/Atmosphere/AtmosphericFogComponent.h |
Include |
#include "Atmosphere/AtmosphericFogComponent.h" |
class UAtmosphericFogComponent : public USceneComponent
Used to create fogging effects such as clouds.
Name | Description | ||
---|---|---|---|
|
float |
AltitudeScale |
Scale the view altitude (only Z scale). |
|
uint32: 1 |
bAtmosphereAffectsSunIlluminance |
Set to true if the atmosphere should affect the selected sun light illuminance. |
|
uint32: 1 |
bDisableGroundScattering |
Disable color scattering from ground. |
|
uint32: 1 |
bDisableSunDisk |
Disable sun disk rendering. |
|
float |
DefaultBrightness |
Default atmospheric sun light disc luminance. |
|
DefaultLightColor |
Default atmospheric sun light disc color. Used when there is no sunlight placed in the level. |
|
|
float |
DensityMultiplier |
Scales the atmosphere transmittance over background. |
|
float |
DensityOffset |
Offset the atmosphere transmittance over background [-1.f ~ 1.f]. |
|
float |
DistanceOffset |
Apply a distance offset before evaluating the atmospheric fog, in km (to handle large distance). |
|
float |
DistanceScale |
Scale the view position. |
|
float |
FogMultiplier |
Scale the scattered luminance from the atmosphere sun light only on surfaces, excludes the sky. |
|
GameThreadServiceRequest |
When non-zero, the component should flush rendering commands and see if there is any atmosphere stuff to deal with, then decrement it. |
|
|
float |
GroundOffset |
Offset the view altitude (along Z). |
|
InscatterData |
||
|
FAtmosphereText... |
InscatterResource |
Stores in-scattered luminance toward a point according to height and sun direction. |
|
IrradianceData |
||
|
FAtmosphereText... |
IrradianceResource |
Stores ground illuminance as a function of sun direction and atmosphere radius. |
|
PrecomputeCounter |
This is mostly a legacy thing, it is only modified by the game thread |
|
|
PrecomputeParams |
||
|
float |
StartDistance |
The atmospheric fog start distance in centimeters. |
|
float |
SunDiscScale |
Sun half apex angle in degree, see https://en.wikipedia.org/wiki/Solid_angle |
|
float |
SunMultiplier |
Scale the scattered luminance from the atmosphere sun light. |
|
TransmittanceData |
Source vector data. |
|
|
FAtmosphereText... |
TransmittanceResource |
Stores colored transmittance from outer space to point in atmosphere. |
Name | Description | |
---|---|---|
|
UAtmosphericFogComponent ( |
Name | Description | |
---|---|---|
|
~UAtmosphericFogComponent() |
Name | Description | ||
---|---|---|---|
|
AddFogIfNeeded() |
||
|
ApplyComponentInstanceData |
||
|
DisableGroundScattering ( |
Set DisableGroundScattering |
|
|
DisableSunDisk ( |
Set DisableSunDisk |
|
|
const FAtmos... |
GetPrecomputeParameters() |
|
|
GetTransmittance ( |
This needs to be in this header to be accessible to Lightmass. |
|
|
GetTransmittance ( |
This needs to be in this header to be accessible to Lightmass. |
|
|
InitResource() |
||
|
ReleaseResource() |
||
|
SetAltitudeScale ( |
Set AltitudeScale |
|
|
SetDefaultBrightness ( |
Set brightness of the light |
|
|
SetDefaultLightColor ( |
Set color of the light |
|
|
SetDensityMultiplier ( |
Set DensityMultiplier |
|
|
SetDensityOffset ( |
Set DensityOffset |
|
|
SetDistanceOffset ( |
Set DistanceOffset |
|
|
SetDistanceScale ( |
Set DistanceScale |
|
|
SetFogMultiplier ( |
Set FogMultiplier |
|
|
SetPrecomputeParams |
Set PrecomputeParams, only valid in Editor mode |
|
|
SetStartDistance ( |
Set StartDistance |
|
|
SetSunMultiplier ( |
Set SunMultiplier |
|
|
StartPrecompute() |
||
|
UpdatePrecomputedData() |
Name | Description | ||
---|---|---|---|
|
CreateRenderState_Concurrent ( |
Used to create any rendering thread information for this component |
|
|
DestroyRenderState_Concurrent() |
Used to shut down any rendering thread structure for this component |
|
|
TStructOnSco... |
GetComponentInstanceData() |
Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation |
|
SendRenderTransform_Concurrent() |
Called to send a transform update for this component to the rendering thread |
Name | Description | ||
---|---|---|---|
|
BeginDestroy() |
Called before destroying the object. |
|
|
IsDestructionThreadSafe() |
Because FAtmospherePrecomputeDataHandler is a FTicableEditorObject and its destruction is not thread safe. |
|
|
IsPostLoadThreadSafe() |
Called during async load to determine if PostLoad can be called on the loading thread. |
|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostInterpChange ( |
This is called when property is modified by InterpPropertyTracks |
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
Name |
Description |
|
---|---|---|
|
EPrecomputeState |
Name | Description | ||
---|---|---|---|
|
UTexture2D *... |
IrradianceTexture_DEPRECATED |
|
|
UTexture2D *... |
TransmittanceTexture_DEPRECATED |