Class AtmosphericFogComponent

Used to create fogging effects such as clouds.

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
AtmosphericFogComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class AtmosphericFogComponent : SceneComponent

Properties

| Improve this Doc View Source

AltitudeScale

Altitude scale (only Z scale).

Declaration
public float AltitudeScale { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

bDisableGroundScattering

Declaration
public bool bDisableGroundScattering { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bDisableSunDisk

Declaration
public bool bDisableSunDisk { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultBrightness

Default light brightness. Used when there is no sunlight placed in the level. Unit is lumens

Declaration
public float DefaultBrightness { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

DefaultLightColor

Default light color. Used when there is no sunlight placed in the level.

Declaration
public Color DefaultLightColor { get; }
Property Value
Type Description
Color
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static AtmosphericFogComponent DefaultObject { get; }
Property Value
Type Description
AtmosphericFogComponent
| Improve this Doc View Source

DensityMultiplier

Fog density control factor.

Declaration
public float DensityMultiplier { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

DensityOffset

Fog density offset to control opacity [-1.f ~ 1.f].

Declaration
public float DensityOffset { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

DistanceOffset

Distance offset, in km (to handle large distance)

Declaration
public float DistanceOffset { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

DistanceScale

Distance scale.

Declaration
public float DistanceScale { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

FogMultiplier

Scattering factor on object.

Declaration
public float FogMultiplier { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

GroundOffset

Ground offset.

Declaration
public float GroundOffset { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

PrecomputeParams

Precompute Params

Declaration
public AtmospherePrecomputeParameters PrecomputeParams { get; }
Property Value
Type Description
AtmospherePrecomputeParameters
| Improve this Doc View Source

StartDistance

Start Distance.

Declaration
public float StartDistance { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class
| Improve this Doc View Source

SunDiscScale

Distance offset, in km (to handle large distance)

Declaration
public float SunDiscScale { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

SunMultiplier

Global scattering factor.

Declaration
public float SunMultiplier { get; set; }
Property Value
Type Description
System.Single

Methods

| Improve this Doc View Source

DisableGroundScattering(Boolean)

Set DisableGroundScattering

Declaration
public void DisableGroundScattering(bool NewGroundScattering)
Parameters
Type Name Description
System.Boolean NewGroundScattering
| Improve this Doc View Source

DisableSunDisk(Boolean)

Set DisableSunDisk

Declaration
public void DisableSunDisk(bool NewSunDisk)
Parameters
Type Name Description
System.Boolean NewSunDisk
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static AtmosphericFogComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
AtmosphericFogComponent
| Improve this Doc View Source

SetAltitudeScale(Single)

Set AltitudeScale

Declaration
public void SetAltitudeScale(float NewAltitudeScale)
Parameters
Type Name Description
System.Single NewAltitudeScale
| Improve this Doc View Source

SetDefaultBrightness(Single)

Set brightness of the light

Declaration
public void SetDefaultBrightness(float NewBrightness)
Parameters
Type Name Description
System.Single NewBrightness
| Improve this Doc View Source

SetDefaultLightColor(LinearColor)

Set color of the light

Declaration
public void SetDefaultLightColor(LinearColor NewLightColor)
Parameters
Type Name Description
LinearColor NewLightColor
| Improve this Doc View Source

SetDensityMultiplier(Single)

Set DensityMultiplier

Declaration
public void SetDensityMultiplier(float NewDensityMultiplier)
Parameters
Type Name Description
System.Single NewDensityMultiplier
| Improve this Doc View Source

SetDensityOffset(Single)

Set DensityOffset

Declaration
public void SetDensityOffset(float NewDensityOffset)
Parameters
Type Name Description
System.Single NewDensityOffset
| Improve this Doc View Source

SetDistanceOffset(Single)

Set DistanceOffset

Declaration
public void SetDistanceOffset(float NewDistanceOffset)
Parameters
Type Name Description
System.Single NewDistanceOffset
| Improve this Doc View Source

SetDistanceScale(Single)

Set DistanceScale

Declaration
public void SetDistanceScale(float NewDistanceScale)
Parameters
Type Name Description
System.Single NewDistanceScale
| Improve this Doc View Source

SetFogMultiplier(Single)

Set FogMultiplier

Declaration
public void SetFogMultiplier(float NewFogMultiplier)
Parameters
Type Name Description
System.Single NewFogMultiplier
| Improve this Doc View Source

SetPrecomputeParams(Single, Int32, Int32)

Set PrecomputeParams, only valid in Editor mode

Declaration
public void SetPrecomputeParams(float DensityHeight, int MaxScatteringOrder, int InscatterAltitudeSampleNum)
Parameters
Type Name Description
System.Single DensityHeight
System.Int32 MaxScatteringOrder
System.Int32 InscatterAltitudeSampleNum
| Improve this Doc View Source

SetStartDistance(Single)

Set StartDistance

Declaration
public void SetStartDistance(float NewStartDistance)
Parameters
Type Name Description
System.Single NewStartDistance
| Improve this Doc View Source

SetSunMultiplier(Single)

Set SunMultiplier

Declaration
public void SetSunMultiplier(float NewSunMultiplier)
Parameters
Type Name Description
System.Single NewSunMultiplier
| Improve this Doc View Source

StartPrecompute()

Start Precompute

Declaration
public void StartPrecompute()

Operators

| Improve this Doc View Source

Implicit(IntPtr to AtmosphericFogComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator AtmosphericFogComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
AtmosphericFogComponent