unreal.RectLightComponent¶
- class unreal.RectLightComponent(outer=None, name='None')¶
Bases:
unreal.LocalLightComponentA light component which emits light from a rectangle.
C++ Source:
Module: Engine
File: RectLightComponent.h
Editor Properties: (see get_editor_property/set_editor_property)
absolute_location(bool): [Read-Write] Absolute Location: If RelativeLocation should be considered relative to the world, rather than the parentabsolute_rotation(bool): [Read-Write] Absolute Rotation: If RelativeRotation should be considered relative to the world, rather than the parentabsolute_scale(bool): [Read-Write] Absolute Scale: If RelativeScale3D should be considered relative to the world, rather than the parentaffect_dynamic_indirect_lighting(bool): [Read-Write] Affect Dynamic Indirect Lighting: Whether the light should be injected into the Light Propagation Volumeaffect_global_illumination(bool): [Read-Write] Affect Global Illumination: Whether the light affects global illumination, when ray-traced global illumination is enabled.affect_reflection(bool): [Read-Write] Affect Reflection: Whether the light affects objects in reflections, when ray-traced reflection is enabled.affect_translucent_lighting(bool): [Read-Write] Affect Translucent Lighting: Whether the light affects translucency or not. Disabling this can save GPU time when there are many small lights.affects_world(bool): [Read-Write] Affects World: Whether the light can affect the world, or whether it is disabled. A disabled light will not contribute to the scene in any way. This setting cannot be changed at runtime and unbuilds lighting when changed. Setting this to false has the same effect as deleting the light, so it is useful for non-destructive experiments.asset_user_data(Array(AssetUserData)): [Read-Write] Asset User Data: Array of user data stored with the componentattenuation_radius(float): [Read-Write] Attenuation Radius: Bounds the light’s visible influence. This clamping of the light’s influence is not physically correct but very important for performance, larger lights cost more.auto_activate(bool): [Read-Write] Auto Activate: Whether the component is activated at creation or must be explicitly activated.barn_door_angle(float): [Read-Write] Barn Door Angle: Angle of barn door attached to the light source rect.barn_door_length(float): [Read-Write] Barn Door Length: Length of barn door attached to the light source rect.bloom_max_brightness(float): [Read-Write] Bloom Max Brightness: After exposure is applied, scene color brightness larger than BloomMaxBrightness will be rescaled down to BloomMaxBrightness.bloom_scale(float): [Read-Write] Bloom Scale: Scales the additive color.bloom_threshold(float): [Read-Write] Bloom Threshold: Scene color must be larger than this to create bloom in the light shafts.bloom_tint(Color): [Read-Write] Bloom Tint: Multiplies against scene color to create the bloom color.can_ever_affect_navigation(bool): [Read-Write] Can Ever Affect Navigation: Whether this component can potentially influence navigationcast_deep_shadow(bool): [Read-Write] Cast Deep Shadow: Whether the light should cast high quality hair-strands self-shadowing. When this option is enabled, an extra GPU cost for this light.cast_dynamic_shadows(bool): [Read-Write] Cast Dynamic Shadows: Whether the light should cast shadows from dynamic objects. Also requires Cast Shadows to be set to True.cast_raytraced_shadow(CastRayTracedShadow): [Read-Write] Cast Raytraced Shadowcast_shadows(bool): [Read-Write] Cast Shadows: Whether the light should cast any shadows.cast_shadows_from_cinematic_objects_only(bool): [Read-Write] Cast Shadows from Cinematic Objects Only: Whether the light should only cast shadows from components marked as bCastCinematicShadows. This is useful for setting up cinematic Movable spotlights aimed at characters and avoiding the shadow depth rendering costs of the background. Note: this only works with dynamic shadow maps, not with static shadowing or Ray Traced Distance Field shadows.cast_static_shadows(bool): [Read-Write] Cast Static Shadows: Whether the light should cast shadows from static objects. Also requires Cast Shadows to be set to True.cast_translucent_shadows(bool): [Read-Write] Cast Translucent Shadows: Whether the light is allowed to cast dynamic shadows from translucency.cast_volumetric_shadow(bool): [Read-Write] Cast Volumetric Shadow: Whether the light shadows volumetric fog. Disabling this can save GPU time.component_tags(Array(Name)): [Read-Write] Component Tags: Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.contact_shadow_length(float): [Read-Write] Contact Shadow Length: Length of screen space ray trace for sharp contact shadows. Zero is disabled.contact_shadow_length_in_ws(bool): [Read-Write] Contact Shadow Length in WS: Where Length of screen space ray trace for sharp contact shadows is in world space units or in screen space units.deep_shadow_layer_distribution(float): [Read-Write] Deep Shadow Layer Distribution: Change the deep shadow layers distribution 0:linear distribution (uniform layer distribution), 1:exponential (more details on near small details).detail_mode(DetailMode): [Read-Write] Detail Mode: If detail mode is >= system detail mode, primitive won’t be rendered.disabled_brightness(float): [Read-Write] Disabled Brightness: Brightness factor applied to the light when the light function is specified but disabled, for example in scene captures that use SceneCapView_LitNoShadows. This should be set to the average brightness of the light function material’s emissive input, which should be between 0 and 1.editable_when_inherited(bool): [Read-Write] Editable when Inherited: True if this component can be modified when it was inherited from a parent actor classenable_light_shaft_bloom(bool): [Read-Write] Enable Light Shaft Bloom: Whether to render light shaft bloom from this light. For directional lights, the color around the light direction will be blurred radially and added back to the scene. for point lights, the color on pixels closer than the light’s SourceRadius will be blurred radially and added back to the scene.force_cached_shadows_for_movable_primitives(bool): [Read-Write] Force Cached Shadows for Movable Primitives: Enables cached shadows for movable primitives for this light even if r.shadow.cachedshadowscastfrommovableprimitives is 0hidden_in_game(bool): [Read-Write] Hidden in Game: Whether to hide the primitive in game, if the primitive is Visible.ies_brightness_scale(float): [Read-Write] IESBrightness Scale: Global scale for IES brightness contribution. Only available when “Use IES Brightness” is selected, and a valid IES profile texture is seties_texture(TextureLightProfile): [Read-Write] IESTexture: IES texture (light profiles from real world measured data)indirect_lighting_intensity(float): [Read-Write] Indirect Lighting Intensity: Scales the indirect lighting contribution from this light. A value of 0 disables any GI from this light. Default is 1.intensity(float): [Read-Write] Intensity: Total energy that the light emits.intensity_units(LightUnits): [Read-Write] Intensity Units: Units used for the intensity. The peak luminous intensity is measured in candelas, while the luminous power is measured in lumens.is_editor_only(bool): [Read-Write] Is Editor Only: If true, the component will be excluded from non-editor buildslight_color(Color): [Read-Write] Light Color: Filter color of the light. Note that this can change the light’s effective intensity.light_function_fade_distance(float): [Read-Write] Light Function Fade Distance: Distance at which the light function should be completely faded to DisabledBrightness. This is useful for hiding aliasing from light functions applied in the distance.light_function_material(MaterialInterface): [Read-Write] Light Function Material: The light function material to be applied to this light. Note that only non-lightmapped lights (UseDirectLightMap=False) can have a light function. Light functions are supported within VolumetricFog, but only for Directional, Point and Spot lights. Rect lights are not supported.light_function_scale(Vector): [Read-Write] Light Function Scale: Scales the light function projection. X and Y scale in the directions perpendicular to the light’s direction, Z scales along the light direction.lighting_channels(LightingChannels): [Read-Write] Lighting Channels: Channels that this light should affect. These channels only apply to opaque materials, direct lighting, and dynamic lighting and shadowing.lightmass_settings(LightmassPointLightSettings): [Read-Write] Lightmass Settings: The Lightmass settings for this object.max_distance_fade_range(float): [Read-Write] Max Distance Fade Rangemax_draw_distance(float): [Read-Write] Max Draw Distancemobility(ComponentMobility): [Read-Write] Mobility: 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] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reseton_component_deactivated(ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivatedphysics_volume_changed_delegate(PhysicsVolumeChanged): [Read-Write] Physics Volume Changed Delegate: Delegate that will be called when PhysicsVolume has been changed *primary_component_tick(ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Componentray_start_offset_depth_scale(float): [Read-Write] Ray Start Offset Depth Scale: Controls how large of an offset ray traced shadows have from the receiving surface as the camera gets further away. This can be useful to hide self-shadowing artifacts from low resolution distance fields on huge static meshes.relative_location(Vector): [Read-Write] Relative Location: Location of the component relative to its parentrelative_rotation(Rotator): [Read-Write] Relative Rotation: Rotation of the component relative to its parentrelative_scale3d(Vector): [Read-Write] Relative Scale 3D: 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] Replicates: Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!samples_per_pixel(int32): [Read-Write] Samples Per Pixel: Samples per pixel for ray tracingshadow_bias(float): [Read-Write] Shadow Bias: Controls how accurate self shadowing of whole scene shadows from this light are. At 0, shadows will start at the their caster surface, but there will be many self shadowing artifacts. larger values, shadows will start further from their caster, and there won’t be self shadowing artifacts but object might appear to fly. around 0.5 seems to be a good tradeoff. This also affects the soft transition of shadowsshadow_resolution_scale(float): [Read-Write] Shadow Resolution Scale: Scales the resolution of shadowmaps used to shadow this light. By default shadowmap resolution is chosen based on screen size of the caster. Note: shadowmap resolution is still clamped by ‘r.Shadow.MaxResolution’shadow_sharpen(float): [Read-Write] Shadow Sharpen: Amount to sharpen shadow filteringshadow_slope_bias(float): [Read-Write] Shadow Slope Bias: Controls how accurate self shadowing of whole scene shadows from this light are. This works in addition to shadow bias, by increasing the amount of bias depending on the slope of a surface. At 0, shadows will start at the their caster surface, but there will be many self shadowing artifacts. larger values, shadows will start further from their caster, and there won’t be self shadowing artifacts but object might appear to fly. around 0.5 seems to be a good tradeoff. This also affects the soft transition of shadowsshould_update_physics_volume(bool): [Read-Write] Should Update Physics Volume: Whether or not the cached PhysicsVolume this component overlaps should be updated when the component is moved. see: GetPhysicsVolume()source_height(float): [Read-Write] Source Height: Height of light source rect. Note that light sources shapes which intersect shadow casting geometry can cause shadowing artifacts.source_texture(Texture): [Read-Write] Source Texture: Texture mapped to the light source rectanglesource_width(float): [Read-Write] Source Width: Width of light source rect. Note that light sources shapes which intersect shadow casting geometry can cause shadowing artifacts.specular_scale(float): [Read-Write] Specular Scale: Multiplier on specular highlights. Use only with great care! Any value besides 1 is not physical! Can be used to artistically remove highlights mimicking polarizing filters or photo touch up.temperature(float): [Read-Write] Temperature: Color temperature in Kelvin of the blackbody illuminant. White (D65) is 6500K.transmission(bool): [Read-Write] Transmission: Whether light from this light transmits through surfaces with subsurface scattering profiles. Requires light to be movable.use_attach_parent_bound(bool): [Read-Write] Use Attach Parent Bound: If true, this component uses its parents bounds when attached. This can be a significant optimization with many components attached together.use_ies_brightness(bool): [Read-Write] Use IESBrightness: true: take light brightness from IES profile, false: use the light brightness - the maximum light in one direction is used to define no masking. Use with InverseSquareFalloff. Will be disabled if a valid IES profile texture is not supplied.use_ray_traced_distance_field_shadows(bool): [Read-Write] Use Ray Traced Distance Field Shadows: Whether to use ray traced distance field area shadows. The project setting bGenerateMeshDistanceFields must be enabled for this to have effect. Distance field shadows support area lights so they create soft shadows with sharp contacts. They have less aliasing artifacts than standard shadowmaps, but inherit all the limitations of distance field representations (only uniform scale, no deformation). These shadows have a low per-object cost (and don’t depend on triangle count) so they are effective for distant shadows from a dynamic sun.use_temperature(bool): [Read-Write] Use Temperature: false: use white (D65) as illuminant.visible(bool): [Read-Write] Visible: Whether to completely draw the primitive; if false, the primitive is not drawn, does not cast a shadow.volumetric_scattering_intensity(float): [Read-Write] Volumetric Scattering Intensity: Intensity of the volumetric scattering from this light. This scales Intensity and LightColor.
- property barn_door_angle¶
[Read-Only] Barn Door Angle: Angle of barn door attached to the light source rect.
- Type
(float)
- property barn_door_length¶
[Read-Only] Barn Door Length: Length of barn door attached to the light source rect.
- Type
(float)
- property source_height¶
[Read-Only] Source Height: Height of light source rect. Note that light sources shapes which intersect shadow casting geometry can cause shadowing artifacts.
- Type
(float)