1. Epic GamesDeveloper
  3. UVolumetricCloudComponent

UVolumetricCloudComponent

A component that represents a participating media material around a planet, e.g. clouds.

API > API/Runtime > API/Runtime/Engine

A component that represents a participating media material around a planet, e.g. clouds.

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

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UVolumetricCloudComponent ( const FObjectInitializer& ObjectInitializer
)

   Components/VolumetricCloudComponent.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~UVolumetricCloudComponent()

   Components/VolumetricCloudComponent.h  

Constants

Name Type Remarks Include Path
BaseShadowRaySampleCount float   Components/VolumetricCloudComponent.h
BaseViewRaySampleCount float Those values should never be changed wihtout data conversion, that in order to maintain performance in case default values are used. Components/VolumetricCloudComponent.h
OldToNewReflectionShadowRaySampleCount float   Components/VolumetricCloudComponent.h
OldToNewReflectionViewRaySampleCount float Those values are part of a data conversion and should never be changed. CVars and component sample count controls should be enough. Components/VolumetricCloudComponent.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AerialPespectiveMieScatteringFadeDistance float Specify the distance over which the Rayleigh scattering will linearly ramp up to full effect. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Art Direction"
  • Meta=(UIMin=0.0, UIMax=100.0, ClampMin=0.0, SliderExponent=2.0)
AerialPespectiveMieScatteringStartDistance float Specify the aerial perspective start distance on cloud for Mie scattering only. (kilometers) Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Art Direction"
  • Meta=(UIMin=0.0, UIMax=100.0, ClampMin=0.0, SliderExponent=2.0)
AerialPespectiveRayleighScatteringFadeDistance float Specify the distance over which the Rayleigh scattering will linearly ramp up to full effect. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Art Direction"
  • Meta=(UIMin=0.0, UIMax=100.0, ClampMin=0.0, SliderExponent=2.0)
AerialPespectiveRayleighScatteringStartDistance float Specify the aerial perspective start distance on cloud for Rayleigh scattering only. (kilometers) Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Art Direction"
  • Meta=(UIMin=0.0, UIMax=100.0, ClampMin=0.0, 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/VolumetricCloudComponent.h
  • EditAnywhere
  • AdvancedDisplay
  • BlueprintReadOnly
  • Category=Rendering
  • Interp
bRenderInMainPass uint8 If true, this component will be rendered in the main pass (basepass, transparency) Components/VolumetricCloudComponent.h
  • EditAnywhere
  • AdvancedDisplay
  • BlueprintReadOnly
  • Category=Rendering
bUsePerSampleAtmosphericLightTransmittance uint32 Whether to apply atmosphere transmittance per sample, instead of using the light global transmittance. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Cloud Tracing"
bVisibleInRealTimeSkyCaptures uint8 If true, this component will be visible in real-time sky light reflection captures. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • AdvancedDisplay
  • BlueprintReadOnly
  • Category=Rendering
GroundAlbedo FColor The ground albedo used to light the cloud from below with respect to the sun light and sky atmosphere. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Planet"
  • Meta=(HideAlphaChannel)
LayerBottomAltitude float The altitude at which the cloud layer starts. (kilometers above the ground) Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Layer"
  • Meta=(UIMin=0.0f, UIMax=20.0f, SliderExponent=2.0)
LayerHeight float The height of the the cloud layer. (kilometers above the layer bottom altitude) Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Layer"
  • Meta=(UIMin=0.1f, UIMax=20.0f, ClampMin=0.1, SliderExponent=2.0)
Material TSoftObjectPtr< UMaterialInterface > The material describing the cloud volume. It must be a Volume domain material. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Cloud Material"
PlanetRadius float The planet radius used when there is not SkyAtmosphere component present in the scene. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Planet"
  • Meta=(UIMin=100.0f, UIMax=7000.0f, ClampMin=0.1, ClampMax=10000.0f)
ReflectionViewSampleCountScaleValue float Scale the tracing sample count in reflection views. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Cloud Tracing"
  • Meta=(UIMin="0.05", UIMax="8", ClampMin="0.05", SliderExponent=1.0)
ShadowReflectionViewSampleCountScaleValue float Scale the shadow tracing sample count in reflection views, only used with Advanced Output ray marched shadows. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Cloud Tracing"
  • Meta=(UIMin="0.05", UIMax="8", ClampMin="0.05", SliderExponent=1.0)
ShadowTracingDistance float The shadow tracing distance in kilometers, only used with Advanced Output ray marched shadows. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Cloud Tracing"
  • Meta=(UIMin="0.1", UIMax="50", ClampMin="0.01", SliderExponent=3.0)
ShadowViewSampleCountScale float Scale the shadow tracing sample count in primary views, only used with Advanced Output ray marched shadows. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Cloud Tracing"
  • Meta=(UIMin="0.05", UIMax="8", ClampMin="0.05", SliderExponent=1.0)
SkyLightCloudBottomOcclusion float BUsePerSampleAtmosphericLightTransmittance is there on the cloud component and not on the light because otherwise we would need optimization permutations of the cloud shader. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Cloud Tracing"
  • Meta=(UIMin=0.0f, UIMax=1.0f, ClampMin=0.0f, ClampMax=1.0f)
StopTracingTransmittanceThreshold float When the mean transmittance is below this threshold, we stop tracing. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Cloud Tracing"
  • Meta=(UIMin="0.0", UIMax="1.0", ClampMin="0.0", ClampMax="1.0", SliderExponent=5.0)
TracingMaxDistance float The maximum distance that will be traced inside the cloud layer. (kilometers) Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Layer"
  • Meta=(UIMin=1.0f, UIMax=500.0f, ClampMin=0.1f, SliderExponent=2.0)
TracingMaxDistanceMode EVolumetricCloudTracingMaxDistanceMode Mode to select how the tracing max distance should be interpreted. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Layer"
TracingStartDistanceFromCamera float The distance from which the tracing will start. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Layer"
  • Meta=(UIMin=0.0f, UIMax=100.0f, ClampMin=0.0f, SliderExponent=3.0)
TracingStartMaxDistance float The maximum distance of the volumetric surface, i.e. cloud layer upper and lower bound, before which we will accept to start tracing. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Interp
  • Category="Layer"
  • Meta=(UIMin=100.0f, UIMax=500.0f, ClampMin=1.0f, SliderExponent=2.0)
ViewSampleCountScale float Scale the tracing sample count in primary views. Components/VolumetricCloudComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Cloud Tracing"
  • Meta=(UIMin="0.05", UIMax="8", ClampMin="0.05", SliderExponent=1.0)

Protected

Name Type Remarks Include Path Unreal Specifiers
MaterialLifetimePtr TObjectPtr< UMaterialInterface > The material is assigned to a regular pointer so that the garbage collector to not get ride of it. Components/VolumetricCloudComponent.h  
VolumetricCloudSceneProxy FVolumetricCloudSceneProxy *   Components/VolumetricCloudComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UMaterialInterface * GetMaterial()

   Components/VolumetricCloudComponent.h  

void SetbUsePerSampleAtmosphericLightTransmittance ( bool NewValue
)

   Components/VolumetricCloudComponent.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(DisplayName="Set Use Per Sample Atmospheric Light Transmittance")

void SetGroundAlbedo ( FColor NewValue
)

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

void SetHoldout ( bool bNewHoldout
)

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

void SetLayerBottomAltitude ( float NewValue
)

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

void SetLayerHeight ( float NewValue
)

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

void SetMaterial ( UMaterialInterface* NewValue
)

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

void SetPlanetRadius ( float NewValue
)

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

void SetReflectionSampleCountScale ( float NewValue
)

 Deprecated functions but still valid because they forward data correctly. Components/VolumetricCloudComponent.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been replaced by SetReflectionViewSampleCountScale.")

void SetReflectionViewSampleCountScale ( float NewValue
)

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

void SetRenderInMainPass ( bool bValue
)

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

void SetShadowReflectionSampleCountScale ( float NewValue
)

   Components/VolumetricCloudComponent.h
  • BlueprintCallable
  • Category="Rendering"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been replaced by SetShadowReflectionViewSampleCountScale.")

void SetShadowReflectionViewSampleCountScale ( float NewValue
)

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

void SetShadowTracingDistance ( float NewValue
)

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

void SetShadowViewSampleCountScale ( float NewValue
)

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

void SetSkyLightCloudBottomOcclusion ( float NewValue
)

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

void SetStopTracingTransmittanceThreshold ( float NewValue
)

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

void SetTracingMaxDistance ( float NewValue
)

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

void SetTracingStartDistanceFromCamera ( float NewValue
)

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

void SetTracingStartMaxDistance ( float NewValue
)

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

void SetViewSampleCountScale ( float NewValue
)

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

void SetVisibleInRealTimeSkyCaptures ( bool bValue
)

   Components/VolumetricCloudComponent.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/VolumetricCloudComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void OnCookEvent ( UE::Cook::ECookEvent CookEvent,
UE::Cook::FCookEventContext& CookContext
)

   Components/VolumetricCloudComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/VolumetricCloudComponent.h  

virtual void PostLoad()

   Components/VolumetricCloudComponent.h  

virtual void Serialize ( FArchive& Ar
)

   Components/VolumetricCloudComponent.h  

Protected

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers
Used to create any rendering thread information for this component Components/VolumetricCloudComponent.h  
Used to shut down any rendering thread structure for this component Components/VolumetricCloudComponent.h  

virtual void OnRegister()

 Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. Components/VolumetricCloudComponent.h  

virtual void PrecachePSOs()

 Precache all PSOs which can be used by the actor component Components/VolumetricCloudComponent.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
ReflectionSampleCountScale_DEPRECATED float   Components/VolumetricCloudComponent.h  
ReflectionViewSampleCountScale_DEPRECATED float   Components/VolumetricCloudComponent.h  
ShadowReflectionSampleCountScale_DEPRECATED float   Components/VolumetricCloudComponent.h  
ShadowReflectionViewSampleCountScale_DEPRECATED float   Components/VolumetricCloudComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page