Language:
Discover
By Skill Level
By Category

UExponentialHeightFogComponent

Choose your OS:

Inheritance Hierarchy

Syntax

class UExponentialHeightFogComponent : public USceneComponent

Remarks

Used to create fogging effects such as clouds but with a density that is related to the height of the fog.

Variables

Name Description

Public variable

bool

 

bEnableVolumetricFog

Whether to enable Volumetric fog.

Public variable

bool

 

bOverrideLightColorsWithFogInscatteringColors

Whether to use FogInscatteringColor for the Sky Light volumetric scattering color and DirectionalInscatteringColor for the Directional Light scattering color.

Public variable

FLinearColor

 

DirectionalInscatteringColor

Controls the color of the directional inscattering, which is used to approximate inscattering from a directional light.

Public variable

float

 

DirectionalInscatteringExponent

Controls the size of the directional inscattering cone, which is used to approximate inscattering from a directional light.

Public variable

float

 

DirectionalInscatteringStartDistance

Controls the start distance from the viewer of the directional inscattering, which is used to approximate inscattering from a directional light.

Public variable

float

 

FogCutoffDistance

Scene elements past this distance will not have fog applied.

Public variable

float

 

FogDensity

Global density factor.

Public variable

float

 

FogHeightFalloff

Height density factor, controls how the density increases as height decreases.

Public variable

FLinearColor

 

FogInscatteringColor

Public variable

float

 

FogMaxOpacity

Maximum opacity of the fog.

Public variable

float

 

FullyDirectionalInscatteringColorDistance

Distance at which InscatteringColorCubemap should be used directly for the Inscattering Color.

Public variable

UTextureCube &#...

 

InscatteringColorCubemap

Cubemap that can be specified for fog color, which is useful to make distant, heavily fogged scene elements match the sky.

Public variable

float

 

InscatteringColorCubemapAngle

Angle to rotate the InscatteringColorCubemap around the Z axis.

Public variable

FLinearColor

 

InscatteringTextureTint

Tint color used when InscatteringColorCubemap is specified, for quick edits without having to reimport InscatteringColorCubemap.

Public variable

float

 

NonDirectionalInscatteringColorDistance

Distance at which only the average color of InscatteringColorCubemap should be used as Inscattering Color.

Public variable

float

 

StartDistance

Distance from the camera that the fog will start, in world units.

Public variable

FColor

 

VolumetricFogAlbedo

The height fog particle reflectiveness used by volumetric fog.

Public variable

float

 

VolumetricFogDistance

Distance over which volumetric fog should be computed.

Public variable

FLinearColor

 

VolumetricFogEmissive

Light emitted by height fog.

Public variable

float

 

VolumetricFogExtinctionScale

Scales the height fog particle extinction amount used by volumetric fog.

Public variable

float

 

VolumetricFogScatteringDistribution

Controls the scattering phase function - how much incoming light scatters in various directions.

Public variable

float

 

VolumetricFogStaticLightingScatteringIntensity

Constructors

Name Description

Public function

UExponentialHeightFogComponent

(
    const FObjectInitializer & ObjectIn...
)

============================================================================= HeightFogComponent.cpp: Height fog implementation.

Functions

Name Description

Protected function

void

 

AddFogIfNeeded()

Public function

void

 

SetDirectionalInscatteringColor

(
    FLinearColor Value
)

Public function

void

 

SetDirectionalInscatteringExponent

(
    float Value
)

Public function

void

 

SetDirectionalInscatteringStartDistance

(
    float Value
)

Public function

void

 

SetFogCutoffDistance

(
    float Value
)

Public function

void

 

SetFogDensity

(
    float Value
)

Public function

void

 

SetFogHeightFalloff

(
    float Value
)

Public function

void

 

SetFogInscatteringColor

(
    FLinearColor Value
)

Public function

void

 

SetFogMaxOpacity

(
    float Value
)

Public function

void

 

SetFullyDirectionalInscatteringColorDistance

(
    float Value
)

Public function

void

 

SetInscatteringColorCubemap

(
    UTextureCube * Value
)

Public function

void

 

SetInscatteringColorCubemapAngle

(
    float Value
)

Public function

void

 

SetInscatteringTextureTint

(
    FLinearColor Value
)

Public function

void

 

SetNonDirectionalInscatteringColorDistance

(
    float Value
)

Public function

void

 

SetStartDistance

(
    float Value
)

Public function

void

 

SetVolumetricFog

(
    bool bNewValue
)

Public function

void

 

SetVolumetricFogAlbedo

(
    FColor NewValue
)

Public function

void

 

SetVolumetricFogDistance

(
    float NewValue
)

Public function

void

 

SetVolumetricFogEmissive

(
    FLinearColor NewValue
)

Public function

void

 

SetVolumetricFogExtinctionScale

(
    float NewValue
)

Public function

void

 

SetVolumetricFogScatteringDistribution

(
    float NewValue
)

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

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

bool

 

CanEditChange

(
    const UProperty * InProperty
)

Called by the editor to query whether a property of this object is allowed to be modified.

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.

References

Module

Engine

Header

Runtime/Engine/Classes/Components/ExponentialHeightFogComponent.h