1. Epic GamesDeveloper
  3. UVolumetricCloudComponent

UVolumetricCloudComponent

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

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

Inheritance Hierarchy

References

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

Syntax

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

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float AerialPespectiveMieScatteringFadeDistance Specify the distance over which the Rayleigh scattering will linearly ramp up to full effect.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float AerialPespectiveMieScatteringStartDistance Specify the aerial perspective start distance on cloud for Mie scattering only. (kilometers)
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float AerialPespectiveRayleighScatteringFadeDistance Specify the distance over which the Rayleigh scattering will linearly ramp up to full effect.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float AerialPespectiveRayleighScatteringStartDistance Specify the aerial perspective start distance on cloud for Rayleigh scattering only. (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.
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 BlueprintReadOnly uint32: 1 bUsePerSampleAtmosphericLightTransmittance Whether to apply atmosphere transmittance per sample, instead of using the light global transmittance.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly FColor GroundAlbedo The ground albedo used to light the cloud from below with respect to the sun light and sky atmosphere.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float LayerBottomAltitude The altitude at which the cloud layer starts. (kilometers above the ground)
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float LayerHeight The height of the the cloud layer. (kilometers above the layer bottom altitude)
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UMaterialInterface > Material The material describing the cloud volume. It must be a Volume domain material.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float PlanetRadius The planet radius used when there is not SkyAtmosphere component present in the scene.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float ReflectionViewSampleCountScaleValue Scale the tracing sample count in reflection views.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float ShadowReflectionViewSampleCountScaleValue Scale the shadow tracing sample count in reflection views, only used with Advanced Output ray marched shadows.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float ShadowTracingDistance The shadow tracing distance in kilometers, only used with Advanced Output ray marched shadows.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float ShadowViewSampleCountScale Scale the shadow tracing sample count in primary views, only used with Advanced Output ray marched shadows.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float SkyLightCloudBottomOcclusion BUsePerSampleAtmosphericLightTransmittance is there on the cloud component and not on the light because otherwise we would need optimization permutations of the cloud shader.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float StopTracingTransmittanceThreshold When the mean transmittance is below this threshold, we stop tracing.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float TracingMaxDistance The maximum distance that will be traced inside the cloud layer. (kilometers)
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadOnly EVolumetricCloudTracingMaxDistanceMode TracingMaxDistanceMode Mode to select how the tracing max distance should be interpreted.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float TracingStartDistanceFromCamera The distance from which the tracing will start.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float TracingStartMaxDistance The maximum distance of the volumetric surface, i.e. cloud layer upper and lower bound, before which we will accept to start tracing.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float ViewSampleCountScale Scale the tracing sample count in primary views.

Constructors

  Type Name Description
Public function  

UVolumetricCloudComponent ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function    

Functions

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

SetGroundAlbedo ( FColor NewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetHoldout ( bool bNewHoldout
)

  
Public function UFunction BlueprintCallable, Category void

SetLayerBottomAltitude ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetLayerHeight ( float NewValue
)

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

SetPlanetRadius ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetReflectionSampleCountScale ( float NewValue
)

 Deprecated functions but still valid because they forward data correctly.
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetRenderInMainPass ( bool bValue
)

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

SetShadowTracingDistance ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetShadowViewSampleCountScale ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetSkyLightCloudBottomOcclusion ( float NewValue
)

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

SetTracingMaxDistance ( float NewValue
)

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

SetTracingStartMaxDistance ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetViewSampleCountScale ( float NewValue
)

  

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

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.

Constants

Name Description
BaseShadowRaySampleCount  
BaseViewRaySampleCount Those values should never be changed wihtout data conversion, that in order to maintain performance in case default values are used.
OldToNewReflectionShadowRaySampleCount  
OldToNewReflectionViewRaySampleCount Those values are part of a data conversion and should never be changed. CVars and component sample count controls should be enough.

Deprecated Variables

  Type Name Description
Public variable UProperty float ReflectionSampleCountScale_DEPRECATED  
Public variable UProperty float ReflectionViewSampleCountScale_DEPRECATED  
Public variable UProperty float ShadowReflectionSampleCountScale_DEPRECATED  
Public variable UProperty float ShadowReflectionViewSampleCountScale_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page