UVolumetricCloudComponent

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Components/VolumetricCloudComponent.h

Include

#include "Components/VolumetricCloudComponent.h"

Syntax

class UVolumetricCloudComponent : public USceneComponent

Remarks

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

Variables

Name Description

Public variable

uint32: 1

 

bUsePerSampleAtmosphericLightTransmittance

Whether to apply atmosphere transmittance per sample, instead of using the light global transmittance.

Public variable

FColor

 

GroundAlbedo

The ground albedo used to light the cloud from below with respect to the sun light and sky atmosphere.

Public variable

float

 

LayerBottomAltitude

The altitude at which the cloud layer starts. (kilometers above the ground)

Public variable

float

 

LayerHeight

The height of the the cloud layer. (kilometers above the layer bottom altitude)

Public variable

TObjectPtr< UMa...

 

Material

The material describing the cloud volume. It must be a Volume domain material.

Public variable

float

 

PlanetRadius

The planet radius used when there is not SkyAtmosphere component present in the scene.

Public variable

float

 

ReflectionViewSampleCountScale

Scale the tracing sample count in reflection views.

Public variable

float

 

ShadowReflectionViewSampleCountScale

Scale the shadow tracing sample count in reflection views, only used with Advanced Output ray marched shadows.

Public variable

float

 

ShadowTracingDistance

The shadow tracing distance in kilometers, only used with Advanced Output ray marched shadows.

Public variable

float

 

ShadowViewSampleCountScale

Scale the shadow tracing sample count in primary views, only used with Advanced Output ray marched shadows.

Public variable

float

 

SkyLightCloudBottomOcclusion

BUsePerSampleAtmosphericLightTransmittance is there on the cloud component and not on the light because otherwise we would need optimisation permutations of the cloud shader.

Public variable

float

 

StopTracingTransmittanceThreshold

When the mean transmittance is below this threshold, we stop tracing.

Public variable

float

 

TracingMaxDistance

The maximum distance that will be traced inside the cloud layer. (kilometers)

Public variable

float

 

TracingStartMaxDistance

The maximum distance of the volumetric surface before which we will accept to start tracing.

Public variable

float

 

ViewSampleCountScale

Scale the tracing sample count in primary views.

Constructors

Name Description

Public function

UVolumetricCloudComponent

(
    const FObjectInitializer& ObjectIn...
)

Destructors

Name Description

Public function

~UVolumetricCloudComponent()

Functions

Name Description

Public function

void

 

SetbUsePerSampleAtmosphericLightTransmittance

(
    bool NewValue
)

Public function

void

 

SetGroundAlbedo

(
    FColor NewValue
)

Public function

void

 

SetLayerBottomAltitude

(
    float NewValue
)

Public function

void

 

SetLayerHeight

(
    float NewValue
)

Public function

void

 

SetMaterial

(
    UMaterialInterface* NewValue
)

Public function

void

 

SetPlanetRadius

(
    float NewValue
)

Public function

void

 

SetReflectionViewSampleCountScale

(
    float NewValue
)

Public function

void

 

SetShadowReflectionViewSampleCountScale

(
    float NewValue
)

Public function

void

 

SetShadowTracingDistance

(
    float NewValue
)

Public function

void

 

SetShadowViewSampleCountScale

(
    float NewValue
)

Public function

void

 

SetSkyLightCloudBottomOcclusion

(
    float NewValue
)

Public function

void

 

SetStopTracingTransmittanceThreshold

(
    float NewValue
)

Public function

void

 

SetTracingMaxDistance

(
    float NewValue
)

Public function

void

 

SetTracingStartMaxDistance

(
    float NewValue
)

Public function

void

 

SetViewSampleCountScale

(
    float NewValue
)

Overridden from UActorComponent

Name Description

Public function 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.

Protected function Virtual

void

 

CreateRenderState_Concurrent

(
    FRegisterComponentContext* Con...
)

Used to create any rendering thread information for this component

Protected function Virtual

void

 

DestroyRenderState_Concurrent()

Used to shut down any rendering thread structure for this component

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInterpChange

(
    FProperty* PropertyThatChanged
)

This is called when property is modified by InterpPropertyTracks

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

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

Name Description

Public variable

float

 

ReflectionSampleCountScale_DEPRECATED

Public variable

float

 

ShadowReflectionSampleCountScale_DEPRECATED

Deprecated Functions

Name Description

Public function

void

 

SetReflectionSampleCountScale

(
    float NewValue
)

This function has been replaced by SetReflectionViewSampleCountScale.

Public function

void

 

SetShadowReflectionSampleCountScale

(
    float NewValue
)

This function has been replaced by SetShadowReflectionViewSampleCountScale.