Navigation
API > API/Runtime > API/Runtime/Engine
A light component which emits light from a single point equally in all directions.
| Name | ULocalLightComponent |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Components/LocalLightComponent.h |
| Include Path | #include "Components/LocalLightComponent.h" |
Syntax
UCLASS (Abstract, ClassGroup=(Lights, Common), HideCategories=(Object, LightShafts), EditInlineNew,
Meta=(BlueprintSpawnableComponent), MinimalAPI)
class ULocalLightComponent : public ULightComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → ULightComponentBase → ULightComponent → ULocalLightComponent
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ULocalLightComponent
(
const FObjectInitializer& ObjectInitializer |
Components/LocalLightComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AttenuationRadius | float | Bounds the light's visible influence. | Components/LocalLightComponent.h |
|
| IntensityUnits | ELightUnits | Units used for the intensity. | Components/LocalLightComponent.h |
|
| InverseExposureBlend | float | Blend Factor used to blend between Intensity and Intensity/Exposure. | Components/LocalLightComponent.h |
|
| LightmassSettings | FLightmassPointLightSettings | The Lightmass settings for this object. | Components/LocalLightComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void SetAttenuationRadius
(
float NewRadius |
Components/LocalLightComponent.h |
|
|
void SetIntensityUnits
(
ELightUnits NewIntensityUnits |
Set the units used for the intensity of the light | Components/LocalLightComponent.h |
|
Overridden from ULightComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AffectsBounds
(
const FBoxSphereBounds& InBounds |
Test whether the light affects the given bounding volume. | Components/LocalLightComponent.h | |
virtual FBox GetBoundingBox() |
Return the world-space bounding box of the light's influence. | Components/LocalLightComponent.h | |
virtual FSphere GetBoundingSphere() |
Components/LocalLightComponent.h | ||
virtual FLightmassLightSettings GetLightmassSettings() |
Components/LocalLightComponent.h | ||
virtual FVector4 GetLightPosition() |
Return the homogenous position of the light. | Components/LocalLightComponent.h | |
virtual ELightUnits GetLightUnits() |
Components/LocalLightComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanEditChange
(
const FProperty* InProperty |
Components/LocalLightComponent.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called after property has changed via e.g. property window or set command. | Components/LocalLightComponent.h | |
virtual void Serialize
(
FArchive& Ar |
Components/LocalLightComponent.h |
Protected
Overridden from UActorComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void SendRenderTransform_Concurrent () |
Called to send a transform update for this component to the rendering thread | Components/LocalLightComponent.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static float GetUnitsConversionFactor
(
ELightUnits SrcUnits, |
Components/LocalLightComponent.h |
|
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Radius_DEPRECATED | float | Components/LocalLightComponent.h |