unreal.VolumetricCloudComponent

class unreal.VolumetricCloudComponent(outer: Object | None = None, name: Name | str = 'None')

Bases: SceneComponent

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

C++ Source:

  • Module: Engine

  • File: VolumetricCloudComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • absolute_location (bool): [Read-Write] If RelativeLocation should be considered relative to the world, rather than the parent

  • absolute_rotation (bool): [Read-Write] If RelativeRotation should be considered relative to the world, rather than the parent

  • absolute_scale (bool): [Read-Write] If RelativeScale3D should be considered relative to the world, rather than the parent

  • aerial_pespective_mie_scattering_fade_distance (float): [Read-Write] Specify the distance over which the Rayleigh scattering will linearly ramp up to full effect. (kilometers)

  • aerial_pespective_mie_scattering_start_distance (float): [Read-Write] Specify the aerial perspective start distance on cloud for Mie scattering only. (kilometers)

  • aerial_pespective_rayleigh_scattering_fade_distance (float): [Read-Write] Specify the distance over which the Rayleigh scattering will linearly ramp up to full effect. (kilometers)

  • aerial_pespective_rayleigh_scattering_start_distance (float): [Read-Write] Specify the aerial perspective start distance on cloud for Rayleigh scattering only. (kilometers)

  • asset_user_data (Array[AssetUserData]): [Read-Write] Array of user data stored with the component

  • asset_user_data_editor_only (Array[AssetUserData]): [Read-Write] Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.

  • can_ever_affect_navigation (bool): [Read-Write] Whether this component can potentially influence navigation

  • component_tags (Array[Name]): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • detail_mode (DetailMode): [Read-Write] If detail mode is >= system detail mode, primitive won’t be rendered.

  • editable_when_inherited (bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor class

  • ground_albedo (Color): [Read-Write] The ground albedo used to light the cloud from below with respect to the sun light and sky atmosphere. This is only used by the cloud material when the ‘Volumetric Advanced’ node have GroundContribution enabled.

  • hidden_in_game (bool): [Read-Write] Whether to hide the primitive in game, if the primitive is Visible.

  • holdout (bool): [Read-Write] If this is True, this primitive will render black with an alpha of 0, but all secondary effects (shadows, reflections, indirect lighting) remain. This feature required the project setting “Enable alpha channel support in post processing”.

  • is_editor_only (bool): [Read-Write] If true, the component will be excluded from non-editor builds

  • layer_bottom_altitude (float): [Read-Write] The altitude at which the cloud layer starts. (kilometers above the ground)

  • layer_height (float): [Read-Write] The height of the the cloud layer. (kilometers above the layer bottom altitude)

  • material (MaterialInterface): [Read-Write] The material describing the cloud volume. It must be a Volume domain material.

  • mobility (ComponentMobility): [Read-Write] How often this component is allowed to move, used to make various optimizations. Only safe to set in constructor.

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivated

  • physics_volume_changed_delegate (PhysicsVolumeChanged): [Read-Write] Delegate that will be called when PhysicsVolume has been changed *

  • planet_radius (float): [Read-Write] The planet radius used when there is not SkyAtmosphere component present in the scene.

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Main tick function for the Component

  • reflection_view_sample_count_scale_value (float): [Read-Write] Scale the tracing sample count in reflection views. Quality level scalability CVARs affect the maximum range. The sample count resolution is still clamped according to scalability setting to ‘r.VolumetricCloud.ReflectionRaySampleMaxCount’.

  • relative_location (Vector): [Read-Write] Location of the component relative to its parent

  • relative_rotation (Rotator): [Read-Write] Rotation of the component relative to its parent

  • relative_scale3d (Vector): [Read-Write] Non-uniform scaling of the component relative to its parent. Note that scaling is always applied in local space (no shearing etc)

  • render_in_main_pass (bool): [Read-Write] If true, this component will be rendered in the main pass (basepass, transparency)

  • replicate_using_registered_sub_object_list (bool): [Read-Write] When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.

  • replicates (bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

  • shadow_reflection_view_sample_count_scale_value (float): [Read-Write] Scale the shadow tracing sample count in reflection views, only used with Advanced Output ray marched shadows. Quality level scalability CVARs affect the maximum range. The sample count resolution is still clamped according to scalability setting to ‘r.VolumetricCloud.Shadow.ReflectionRaySampleMaxCount’.

  • shadow_tracing_distance (float): [Read-Write] The shadow tracing distance in kilometers, only used with Advanced Output ray marched shadows.

  • shadow_view_sample_count_scale (float): [Read-Write] Scale the shadow tracing sample count in primary views, only used with Advanced Output ray marched shadows. Quality level scalability CVARs affect the maximum range. The sample count resolution is still clamped according to scalability setting to ‘r.VolumetricCloud.Shadow.ViewRaySampleMaxCount’.

  • should_update_physics_volume (bool): [Read-Write] Whether or not the cached PhysicsVolume this component overlaps should be updated when the component is moved. see: GetPhysicsVolume()

  • sky_light_cloud_bottom_occlusion (float): [Read-Write] Occlude the sky light contribution at the bottom of the cloud layer. This is a fast approximation to sky lighting being occluded by cloud without having to trace rays or sample AO texture. Ignored if the cloud material explicitely sets the ambient occlusion value.

  • stop_tracing_transmittance_threshold (float): [Read-Write] When the mean transmittance is below this threshold, we stop tracing. This is a good way to reduce the ray marched sample count, and thus to increase performance.

  • tracing_max_distance (float): [Read-Write] The maximum distance that will be traced inside the cloud layer. (kilometers)

  • tracing_max_distance_mode (VolumetricCloudTracingMaxDistanceMode): [Read-Write] Mode to select how the tracing max distance should be interpreted. DistanceFromPointOfView is useful to avoid the top of the cloud layer to be clipped when TracingMaxDistance is shorten for performance.

  • tracing_start_distance_from_camera (float): [Read-Write] The distance from which the tracing will start. This is useful when the camera for instance is inside the layer of cloud. (kilometers)

  • tracing_start_max_distance (float): [Read-Write] The maximum distance of the volumetric surface, i.e. cloud layer upper and lower bound, before which we will accept to start tracing. (kilometers)

  • use_attach_parent_bound (bool): [Read-Write] If true, this component uses its parents bounds when attached. This can be a significant optimization with many components attached together.

  • use_per_sample_atmospheric_light_transmittance (bool): [Read-Write] Whether to apply atmosphere transmittance per sample, instead of using the light global transmittance.

  • view_sample_count_scale (float): [Read-Write] Scale the tracing sample count in primary views. Quality level scalability CVARs affect the maximum range. The sample count resolution is still clamped according to scalability setting to ‘r.VolumetricCloud.ViewRaySampleCountMax’.

  • visible (bool): [Read-Write] Whether to completely draw the primitive; if false, the primitive is not drawn, does not cast a shadow.

property aerial_pespective_mie_scattering_fade_distance: float

[Read-Only] Specify the distance over which the Rayleigh scattering will linearly ramp up to full effect. (kilometers)

Type:

(float)

property aerial_pespective_mie_scattering_start_distance: float

[Read-Only] Specify the aerial perspective start distance on cloud for Mie scattering only. (kilometers)

Type:

(float)

property aerial_pespective_rayleigh_scattering_fade_distance: float

[Read-Only] Specify the distance over which the Rayleigh scattering will linearly ramp up to full effect. (kilometers)

Type:

(float)

property aerial_pespective_rayleigh_scattering_start_distance: float

[Read-Only] Specify the aerial perspective start distance on cloud for Rayleigh scattering only. (kilometers)

Type:

(float)

property ground_albedo: Color

[Read-Only] The ground albedo used to light the cloud from below with respect to the sun light and sky atmosphere. This is only used by the cloud material when the ‘Volumetric Advanced’ node have GroundContribution enabled.

Type:

(Color)

property holdout: bool

[Read-Only] If this is True, this primitive will render black with an alpha of 0, but all secondary effects (shadows, reflections, indirect lighting) remain. This feature required the project setting “Enable alpha channel support in post processing”.

Type:

(bool)

property layer_bottom_altitude: float

[Read-Only] The altitude at which the cloud layer starts. (kilometers above the ground)

Type:

(float)

property layer_height: float

[Read-Only] The height of the the cloud layer. (kilometers above the layer bottom altitude)

Type:

(float)

property material: MaterialInterface

[Read-Only] The material describing the cloud volume. It must be a Volume domain material.

Type:

(MaterialInterface)

property planet_radius: float

[Read-Only] The planet radius used when there is not SkyAtmosphere component present in the scene.

Type:

(float)

property reflection_view_sample_count_scale_value: float

[Read-Only] Scale the tracing sample count in reflection views. Quality level scalability CVARs affect the maximum range. The sample count resolution is still clamped according to scalability setting to ‘r.VolumetricCloud.ReflectionRaySampleMaxCount’.

Type:

(float)

property render_in_main_pass: bool

[Read-Only] If true, this component will be rendered in the main pass (basepass, transparency)

Type:

(bool)

set_ground_albedo(new_value) → None

Set Ground Albedo

Parameters:

new_value (Color) –

set_holdout(new_holdout) → None

Set Holdout

Parameters:

new_holdout (bool) –

set_layer_bottom_altitude(new_value) → None

Set Layer Bottom Altitude

Parameters:

new_value (float) –

set_layer_height(new_value) → None

Set Layer Height

Parameters:

new_value (float) –

set_material(new_value) → None

Set Material

Parameters:

new_value (MaterialInterface) –

set_planet_radius(new_value) → None

Set Planet Radius

Parameters:

new_value (float) –

set_reflection_sample_count_scale(new_value) → None

Set Reflection Sample Count Scale deprecated: This function has been replaced by SetReflectionViewSampleCountScale.

Parameters:

new_value (float) –

set_reflection_view_sample_count_scale(new_value) → None

Set Reflection View Sample Count Scale

Parameters:

new_value (float) –

set_render_in_main_pass(value) → None

Set Render in Main Pass

Parameters:

value (bool) –

set_shadow_reflection_sample_count_scale(new_value) → None

Set Shadow Reflection Sample Count Scale deprecated: This function has been replaced by SetShadowReflectionViewSampleCountScale.

Parameters:

new_value (float) –

set_shadow_reflection_view_sample_count_scale(new_value) → None

Set Shadow Reflection View Sample Count Scale

Parameters:

new_value (float) –

set_shadow_tracing_distance(new_value) → None

Set Shadow Tracing Distance

Parameters:

new_value (float) –

set_shadow_view_sample_count_scale(new_value) → None

Set Shadow View Sample Count Scale

Parameters:

new_value (float) –

set_sky_light_cloud_bottom_occlusion(new_value) → None

Set Sky Light Cloud Bottom Occlusion

Parameters:

new_value (float) –

set_stop_tracing_transmittance_threshold(new_value) → None

Set Stop Tracing Transmittance Threshold

Parameters:

new_value (float) –

set_tracing_max_distance(new_value) → None

Set Tracing Max Distance

Parameters:

new_value (float) –

set_tracing_start_distance_from_camera(new_value) → None

Set Tracing Start Distance from Camera

Parameters:

new_value (float) –

set_tracing_start_max_distance(new_value) → None

Set Tracing Start Max Distance

Parameters:

new_value (float) –

set_view_sample_count_scale(new_value) → None

Set View Sample Count Scale

Parameters:

new_value (float) –

setb_use_per_sample_atmospheric_light_transmittance(new_value) → None

Setb Use Per Sample Atmospheric Light Transmittance

Parameters:

new_value (bool) –

property shadow_reflection_view_sample_count_scale_value: float

[Read-Only] Scale the shadow tracing sample count in reflection views, only used with Advanced Output ray marched shadows. Quality level scalability CVARs affect the maximum range. The sample count resolution is still clamped according to scalability setting to ‘r.VolumetricCloud.Shadow.ReflectionRaySampleMaxCount’.

Type:

(float)

property shadow_tracing_distance: float

[Read-Only] The shadow tracing distance in kilometers, only used with Advanced Output ray marched shadows.

Type:

(float)

property shadow_view_sample_count_scale: float

[Read-Only] Scale the shadow tracing sample count in primary views, only used with Advanced Output ray marched shadows. Quality level scalability CVARs affect the maximum range. The sample count resolution is still clamped according to scalability setting to ‘r.VolumetricCloud.Shadow.ViewRaySampleMaxCount’.

Type:

(float)

property sky_light_cloud_bottom_occlusion: float

[Read-Only] Occlude the sky light contribution at the bottom of the cloud layer. This is a fast approximation to sky lighting being occluded by cloud without having to trace rays or sample AO texture. Ignored if the cloud material explicitely sets the ambient occlusion value.

Type:

(float)

property stop_tracing_transmittance_threshold: float

[Read-Only] When the mean transmittance is below this threshold, we stop tracing. This is a good way to reduce the ray marched sample count, and thus to increase performance.

Type:

(float)

property tracing_max_distance: float

[Read-Only] The maximum distance that will be traced inside the cloud layer. (kilometers)

Type:

(float)

property tracing_max_distance_mode: VolumetricCloudTracingMaxDistanceMode

[Read-Only] Mode to select how the tracing max distance should be interpreted. DistanceFromPointOfView is useful to avoid the top of the cloud layer to be clipped when TracingMaxDistance is shorten for performance.

Type:

(VolumetricCloudTracingMaxDistanceMode)

property tracing_start_distance_from_camera: float

[Read-Only] The distance from which the tracing will start. This is useful when the camera for instance is inside the layer of cloud. (kilometers)

Type:

(float)

property tracing_start_max_distance: float

[Read-Only] The maximum distance of the volumetric surface, i.e. cloud layer upper and lower bound, before which we will accept to start tracing. (kilometers)

Type:

(float)

property use_per_sample_atmospheric_light_transmittance: bool

[Read-Only] Whether to apply atmosphere transmittance per sample, instead of using the light global transmittance.

Type:

(bool)

property view_sample_count_scale: float

[Read-Only] Scale the tracing sample count in primary views. Quality level scalability CVARs affect the maximum range. The sample count resolution is still clamped according to scalability setting to ‘r.VolumetricCloud.ViewRaySampleCountMax’.

Type:

(float)