unreal.VolumetricCloudComponent

class unreal.VolumetricCloudComponent(outer=None, name='None')

Bases: unreal.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

  • asset_user_data (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.

  • 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 altitude at which the cloud layer ends. (kilometers above the ground)

  • 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_sample_count_scale (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)

  • 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_sample_count_scale (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. 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.

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

  • tracing_start_max_distance (float): [Read-Write] The maximum distance of the volumetric surface 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 ground_albedo

[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 layer_bottom_altitude

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

Type

(float)

property layer_height

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

Type

(float)

property material

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

Type

(MaterialInterface)

property planet_radius

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

Type

(float)

property reflection_sample_count_scale

[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)

set_ground_albedo(new_value) → None

Set Ground Albedo

Parameters

new_value (Color) –

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

Parameters

new_value (float) –

set_shadow_reflection_sample_count_scale(new_value) → None

Set Shadow Reflection 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_tracing_max_distance(new_value) → None

Set Tracing Max Distance

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_sample_count_scale

[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

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

Type

(float)

property shadow_view_sample_count_scale

[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

[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 tracing_max_distance

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

Type

(float)

property tracing_start_max_distance

[Read-Only] The maximum distance of the volumetric surface before which we will accept to start tracing. (kilometers)

Type

(float)

property use_per_sample_atmospheric_light_transmittance

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

Type

(bool)

property view_sample_count_scale

[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)