Class ExponentialHeightFogComponent
Used to create fogging effects such as clouds but with a density that is related to the height of the fog.
Inherited Members
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class ExponentialHeightFogComponent : SceneComponentProperties
| Improve this Doc View SourcebEnableVolumetricFog
Declaration
public bool bEnableVolumetricFog { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
bOverrideLightColorsWithFogInscatteringColors
Declaration
public bool bOverrideLightColorsWithFogInscatteringColors { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
DefaultObject
Get UE4 Default Object for this Class
Declaration
public static ExponentialHeightFogComponent DefaultObject { get; }Property Value
| Type | Description |
|---|---|
| ExponentialHeightFogComponent |
DirectionalInscatteringColor
Controls the color of the directional inscattering, which is used to approximate inscattering from a directional light.
Declaration
public LinearColor DirectionalInscatteringColor { get; }Property Value
| Type | Description |
|---|---|
| LinearColor |
Remarks
Note: there must be a directional light with bUsedAsAtmosphereSunLight enabled for DirectionalInscattering to be used.
DirectionalInscatteringExponent
Controls the size of the directional inscattering cone, which is used to approximate inscattering from a directional light.
Declaration
public float DirectionalInscatteringExponent { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
Remarks
Note: there must be a directional light with bUsedAsAtmosphereSunLight enabled for DirectionalInscattering to be used.
DirectionalInscatteringStartDistance
Controls the start distance from the viewer of the directional inscattering, which is used to approximate inscattering from a directional light.
Declaration
public float DirectionalInscatteringStartDistance { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
Remarks
Note: there must be a directional light with bUsedAsAtmosphereSunLight enabled for DirectionalInscattering to be used.
FogCutoffDistance
Scene elements past this distance will not have fog applied. This is useful for excluding skyboxes which already have fog baked in.
Declaration
public float FogCutoffDistance { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
FogDensity
Global density factor.
Declaration
public float FogDensity { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
FogHeightFalloff
Height density factor, controls how the density increases as height decreases.
Declaration
public float FogHeightFalloff { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
Remarks
Smaller values make the visible transition larger.
FogInscatteringColor
Fog Inscattering Color
Declaration
public LinearColor FogInscatteringColor { get; }Property Value
| Type | Description |
|---|---|
| LinearColor |
FogMaxOpacity
Maximum opacity of the fog.
Declaration
public float FogMaxOpacity { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
Remarks
A value of 1 means the fog can become fully opaque at a distance and replace scene color completely, A value of 0 means the fog color will not be factored in at all.
FullyDirectionalInscatteringColorDistance
Distance at which InscatteringColorCubemap should be used directly for the Inscattering Color.
Declaration
public float FullyDirectionalInscatteringColorDistance { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
InscatteringColorCubemap
Cubemap that can be specified for fog color, which is useful to make distant, heavily fogged scene elements match the sky.
Declaration
public TextureCube InscatteringColorCubemap { get; }Property Value
| Type | Description |
|---|---|
| TextureCube |
Remarks
When the cubemap is specified, FogInscatteringColor is ignored and Directional inscattering is disabled.
InscatteringColorCubemapAngle
Angle to rotate the InscatteringColorCubemap around the Z axis.
Declaration
public float InscatteringColorCubemapAngle { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
InscatteringTextureTint
Tint color used when InscatteringColorCubemap is specified, for quick edits without having to reimport InscatteringColorCubemap.
Declaration
public LinearColor InscatteringTextureTint { get; }Property Value
| Type | Description |
|---|---|
| LinearColor |
NonDirectionalInscatteringColorDistance
Distance at which only the average color of InscatteringColorCubemap should be used as Inscattering Color.
Declaration
public float NonDirectionalInscatteringColorDistance { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
StartDistance
Distance from the camera that the fog will start, in world units.
Declaration
public float StartDistance { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
StaticClass
Get UE4 Class
Declaration
public static Class StaticClass { get; }Property Value
| Type | Description |
|---|---|
| Class |
VolumetricFogAlbedo
The height fog particle reflectiveness used by volumetric fog.
Declaration
public Color VolumetricFogAlbedo { get; }Property Value
| Type | Description |
|---|---|
| Color |
Remarks
Water particles in air have an albedo near white, while dust has slightly darker value.
VolumetricFogDistance
Distance over which volumetric fog should be computed. Larger values extend the effect into the distance but expose under-sampling artifacts in details.
Declaration
public float VolumetricFogDistance { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
VolumetricFogEmissive
Light emitted by height fog.
Declaration
public LinearColor VolumetricFogEmissive { get; }Property Value
| Type | Description |
|---|---|
| LinearColor |
Remarks
This is a density so more light is emitted the further you are looking through the fog. In most cases skylight is a better choice, however right now volumetric fog does not support precomputed lighting, So stationary skylights are unshadowed and static skylights don't affect volumetric fog at all.
VolumetricFogExtinctionScale
Scales the height fog particle extinction amount used by volumetric fog. Values larger than 1 cause fog particles everywhere absorb more light.
Declaration
public float VolumetricFogExtinctionScale { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
VolumetricFogScatteringDistribution
Controls the scattering phase function - how much incoming light scatters in various directions.
Declaration
public float VolumetricFogScatteringDistribution { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
Remarks
A distribution value of 0 scatters equally in all directions, while .9 scatters predominantly in the light direction. In order to have visible volumetric fog light shafts from the side, the distribution will need to be closer to 0.
VolumetricFogStaticLightingScatteringIntensity
Volumetric Fog Static Lighting Scattering Intensity
Declaration
public float VolumetricFogStaticLightingScatteringIntensity { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
Methods
| Improve this Doc View SourceNew(UObject, Name)
Spawn an object of this class
Declaration
public static ExponentialHeightFogComponent New(UObject obj = null, Name name = default(Name))Parameters
| Type | Name | Description |
|---|---|---|
| UObject | obj | |
| Name | name |
Returns
| Type | Description |
|---|---|
| ExponentialHeightFogComponent |
SetDirectionalInscatteringColor(LinearColor)
Set Directional Inscattering Color
Declaration
public void SetDirectionalInscatteringColor(LinearColor Value)Parameters
| Type | Name | Description |
|---|---|---|
| LinearColor | Value |
SetDirectionalInscatteringExponent(Single)
Set Directional Inscattering Exponent
Declaration
public void SetDirectionalInscatteringExponent(float Value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | Value |
SetDirectionalInscatteringStartDistance(Single)
Set Directional Inscattering Start Distance
Declaration
public void SetDirectionalInscatteringStartDistance(float Value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | Value |
SetFogCutoffDistance(Single)
Set Fog Cutoff Distance
Declaration
public void SetFogCutoffDistance(float Value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | Value |
SetFogDensity(Single)
Set Fog Density
Declaration
public void SetFogDensity(float Value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | Value |
SetFogHeightFalloff(Single)
Set Fog Height Falloff
Declaration
public void SetFogHeightFalloff(float Value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | Value |
SetFogInscatteringColor(LinearColor)
Set Fog Inscattering Color
Declaration
public void SetFogInscatteringColor(LinearColor Value)Parameters
| Type | Name | Description |
|---|---|---|
| LinearColor | Value |
SetFogMaxOpacity(Single)
Set Fog Max Opacity
Declaration
public void SetFogMaxOpacity(float Value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | Value |
SetFullyDirectionalInscatteringColorDistance(Single)
Set Fully Directional Inscattering Color Distance
Declaration
public void SetFullyDirectionalInscatteringColorDistance(float Value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | Value |
SetInscatteringColorCubemap(TextureCube)
Set Inscattering Color Cubemap
Declaration
public void SetInscatteringColorCubemap(TextureCube Value)Parameters
| Type | Name | Description |
|---|---|---|
| TextureCube | Value |
SetInscatteringColorCubemapAngle(Single)
Set Inscattering Color Cubemap Angle
Declaration
public void SetInscatteringColorCubemapAngle(float Value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | Value |
SetInscatteringTextureTint(LinearColor)
Set Inscattering Texture Tint
Declaration
public void SetInscatteringTextureTint(LinearColor Value)Parameters
| Type | Name | Description |
|---|---|---|
| LinearColor | Value |
SetNonDirectionalInscatteringColorDistance(Single)
Set Non Directional Inscattering Color Distance
Declaration
public void SetNonDirectionalInscatteringColorDistance(float Value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | Value |
SetStartDistance(Single)
Set Start Distance
Declaration
public void SetStartDistance(float Value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | Value |
SetVolumetricFog(Boolean)
Set Volumetric Fog
Declaration
public void SetVolumetricFog(bool bNewValue)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | bNewValue |
SetVolumetricFogAlbedo(Color)
Set Volumetric Fog Albedo
Declaration
public void SetVolumetricFogAlbedo(Color NewValue)Parameters
| Type | Name | Description |
|---|---|---|
| Color | NewValue |
SetVolumetricFogDistance(Single)
Set Volumetric Fog Distance
Declaration
public void SetVolumetricFogDistance(float NewValue)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | NewValue |
SetVolumetricFogEmissive(LinearColor)
Set Volumetric Fog Emissive
Declaration
public void SetVolumetricFogEmissive(LinearColor NewValue)Parameters
| Type | Name | Description |
|---|---|---|
| LinearColor | NewValue |
SetVolumetricFogExtinctionScale(Single)
Set Volumetric Fog Extinction Scale
Declaration
public void SetVolumetricFogExtinctionScale(float NewValue)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | NewValue |
SetVolumetricFogScatteringDistribution(Single)
Set Volumetric Fog Scattering Distribution
Declaration
public void SetVolumetricFogScatteringDistribution(float NewValue)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | NewValue |
Operators
| Improve this Doc View SourceImplicit(IntPtr to ExponentialHeightFogComponent)
Convert from IntPtr to UObject
Declaration
public static implicit operator ExponentialHeightFogComponent(IntPtr p)Parameters
| Type | Name | Description |
|---|---|---|
| System.IntPtr | p |
Returns
| Type | Description |
|---|---|
| ExponentialHeightFogComponent |