1. Epic GamesDeveloper
  3. UExponentialHeightFogComponent

UExponentialHeightFogComponent

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

API > API/Runtime > API/Runtime/Engine

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

   
Name UExponentialHeightFogComponent
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Components/ExponentialHeightFogComponent.h
Include Path #include "Components/ExponentialHeightFogComponent.h"

Syntax

UCLASS (ClassGroup=Rendering, CollapseCategories, HideCategories=(Object, Mobility), EditInlineNew,  
       Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class UExponentialHeightFogComponent : public USceneComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UExponentialHeightFogComponent ( const FObjectInitializer& ObjectInitializer
)

   Components/ExponentialHeightFogComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bEnableVolumetricFog bool Whether to enable Volumetric fog. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=VolumetricFog
  • Meta=(DisplayName="Volumetric Fog")
bHoldout uint8 If this is True, this primitive will render black with an alpha of 0, but all secondary effects (shadows, reflections, indirect lighting) remain. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • AdvancedDisplay
  • BlueprintReadOnly
  • Category=Rendering
  • Interp
bOverrideLightColorsWithFogInscatteringColors bool Whether to use FogInscatteringColor for the Sky Light volumetric scattering color and DirectionalInscatteringColor for the Directional Light scattering color. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=VolumetricFog
  • AdvancedDisplay
bRenderInMainPass uint8 If true, this component will be rendered in the main pass (basepass, transparency) Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • AdvancedDisplay
  • BlueprintReadOnly
  • Category=Rendering
bVisibleInRealTimeSkyCaptures uint8 If true, this component will be visible in real-time sky light reflection captures. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • AdvancedDisplay
  • BlueprintReadOnly
  • Category=Rendering
bVisibleInReflectionCaptures uint8 If true, this component will be visible in reflection captures. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • AdvancedDisplay
  • BlueprintReadOnly
  • Category=Rendering
DirectionalInscatteringExponent float Controls the size of the directional inscattering cone, which is used to approximate inscattering from a directional light. Components/ExponentialHeightFogComponent.h
  • BlueprintReadOnly
  • Interp
  • Category=DirectionalInscattering
  • Meta=(UIMin="2", UIMax="64")
DirectionalInscatteringLuminance FLinearColor Controls the color of the directional inscattering, which is used to approximate inscattering from a directional light. Components/ExponentialHeightFogComponent.h
  • BlueprintReadOnly
  • Interp
  • Category=DirectionalInscattering
  • Meta=(DisplayName="Directional Inscattering Color")
DirectionalInscatteringStartDistance float Controls the start distance from the viewer of the directional inscattering, which is used to approximate inscattering from a directional light. Components/ExponentialHeightFogComponent.h
  • BlueprintReadOnly
  • Interp
  • Category=DirectionalInscattering
EndDistance float Distance from the camera, on the horizontal XY plane, that the fog will end integrating the lighting and transmittance. Components/ExponentialHeightFogComponent.h
  • BlueprintReadOnly
  • Interp
  • Category=ExponentialHeightFogComponent
  • Meta=(UIMin="0", UIMax="500000")
FogCutoffDistance float Scene elements past this distance will not have fog applied. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=ExponentialHeightFogComponent
  • Meta=(UIMin="100000", UIMax="20000000")
FogDensity float Global density factor. Components/ExponentialHeightFogComponent.h
  • BlueprintReadOnly
  • Interp
  • Category=ExponentialHeightFogComponent
  • Meta=(UIMin="0", UIMax=".05")
FogHeightFalloff float Height density factor, controls how the density increases as height decreases. Components/ExponentialHeightFogComponent.h
  • BlueprintReadOnly
  • Interp
  • Category=ExponentialHeightFogComponent
  • Meta=(UIMin="0.001", UIMax="2")
FogInscatteringLuminance FLinearColor Note: when r.SupportExpFogMatchesVolumetricFog = 1, this value is ignored and the volumetric fog Emissive is used instead. Components/ExponentialHeightFogComponent.h
  • BlueprintReadOnly
  • Interp
  • Category=ExponentialHeightFogComponent
  • Meta=(DisplayName="Fog Inscattering Color")
FogMaxOpacity float Maximum opacity of the fog. Components/ExponentialHeightFogComponent.h
  • BlueprintReadOnly
  • Interp
  • Category=ExponentialHeightFogComponent
  • Meta=(UIMin="0", UIMax="1")
FullyDirectionalInscatteringColorDistance float Distance at which InscatteringColorCubemap should be used directly for the Inscattering Color. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=InscatteringTexture
  • Meta=(UIMin="1000", UIMax="1000000")
InscatteringColorCubemap TObjectPtr< class UTextureCube > Cubemap that can be specified for fog color, which is useful to make distant, heavily fogged scene elements match the sky. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=InscatteringTexture
InscatteringColorCubemapAngle float Angle to rotate the InscatteringColorCubemap around the Z axis. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=InscatteringTexture
  • Meta=(UIMin="0", UIMax="360")
InscatteringTextureTint FLinearColor Tint color used when InscatteringColorCubemap is specified, for quick edits without having to reimport InscatteringColorCubemap. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=InscatteringTexture
NonDirectionalInscatteringColorDistance float Distance at which only the average color of InscatteringColorCubemap should be used as Inscattering Color. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=InscatteringTexture
  • Meta=(UIMin="1000", UIMax="1000000")
SecondFogData FExponentialHeightFogData Settings for the second fog. Setting the density of this to 0 means it doesn't have any influence. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=ExponentialHeightFogComponent
SkyAtmosphereAmbientContributionColorScale FLinearColor Color used to modulate the SkyAtmosphere component contribution to the non directional component of the fog. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=ExponentialHeightFogComponent
StartDistance float Distance from the camera that the fog will start, in world units. Components/ExponentialHeightFogComponent.h
  • BlueprintReadOnly
  • Interp
  • Category=ExponentialHeightFogComponent
  • Meta=(UIMin="0", UIMax="5000")
VolumetricFogAlbedo FColor The height fog particle reflectiveness used by volumetric fog. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=VolumetricFog
  • Meta=(DisplayName="Albedo")
VolumetricFogDistance float Distance over which volumetric fog should be computed, after the start distance. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=VolumetricFog
  • Meta=(DisplayName="View Distance", UIMin="1000", UIMax="10000")
VolumetricFogEmissive FLinearColor Light emitted by height fog. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=VolumetricFog
  • Meta=(DisplayName="Emissive")
VolumetricFogExtinctionScale float Scales the height fog particle extinction amount used by volumetric fog. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=VolumetricFog
  • Meta=(DisplayName="Extinction Scale", UIMin=".1", UIMax="10")
VolumetricFogNearFadeInDistance float Distance over which volumetric fog will fade in from the start distance. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=VolumetricFog
  • Meta=(DisplayName="Near Fade In Distance", UIMin="0", UIMax="1000")
VolumetricFogScatteringDistribution float Controls the scattering phase function - how much incoming light scatters in various directions. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=VolumetricFog
  • Meta=(DisplayName="Scattering Distribution", UIMin="-.9", UIMax=".9")
VolumetricFogStartDistance float Distance from the camera that the volumetric fog will start, in world units. Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=VolumetricFog
  • Meta=(DisplayName="Start Distance", UIMin="0", UIMax="5000")
VolumetricFogStaticLightingScatteringIntensity float   Components/ExponentialHeightFogComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=VolumetricFog
  • Meta=(DisplayName="Static Lighting Scattering Intensity", UIMin="0", UIMax="10")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void SetDirectionalInscatteringColor ( FLinearColor Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetDirectionalInscatteringExponent ( float Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetDirectionalInscatteringStartDistance ( float Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetEndDistance ( float Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetFogCutoffDistance ( float Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetFogDensity ( float Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetFogHeightFalloff ( float Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetFogInscatteringColor ( FLinearColor Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetFogMaxOpacity ( float Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetFullyDirectionalInscatteringColorDistance ( float Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetHoldout ( bool bNewHoldout
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering"

void SetInscatteringColorCubemap ( UTextureCube* Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetInscatteringColorCubemapAngle ( float Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetInscatteringTextureTint ( FLinearColor Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetNonDirectionalInscatteringColorDistance ( float Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetRenderInMainPass ( bool bValue
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering"

void SetSecondFogData ( FExponentialHeightFogData NewValue
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|VolumetricFog"

void SetSecondFogDensity ( float Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetSecondFogHeightFalloff ( float Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetSecondFogHeightOffset ( float Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetSkyAtmosphereAmbientContributionColorScale ( FLinearColor NewValue
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|DirectionalInscattering"

void SetStartDistance ( float Value
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|Components|ExponentialHeightFog"

void SetVolumetricFog ( bool bNewValue
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|VolumetricFog"

void SetVolumetricFogAlbedo ( FColor NewValue
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|VolumetricFog"

void SetVolumetricFogDistance ( float NewValue
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|VolumetricFog"

void SetVolumetricFogEmissive ( FLinearColor NewValue
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|VolumetricFog"

void SetVolumetricFogExtinctionScale ( float NewValue
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|VolumetricFog"

void SetVolumetricFogNearFadeInDistance ( float NewValue
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|VolumetricFog"

void SetVolumetricFogScatteringDistribution ( float NewValue
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|VolumetricFog"

void SetVolumetricFogStartDistance ( float NewValue
)

   Components/ExponentialHeightFogComponent.h
  • BlueprintCallable
  • Category="Rendering|VolumetricFog"

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   Components/ExponentialHeightFogComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/ExponentialHeightFogComponent.h  

virtual void Serialize ( FArchive& Ar
)

   Components/ExponentialHeightFogComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddFogIfNeeded()

   Components/ExponentialHeightFogComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers
Used to create any rendering thread information for this component Components/ExponentialHeightFogComponent.h  
Used to shut down any rendering thread structure for this component Components/ExponentialHeightFogComponent.h  
Called to send a transform update for this component to the rendering thread Components/ExponentialHeightFogComponent.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
DirectionalInscatteringColor_DEPRECATED FLinearColor   Components/ExponentialHeightFogComponent.h  
FogInscatteringColor_DEPRECATED FLinearColor   Components/ExponentialHeightFogComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page