unreal.AtmosphericFogComponent

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

Bases: unreal.SceneComponent

Used to create fogging effects such as clouds.

C++ Source:

  • Module: Engine

  • File: AtmosphericFogComponent.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

  • altitude_scale (float): [Read-Write] Scale the view altitude (only Z scale).

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

  • atmosphere_affects_sun_illuminance (bool): [Read-Write] Set to true if the atmosphere should affect the selected sun light illuminance. The light will be tinted based on its zenith angle and atmosphere properties as if all surfaces were at the ground level 0 meter.

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

  • default_brightness (float): [Read-Write] Default atmospheric sun light disc luminance. Used when there is no atmospheric sun light selected in the level.

  • default_light_color (Color): [Read-Write] Default atmospheric sun light disc color. Used when there is no sunlight placed in the level.

  • density_multiplier (float): [Read-Write] Scales the atmosphere transmittance over background.

  • density_offset (float): [Read-Write] Offset the atmosphere transmittance over background [-1.f ~ 1.f].

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

  • disable_ground_scattering_value (bool): [Read-Write] Disable color scattering from ground.

  • disable_sun_disk_value (bool): [Read-Write] Disable sun disk rendering.

  • distance_offset (float): [Read-Write] Apply a distance offset before evaluating the atmospheric fog, in km (to handle large distance). Only on surfaces, excludes the sky.

  • distance_scale (float): [Read-Write] Scale the view position.

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

  • fog_multiplier (float): [Read-Write] Scale the scattered luminance from the atmosphere sun light only on surfaces, excludes the sky.

  • ground_offset (float): [Read-Write] Offset the view altitude (along Z).

  • 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

  • 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 *

  • precompute_params (AtmospherePrecomputeParameters): [Read-Write] Precompute Params

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

  • 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!

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

  • start_distance (float): [Read-Write] The atmospheric fog start distance in centimeters.

  • sun_disc_scale (float): [Read-Write] Sun half apex angle in degree, see https://en.wikipedia.org/wiki/Solid_angle

  • sun_multiplier (float): [Read-Write] Scale the scattered luminance from the atmosphere sun light. Only affect the sky and atmospheric fog.

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

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

property altitude_scale

[Read-Write] Scale the view altitude (only Z scale).

Type

(float)

property atmosphere_affects_sun_illuminance

[Read-Only] Set to true if the atmosphere should affect the selected sun light illuminance. The light will be tinted based on its zenith angle and atmosphere properties as if all surfaces were at the ground level 0 meter.

Type

(bool)

property default_brightness

[Read-Only] Default atmospheric sun light disc luminance. Used when there is no atmospheric sun light selected in the level.

Type

(float)

property default_light_color

[Read-Only] Default atmospheric sun light disc color. Used when there is no sunlight placed in the level.

Type

(Color)

property density_multiplier

[Read-Write] Scales the atmosphere transmittance over background.

Type

(float)

property density_offset

[Read-Write] Offset the atmosphere transmittance over background [-1.f ~ 1.f].

Type

(float)

disable_ground_scattering(new_ground_scattering) → None

Set DisableGroundScattering

Parameters

new_ground_scattering (bool) –

property disable_ground_scattering_value

[Read-Only] Disable color scattering from ground.

Type

(bool)

disable_sun_disk(new_sun_disk) → None

Set DisableSunDisk

Parameters

new_sun_disk (bool) –

property disable_sun_disk_value

[Read-Only] Disable sun disk rendering.

Type

(bool)

property distance_offset

[Read-Write] Apply a distance offset before evaluating the atmospheric fog, in km (to handle large distance). Only on surfaces, excludes the sky.

Type

(float)

property distance_scale

[Read-Write] Scale the view position.

Type

(float)

property fog_multiplier

[Read-Write] Scale the scattered luminance from the atmosphere sun light only on surfaces, excludes the sky.

Type

(float)

property ground_offset

[Read-Write] Offset the view altitude (along Z).

Type

(float)

property precompute_params

[Read-Only] Precompute Params

Type

(AtmospherePrecomputeParameters)

set_altitude_scale(new_altitude_scale) → None

Set AltitudeScale

Parameters

new_altitude_scale (float) –

set_default_brightness(new_brightness) → None

Set brightness of the light

Parameters

new_brightness (float) –

set_default_light_color(new_light_color) → None

Set color of the light

Parameters

new_light_color (LinearColor) –

set_density_multiplier(new_density_multiplier) → None

Set DensityMultiplier

Parameters

new_density_multiplier (float) –

set_density_offset(new_density_offset) → None

Set DensityOffset

Parameters

new_density_offset (float) –

set_distance_offset(new_distance_offset) → None

Set DistanceOffset

Parameters

new_distance_offset (float) –

set_distance_scale(new_distance_scale) → None

Set DistanceScale

Parameters

new_distance_scale (float) –

set_fog_multiplier(new_fog_multiplier) → None

Set FogMultiplier

Parameters

new_fog_multiplier (float) –

set_precompute_params(density_height, max_scattering_order, inscatter_altitude_sample_num) → None

Set PrecomputeParams, only valid in Editor mode

Parameters

  • density_height (float) –

  • max_scattering_order (int32) –

  • inscatter_altitude_sample_num (int32) –

set_start_distance(new_start_distance) → None

Set StartDistance

Parameters

new_start_distance (float) –

set_sun_multiplier(new_sun_multiplier) → None

Set SunMultiplier

Parameters

new_sun_multiplier (float) –

property start_distance

[Read-Write] The atmospheric fog start distance in centimeters.

Type

(float)

start_precompute() → None

Start Precompute

property sun_disc_scale

//en.wikipedia.org/wiki/Solid_angle

Type

(float)

Type

[Read-Write] Sun half apex angle in degree, see https

property sun_multiplier

[Read-Write] Scale the scattered luminance from the atmosphere sun light. Only affect the sky and atmospheric fog.

Type

(float)