Navigation
API > API/Runtime > API/Runtime/Engine
A light component which emits light from a rectangle.
| Name | URectLightComponent |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Components/RectLightComponent.h |
| Include Path | #include "Components/RectLightComponent.h" |
Syntax
UCLASS (Blueprintable, ClassGroup=(Lights), HideCategories=(Object, LightShafts), EditInlineNew,
Meta=(BlueprintSpawnableComponent), MinimalAPI)
class URectLightComponent : public ULocalLightComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → ULightComponentBase → ULightComponent → ULocalLightComponent → URectLightComponent
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
URectLightComponent
(
const FObjectInitializer& ObjectInitializer |
Components/RectLightComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BarnDoorAngle | float | Angle of barn door attached to the light source rect. | Components/RectLightComponent.h |
|
| BarnDoorLength | float | Length of barn door attached to the light source rect. | Components/RectLightComponent.h |
|
| bLightRequiresBrokenEVMath | bool | Maintain compatibility with lights created before an inconsistency in the EV lighting unit was fixed | Components/RectLightComponent.h |
|
| LightFunctionConeAngle | float | Aperture of cone angle for the perspective projection of the light function material. | Components/RectLightComponent.h |
|
| SourceHeight | float | Height of light source rect. | Components/RectLightComponent.h |
|
| SourceTexture | TObjectPtr< class UTexture > | Texture mapped to the light source rectangle | Components/RectLightComponent.h |
|
| SourceTextureOffset | FVector2f | Offsets the source texture. Value in 0..1. (default=0) | Components/RectLightComponent.h |
|
| SourceTextureScale | FVector2f | Scales the source texture. Value in 0..1. (default=1) | Components/RectLightComponent.h |
|
| SourceWidth | float | Width of light source rect. | Components/RectLightComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void SetBarnDoorAngle
(
float NewValue |
Components/RectLightComponent.h |
|
|
void SetBarnDoorLength
(
float NewValue |
Components/RectLightComponent.h |
|
|
void SetSourceHeight
(
float NewValue |
Components/RectLightComponent.h |
|
|
void SetSourceTexture
(
UTexture* NewValue |
Components/RectLightComponent.h |
|
|
void SetSourceWidth
(
float NewValue |
Components/RectLightComponent.h |
|
Overridden from ULightComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual float ComputeLightBrightness() |
Compute current light brightness based on whether there is a valid IES profile texture attached, and whether IES brightness is enabled | Components/RectLightComponent.h | |
virtual FLightSceneProxy * CreateSceneProxy() |
Components/RectLightComponent.h | ||
virtual ELightComponentType GetLightType() |
Components/RectLightComponent.h | ||
virtual float GetUniformPenumbraSize() |
Components/RectLightComponent.h | ||
virtual void SetLightBrightness
(
float InBrightness |
Set the Intensity using the brightness. The unit of brightness depends on the light type. | Components/RectLightComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
Components/RectLightComponent.h | ||
virtual bool CanEditChange
(
const FProperty* InProperty |
Components/RectLightComponent.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called after property has changed via e.g. property window or set command. | Components/RectLightComponent.h | |
virtual void Serialize
(
FArchive& Ar |
Components/RectLightComponent.h |