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.

Unreal Engine C++ API Reference > Runtime > Engine > Components

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Components/ExponentialHeightFogComponent.h
Include #include "Components/ExponentialHeightFogComponent.h"

Syntax

UCLASS (ClassGroup=Rendering, CollapseCategories, HideCategories=(Object, Mobility), EditInlineNew,  
       Meta=(BlueprintSpawnableComponent), MinimalAPI)  
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

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly bool bEnableVolumetricFog Whether to enable Volumetric fog.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Interp BlueprintReadOnly uint8: 1 bHoldout If this is True, this primitive will render black with an alpha of 0, but all secondary effects (shadows, reflections, indirect lighting) remain.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly bool bOverrideLightColorsWithFogInscatteringColors Whether to use FogInscatteringColor for the Sky Light volumetric scattering color and DirectionalInscatteringColor for the Directional Light scattering color.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly uint8: 1 bRenderInMainPass If true, this component will be rendered in the main pass (basepass, transparency)
Public variable UProperty Category, Interp, Meta BlueprintReadOnly float DirectionalInscatteringExponent Controls the size of the directional inscattering cone, which is used to approximate inscattering from a directional light.
Public variable UProperty Category, Interp, Meta BlueprintReadOnly FLinearColor DirectionalInscatteringLuminance Controls the color of the directional inscattering, which is used to approximate inscattering from a directional light.
Public variable UProperty Category, Interp BlueprintReadOnly 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 UProperty Category, EditAnywhere, Meta BlueprintReadOnly float FogCutoffDistance Scene elements past this distance will not have fog applied.
Public variable UProperty Category, Interp, Meta BlueprintReadOnly float FogDensity Global density factor.
Public variable UProperty Category, Interp, Meta BlueprintReadOnly float FogHeightFalloff Height density factor, controls how the density increases as height decreases.
Public variable UProperty Category, Interp, Meta BlueprintReadOnly FLinearColor FogInscatteringLuminance  
Public variable UProperty Category, Interp, Meta BlueprintReadOnly float FogMaxOpacity Maximum opacity of the fog.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float FullyDirectionalInscatteringColorDistance Distance at which InscatteringColorCubemap should be used directly for the Inscattering Color.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< class 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 UProperty Category, EditAnywhere, Meta BlueprintReadOnly float InscatteringColorCubemapAngle Angle to rotate the InscatteringColorCubemap around the Z axis.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FLinearColor InscatteringTextureTint Tint color used when InscatteringColorCubemap is specified, for quick edits without having to reimport InscatteringColorCubemap.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float NonDirectionalInscatteringColorDistance Distance at which only the average color of InscatteringColorCubemap should be used as Inscattering Color.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FExponentialHeightFogData SecondFogData Settings for the second fog. Setting the density of this to 0 means it doesn't have any influence.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FLinearColor SkyAtmosphereAmbientContributionColorScale Color used to modulate the SkyAtmosphere component contribution to the non directional component of the fog.
Public variable UProperty Category, Interp, Meta BlueprintReadOnly float StartDistance Distance from the camera that the fog will start, in world units.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FColor VolumetricFogAlbedo The height fog particle reflectiveness used by volumetric fog.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float VolumetricFogDistance Distance over which volumetric fog should be computed, after the start distance.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FLinearColor VolumetricFogEmissive Light emitted by height fog.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float VolumetricFogExtinctionScale Scales the height fog particle extinction amount used by volumetric fog.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float VolumetricFogNearFadeInDistance Distance over which volumetric fog will fade in from the start distance.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float VolumetricFogScatteringDistribution Controls the scattering phase function - how much incoming light scatters in various directions.
Public variable UProperty Category, Interp, Meta BlueprintReadOnly float VolumetricFogStartDistance Distance from the camera that the volumetric fog will start, in world units.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float VolumetricFogStaticLightingScatteringIntensity  

Constructors

  Type Name Description
Public function  

UExponentialHeightFogComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetFogCutoffDistance ( float Value
)

  
Public function UFunction BlueprintCallable, Category void

SetFogDensity ( float Value
)

  
Public function UFunction BlueprintCallable, Category void

SetFogHeightFalloff ( float Value
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetFogMaxOpacity ( float Value
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetHoldout ( bool bNewHoldout
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetRenderInMainPass ( bool bValue
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetSecondFogDensity ( float Value
)

  
Public function UFunction BlueprintCallable, Category void

SetSecondFogHeightFalloff ( float Value
)

  
Public function UFunction BlueprintCallable, Category void

SetSecondFogHeightOffset ( float Value
)

  
Public function UFunction BlueprintCallable, Category void

SetStartDistance ( float Value
)

  
Public function UFunction BlueprintCallable, Category void

SetVolumetricFog ( bool bNewValue
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetVolumetricFogDistance ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetVolumetricFogExtinctionScale ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category void  

Overridden from UActorComponent

  Type Name Description
Protected function Virtual void Used to create any rendering thread information for this component
Protected function Virtual void Used to shut down any rendering thread structure for this component
Protected function Virtual void Called to send a transform update for this component to the rendering thread

Overridden from UObject

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

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

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Public variable UProperty FLinearColor DirectionalInscatteringColor_DEPRECATED  
Public variable UProperty FLinearColor FogInscatteringColor_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page