1. Epic GamesDeveloper
  3. USkyAtmosphereComponent

USkyAtmosphereComponent

A component that represents a planet atmosphere material and simulates sky and light scattering within it.

API > API/Runtime > API/Runtime/Engine

A component that represents a planet atmosphere material and simulates sky and light scattering within it.

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

Syntax

UCLASS (ClassGroup=Rendering, CollapseCategories,  
       HideCategories=(Object, Mobility, Activation, "Components|Activation"), EditInlineNew,  
       Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class USkyAtmosphereComponent : public USceneComponent

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

USkyAtmosphereComponent ( const FObjectInitializer& ObjectInitializer
)

   Components/SkyAtmosphereComponent.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~USkyAtmosphereComponent()

   Components/SkyAtmosphereComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AerialPerspectiveStartDepth float The distance (kilometers) at which we start evaluating the aerial perspective. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Art Direction"
  • Meta=(UIMin=0.001f, UIMax=10.0f, ClampMin=0.001f)
AerialPespectiveViewDistanceScale float Makes the aerial perspective look thicker by scaling distances from view to surfaces (opaque and translucent). Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Art Direction"
  • Meta=(DisplayName="Aerial Perspective View Distance Scale", UIMin=0.0, UIMax=3.0, ClampMin=0.0, SliderExponent=2.0)
AtmosphereHeight float The height of the atmosphere layer above the ground in kilometers. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Atmosphere"
  • Meta=(UIMin=1.0, UIMax=200.0, ClampMin=0.1, SliderExponent=2.0)
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/SkyAtmosphereComponent.h
  • EditAnywhere
  • AdvancedDisplay
  • BlueprintReadOnly
  • Category=Rendering
  • Interp
BottomRadius float The radius in kilometers from the center of the planet to the ground level. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Planet"
  • Meta=(DisplayName="Ground Radius", UIMin=1.0, UIMax=7000.0, ClampMin=0.1, ClampMax=10000.0, SliderExponent=5.0)
bRenderInMainPass uint8 If true, this component will be rendered in the main pass (basepass, transparency) Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • AdvancedDisplay
  • BlueprintReadOnly
  • Category=Rendering
GroundAlbedo FColor The ground albedo that will tint the atmosphere when the sun light will bounce on it. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Planet"
  • Meta=(HideAlphaChannel)
HeightFogContribution float Scale the sky and atmosphere lights contribution to the height fog when SupportSkyAtmosphereAffectsHeightFog project setting is true. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Art Direction"
  • Meta=(UIMin=0.0, UIMax=1.0, ClampMin=0.0, SliderExponent=2.0)
MieAbsorption FLinearColor The Mie absorption coefficients resulting from particles in the air at an altitude of 0 kilometer. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Atmosphere - Mie"
  • Meta=(HideAlphaChannel)
MieAbsorptionScale float Mie absorption coefficient scale. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Atmosphere - Mie"
  • Meta=(UIMin=0.0, UIMax=5.0, ClampMin=0.0, SliderExponent=4.0)
MieAnisotropy float A value of 0 mean light is uniformly scattered. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Atmosphere - Mie"
  • Meta=(UIMin=0.0, UIMax=0.999, ClampMin=0.0, ClampMax=0.999)
MieExponentialDistribution float The altitude in kilometer at which Mie effects are reduced to 40%. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Atmosphere - Mie"
  • Meta=(UIMin=0.01, UIMax=10.0, ClampMin=0.001, SliderExponent=5.0)
MieScattering FLinearColor The Mie scattering coefficients resulting from particles in the air at an altitude of 0 kilometer. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Atmosphere - Mie"
  • Meta=(HideAlphaChannel)
MieScatteringScale float Mie scattering coefficient scale. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Atmosphere - Mie"
  • Meta=(UIMin=0.0, UIMax=5.0, ClampMin=0.0, SliderExponent=4.0)
MultiScatteringFactor float Factor applied to multiple scattering only (after the sun light has bounced around in the atmosphere at least once). Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Atmosphere"
  • Meta=(DisplayName="MultiScattering", UIMin=0.0, UIMax=2.0, ClampMin=0.0, ClampMax=100.0)
OtherAbsorption FLinearColor Absorption coefficients for another atmosphere layer. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Atmosphere - Absorption"
  • Meta=(DisplayName="Absorption", HideAlphaChannel)
OtherAbsorptionScale float Absorption coefficients for another atmosphere layer. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Atmosphere - Absorption"
  • Meta=(DisplayName="Absorption Scale", UIMin=0.0, UIMax=0.2, ClampMin=0.0, SliderExponent=3.0)
OtherTentDistribution FTentDistribution Represents the altitude based tent distribution of absorption particles in the atmosphere. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Atmosphere - Absorption"
  • Meta=(DisplayName="Tent Distribution")
RayleighExponentialDistribution float The altitude in kilometer at which Rayleigh scattering effect is reduced to 40%. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Atmosphere - Rayleigh"
  • Meta=(UIMin=0.01, UIMax=20.0, ClampMin=0.001, SliderExponent=5.0)
RayleighScattering FLinearColor The Rayleigh scattering coefficients resulting from molecules in the air at an altitude of 0 kilometer. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Atmosphere - Rayleigh"
  • Meta=(HideAlphaChannel)
RayleighScatteringScale float Rayleigh scattering coefficient scale. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Atmosphere - Rayleigh"
  • Meta=(UIMin=0.0, UIMax=2.0, ClampMin=0.0, SliderExponent=4.0)
SkyAndAerialPerspectiveLuminanceFactor FLinearColor Scales the luminance of pixels representing the sky and the aerial perspective. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Art Direction"
  • Meta=(HideAlphaChannel)
SkyLuminanceFactor FLinearColor Scales the luminance of pixels representing the sky. This will impact the captured sky light. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Art Direction"
  • Meta=(HideAlphaChannel)
TraceSampleCountScale float Scale the atmosphere tracing sample count. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Atmosphere"
  • AdvancedDisplay
  • Meta=(UIMin="0.25", UIMax="8", ClampMin="0.25", SliderExponent=3.0)
TransformMode ESkyAtmosphereTransformMode The ground albedo that will tint the atmosphere when the sun light will bounce on it. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Planet"
  • Meta=(HideAlphaChannel)
TransmittanceMinLightElevationAngle float The minimum elevation angle in degree that should be used to evaluate the sun transmittance to the ground. Components/SkyAtmosphereComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Art Direction"
  • Meta=(UIMin=90.0, UIMax=90.0, ClampMin=90.0f, ClampMax=90.0f)

Protected

Name Type Remarks Include Path Unreal Specifiers
bStaticLightingBuiltGUID FGuid GUID used to associate a atmospheric component with precomputed lighting/shadowing information across levels. Components/SkyAtmosphereComponent.h  
OverrideAtmosphericLight bool   Components/SkyAtmosphereComponent.h  
OverrideAtmosphericLightDirection FVector   Components/SkyAtmosphereComponent.h  
SkyAtmosphereSceneProxy FSkyAtmosphereSceneProxy *   Components/SkyAtmosphereComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FLinearColor GetAtmosphereTransmitanceOnGroundAtPlanetTop ( UDirectionalLightComponent* DirectionalLight
)

   Components/SkyAtmosphereComponent.h
  • BlueprintCallable
  • Category="Utilities"
  • Meta=(DisplayName="Get Atmosphere Transmitance On Ground At Planet Top")

float GetAtmosphericLightToMatchIlluminanceOnGround ( FVector LightDirection,
float IlluminanceOnGround
)

 This function can be used for instance in order to evaluate a directional atmospheric light outer space illuminance for a desired illuminance on ground given a direction. Components/SkyAtmosphereComponent.h
  • BlueprintCallable
  • Category="Utilities"
  • Meta=(DisplayName="Get Atmospheric Light To Match Illuminance On Ground")

void GetOverrideLightStatus ( bool* OverrideAtmosphericLight,
FVector* OverrideAtmosphericLightDirection
) const

   Components/SkyAtmosphereComponent.h  

FVector GetOverridenAtmosphereLightDirection ( int32 AtmosphereLightIndex
)

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

FGuid GetStaticLightingBuiltGuid()

   Components/SkyAtmosphereComponent.h  

bool IsAtmosphereLightDirectionOverriden ( int32 AtmosphereLightIndex
)

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

void OverrideAtmosphereLightDirection ( int32 AtmosphereLightIndex,
const FVector& LightDirection
)

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

void ResetAtmosphereLightDirectionOverride ( int32 AtmosphereLightIndex
)

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

void SetAerialPerspectiveStartDepth ( float NewValue
)

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

void SetAerialPespectiveViewDistanceScale ( float NewValue
)

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

void SetAtmosphereHeight ( float NewValue
)

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

void SetBottomRadius ( float NewValue
)

   Components/SkyAtmosphereComponent.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(DisplayName="Set Ground Radius")

void SetGroundAlbedo ( const FColor& NewValue
)

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

void SetHeightFogContribution ( float NewValue
)

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

void SetHoldout ( bool bNewHoldout
)

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

void SetMieAbsorption ( FLinearColor NewValue
)

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

void SetMieAbsorptionScale ( float NewValue
)

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

void SetMieAnisotropy ( float NewValue
)

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

void SetMieExponentialDistribution ( float NewValue
)

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

void SetMieScattering ( FLinearColor NewValue
)

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

void SetMieScatteringScale ( float NewValue
)

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

void SetMultiScatteringFactor ( float NewValue
)

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

void SetOtherAbsorption ( FLinearColor NewValue
)

   Components/SkyAtmosphereComponent.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(DisplayName="Set Absorption")

void SetOtherAbsorptionScale ( float NewValue
)

   Components/SkyAtmosphereComponent.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(DisplayName="Set Absorption Scale")

void SetPositionToMatchDeprecatedAtmosphericFog()

 This is used to position the SkyAtmosphere similarly to the deprecated AtmosphericFog component. Components/SkyAtmosphereComponent.h  

void SetRayleighExponentialDistribution ( float NewValue
)

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

void SetRayleighScattering ( FLinearColor NewValue
)

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

void SetRayleighScatteringScale ( float NewValue
)

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

void SetRenderInMainPass ( bool bValue
)

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

void SetSkyAndAerialPerspectiveLuminanceFactor ( FLinearColor NewValue
)

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

void SetSkyLuminanceFactor ( FLinearColor NewValue
)

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

void SetTransmittanceMinLightElevationAngle ( float NewValue
)

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

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void CheckForErrors ()

 Function that gets called from within Map_Check to allow this actor component to check itself for any potential errors and register them with map check dialog. Components/SkyAtmosphereComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/SkyAtmosphereComponent.h  

virtual void Serialize ( FArchive& Ar
)

   Components/SkyAtmosphereComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

void SetDummyStaticLightingGUIDs()

 Sets a dummy, known static lighting GUID to avoid cook non-determinism when a map contains the deprecated AtmosphericFogComponent. Components/SkyAtmosphereComponent.h  

Overridden from UActorComponent

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

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page