UPointLightComponent

A light component which emits light from a single point equally in all directions.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

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

Include

#include "Components/PointLightComponent.h"

Syntax

class UPointLightComponent : public ULocalLightComponent

Remarks

A light component which emits light from a single point equally in all directions.

Variables

Name Description

Public variable

uint32: 1

 

bUseInverseSquaredFalloff

Whether to use physically based inverse squared distance falloff, where AttenuationRadius is only clamping the light's contribution.

Public variable

float

 

LightFalloffExponent

Controls the radial falloff of the light when UseInverseSquaredFalloff is disabled.

Public variable

float

 

SoftSourceRadius

Soft radius of light source shape.

Public variable

float

 

SourceLength

Length of light source shape.

Public variable

float

 

SourceRadius

Radius of light source shape.

Constructors

Name Description

Public function

UPointLightComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

SetLightFalloffExponent

(
    float NewLightFalloffExponent
)

Public function

void

 

SetSoftSourceRadius

(
    float bNewValue
)

Public function

void

 

SetSourceLength

(
    float NewValue
)

Public function

void

 

SetSourceRadius

(
    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 Const

bool

 

CanEditChange

(
    const UProperty* InProperty
)

Called by the editor to query whether a property of this object is allowed to be modified.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

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

Public function Virtual

void

 

PostInterpChange

(
    UProperty* PropertyThatChanged
)

This is called when property is modified by InterpPropertyTracks

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

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