ULocalLightComponent

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/LocalLightComponent.h

Include

#include "Components/LocalLightComponent.h"

Syntax

class ULocalLightComponent : public ULightComponent

Remarks

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

Variables

Name Description

Public variable

float

 

AttenuationRadius

Bounds the light's visible influence.

Public variable

ELightUnits

 

IntensityUnits

Units used for the intensity.

Public variable

FLightmassPoint...

 

LightmassSettings

The Lightmass settings for this object.

Constructors

Name Description

Public function

ULocalLightComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

float

 

GetUnitsConversionFactor

(
    ELightUnits SrcUnits,
    ELightUnits TargetUnits,
    float CosHalfConeAngle
)

Public function

void

 

SetAttenuationRadius

(
    float NewRadius
)

Public function

void

 

SetIntensityUnits

(
    ELightUnits NewIntensityUnits
)

Set the units used for the intensity of the light

Overridden from ULightComponent

Name Description

Public function Virtual Const

bool

 

AffectsBounds

(
    const FBoxSphereBounds& InBounds
)

Test whether the light affects the given bounding volume.

Public function Virtual Const

FBox

 

GetBoundingBox()

Return the world-space bounding box of the light's influence.

Public function Virtual Const

FSphere

 

GetBoundingSphere()

Public function Virtual Const

FLightmassLi...

 

GetLightmassSettings()

Public function Virtual Const

FVector4

 

GetLightPosition()

Return the homogenous position of the light.

Overridden from UActorComponent

Name Description

Protected function Virtual

void

 

SendRenderTransform_Concurrent()

Called to send a transform update for this component to the rendering thread

Overridden from UObject

Name Description

Public function Virtual Const

bool

 

CanEditChange

(
    const FProperty* 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

(
    FProperty* 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.

Deprecated Variables

Name Description

Public variable

float

 

Radius_DEPRECATED
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss