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 > API/Runtime/Engine/Components

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

  Type Name Description
Public variable float AerialPespectiveMieScatteringFadeDistance Specify the distance over which the Rayleigh scattering will linearly ramp up to ful leffect.
Public variable float AerialPespectiveMieScatteringStartDistance Specify the aerial perspective start distance on cloud for Mie scattering only. (kilometers)
Public variable float AerialPespectiveRayleighScatteringFadeDistance Specify the distance over which the Rayleigh scattering will linearly ramp up to ful leffect.
Public variable float AerialPespectiveRayleighScatteringStartDistance Specify the aerial perspective start distance on cloud for Rayleigh scattering only. (kilometers)
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< UMaterialInterface > 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 ReflectionViewSampleCountScaleValue Scale the tracing sample count in reflection views.
Public variable float ShadowReflectionViewSampleCountScaleValue 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 EVolumetricCloudTracingMaxDistanceMode TracingMaxDistanceMode Mode to select how the tracing max distance should be interpreted.
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

  Type Name Description
Public function  

UVolumetricCloudComponent ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function void

SetGroundAlbedo ( FColor NewValue
)

  
Public function void

SetLayerBottomAltitude ( float NewValue
)

  
Public function void

SetLayerHeight ( float NewValue
)

  
Public function void  
Public function void

SetPlanetRadius ( float NewValue
)

  
Public function void  
Public function void  
Public function void

SetShadowTracingDistance ( float NewValue
)

  
Public function void

SetShadowViewSampleCountScale ( float NewValue
)

  
Public function void

SetSkyLightCloudBottomOcclusion ( float NewValue
)

  
Public function void  
Public function void

SetTracingMaxDistance ( float NewValue
)

  
Public function void

SetTracingStartMaxDistance ( float NewValue
)

  
Public function 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 float ReflectionSampleCountScale_DEPRECATED  
Public variable float ReflectionViewSampleCountScale_DEPRECATED  
Public variable float ShadowReflectionSampleCountScale_DEPRECATED  
Public variable float ShadowReflectionViewSampleCountScale_DEPRECATED  

Deprecated Functions

  Type Name Description
Public function void

SetReflectionSampleCountScale ( float NewValue
)

 This function has been replaced by SetReflectionViewSampleCountScale.
Public function void This function has been replaced by SetShadowReflectionViewSampleCountScale.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page