1. Epic GamesDeveloper
  3. USkyAtmosphereComponent

USkyAtmosphereComponent

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

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

Inheritance Hierarchy

References

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

Syntax

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

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float AerialPerspectiveStartDepth The distance (kilometers) at which we start evaluating the aerial perspective.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float AerialPespectiveViewDistanceScale Makes the aerial perspective look thicker by scaling distances from view to surfaces (opaque and translucent).
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float AtmosphereHeight The height of the atmosphere layer above the ground in kilometers.
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.
Protected variable bool bIsAtmosphericFog When true, this means that this SkyAtmosphere is use as replacement for the deprecated AtmosphericFogComponent as a parent class.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float BottomRadius The radius in kilometers from the center of the planet to the ground level.
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, EditAnywhere, Interp, Meta BlueprintReadOnly FColor GroundAlbedo The ground albedo that will tint the atmosphere when the sun light will bounce on it.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float HeightFogContribution Scale the sky and atmosphere lights contribution to the height fog when SupportSkyAtmosphereAffectsHeightFog project setting is true.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly FLinearColor MieAbsorption The Mie absorption coefficients resulting from particles in the air at an altitude of 0 kilometer.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float MieAbsorptionScale Mie absorption coefficient scale.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float MieAnisotropy A value of 0 mean light is uniformly scattered.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float MieExponentialDistribution The altitude in kilometer at which Mie effects are reduced to 40%.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly FLinearColor MieScattering The Mie scattering coefficients resulting from particles in the air at an altitude of 0 kilometer.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float MieScatteringScale Mie scattering coefficient scale.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float MultiScatteringFactor Factor applied to multiple scattering only (after the sun light has bounced around in the atmosphere at least once).
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly FLinearColor OtherAbsorption Absorption coefficients for another atmosphere layer.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float OtherAbsorptionScale Absorption coefficients for another atmosphere layer.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FTentDistribution OtherTentDistribution Represents the altitude based tent distribution of absorption particles in the atmosphere.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float RayleighExponentialDistribution The altitude in kilometer at which Rayleigh scattering effect is reduced to 40%.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly FLinearColor RayleighScattering The Rayleigh scattering coefficients resulting from molecules in the air at an altitude of 0 kilometer.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float RayleighScatteringScale Rayleigh scattering coefficient scale.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly FLinearColor SkyLuminanceFactor Scales the luminance of pixels representing the sky. This will impact the captured sky light.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly float TraceSampleCountScale Scale the atmosphere tracing sample count.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly ESkyAtmosphereTransformMode TransformMode The ground albedo that will tint the atmosphere when the sun light will bounce on it.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float TransmittanceMinLightElevationAngle The minimum elevation angle in degree that should be used to evaluate the sun transmittance to the ground.

Constructors

  Type Name Description
Public function  

USkyAtmosphereComponent ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category, Meta FLinearColor  
Public function Const void

GetOverrideLightStatus ( bool* OverrideAtmosphericLight,
FVector* OverrideAtmosphericLightDirection
)

  
Public function UFunction BlueprintCallable, Category FVector

GetOverridenAtmosphereLightDirection ( int32 AtmosphereLightIndex
)

  
Public function Const FGuid  
Public function UFunction BlueprintCallable, Category bool

IsAtmosphereLightDirectionOverriden ( int32 AtmosphereLightIndex
)

  
Public function UFunction BlueprintCallable, Category void

OverrideAtmosphereLightDirection ( int32 AtmosphereLightIndex,
const FVector& LightDirection
)

  
Public function UFunction BlueprintCallable, Category void

ResetAtmosphereLightDirectionOverride ( int32 AtmosphereLightIndex
)

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

SetAtmosphereHeight ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetBottomRadius ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetGroundAlbedo ( const FColor& NewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetHeightFogContribution ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetHoldout ( bool bNewHoldout
)

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

SetMieAbsorptionScale ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetMieAnisotropy ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetMieExponentialDistribution ( float NewValue
)

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

SetMieScatteringScale ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetMultiScatteringFactor ( float NewValue
)

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

SetOtherAbsorptionScale ( float NewValue
)

  
Public function void This is used to position the SkyAtmosphere similarly to the deprecated AtmosphericFog component.
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetRayleighScatteringScale ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetRenderInMainPass ( bool bValue
)

  
Public function UFunction BlueprintCallable, Category void  

Overridden from UActorComponent

  Type Name Description
Public function Virtual void 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.
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 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.

See Also

https://docs.unrealengine.com/en-US/Engine/Actors/FogEffects/SkyAtmosphere/index.html

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page