URectLightComponent

A light component which emits light from a rectangle.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Components/RectLightComponent.h

Include

#include "Components/RectLightComponent.h"

Syntax

class URectLightComponent : public ULocalLightComponent

Remarks

A light component which emits light from a rectangle.

Variables

Name Description

Public variable

float

 

BarnDoorAngle

Angle of barn door attached to the light source rect.

Public variable

float

 

BarnDoorLength

Length of barn door attached to the light source rect.

Public variable

float

 

SourceHeight

Height of light source rect.

Public variable

UTexture *

 

SourceTexture

Texture mapped to the light source rectangle

Public variable

float

 

SourceWidth

Width of light source rect.

Constructors

Name Description

Public function

URectLightComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

SetBarnDoorAngle

(
    float NewValue
)

Public function

void

 

SetBarnDoorLength

(
    float NewValue
)

Public function

void

 

SetSourceHeight

(
    float NewValue
)

Public function

void

 

SetSourceTexture

(
    UTexture* bNewValue
)

Public function

void

 

SetSourceWidth

(
    float bNewValue
)

Overridden from ULightComponent

Name Description

Public function Virtual Const

float

 

ComputeLightBrightness()

Compute current light brightness based on whether there is a valid IES profile texture attached, and whether IES brightness is enabled

Public function Virtual Const

FLightSceneP...

 

CreateSceneProxy()

Public function Virtual Const

ELightCompon...

 

GetLightType()

Public function Virtual Const

float

 

GetUniformPenumbraSize()

Public function Virtual

void

 

SetLightBrightness

(
    float InBrightness
)

Set the Intensity using the brightness. The unit of brightness depends on the light type.

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called after property has changed via e.g. property window or set command.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback