UMovieGraphLightModifierNode

A node which modifies properties on light components within the world.

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

A node which modifies properties on light components within the world.

There are several common light properties (eg, Light Color) that can be modified directly. For less common light properties, they can be modified by adding them as "Custom" properties. The common properties apply to all standard light types; custom properties apply only to a specific light type.

   
Name UMovieGraphLightModifierNode
Type class
Header File /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/Graph/Nodes/MovieGraphLightModifierNode.h
Include Path #include "Graph/Nodes/MovieGraphLightModifierNode.h"

Syntax

UCLASS (MinimalAPI)  
class UMovieGraphLightModifierNode :  
    public UMovieGraphSettingNode ,  
    public IMovieGraphModifierNodeInterface

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieGraphLightModifierNode()

   Graph/Nodes/MovieGraphLightModifierNode.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAffectsWorld uint32 Whether the light can affect the world, or whether it is disabled. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light"
  • Meta=(EditCondition="bOverride_bAffectsWorld")
bOverride_bAffectsWorld uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_CastShadows uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_DirectionalLightIntensity uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_IndirectLightingIntensity uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_Intensity uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_IntensityMethod uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_IntensityUnits uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_LightColor uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_LightingChannels uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_ModifierName uint8 Always merge the modifier name, no need for the user to do this explicitly. Graph/Nodes/MovieGraphLightModifierNode.h  
bOverride_PointLightIntensity uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_PointLightIntensityUnits uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_RectLightIntensity uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_RectLightIntensityUnits uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_SamplesPerPixel uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_SkyLightIntensityScale uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_SpotLightIntensity uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_SpotLightIntensityUnits uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_VolumetricScatteringIntensity uint8   Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
CastShadows uint32 Whether the light should cast any shadows. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light"
  • Meta=(EditCondition="bOverride_CastShadows")
DirectionalLightIntensity float Maximum illumination from the light (in lux). Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light|Intensity"
  • Meta=(EditCondition="bOverride_DirectionalLightIntensity", UIMin="0.0", UIMax="150.0", SliderExponent="2.0", Units="lux")
IndirectLightingIntensity float Scales the indirect lighting contribution from this light. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light"
  • Meta=(UIMin="0.0", UIMax="6.0", EditCondition="bOverride_IndirectLightingIntensity")
Intensity float Total energy that the light emits. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light|Intensity"
  • Meta=(EditCondition="bOverride_Intensity", UIMin="0.0", UIMax="20.0", Units="cd")
IntensityMethod EMovieGraphLightModifierIntensityMethod Whether point, rect, and spot lights share the same intensity, or the intensity (and intensity units) are unique for each type. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light|Intensity"
  • Meta=(EditCondition="bOverride_IntensityMethod")
IntensityUnits ELightUnits Units used for the intensity. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light|Intensity"
  • Meta=(EditCondition="bOverride_IntensityUnits")
LightColor FColor Filter color of the light. Note that this can change the light's effective intensity. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light"
  • Meta=(EditCondition="bOverride_LightColor", HideAlphaChannel)
LightingChannels FLightingChannels Channels that this light should affect. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light"
  • Meta=(EditCondition="bOverride_LightingChannels")
ModifierName FString The name of this modifier. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Modifier"
PointLightIntensity float Total energy that the point light emits. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light|Intensity|PointLight"
  • Meta=(EditCondition="bOverride_PointLightIntensity", UIMin="0.0", UIMax="20.0")
PointLightIntensityUnits ELightUnits Units used for the point light intensity. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light|Intensity|PointLight"
  • Meta=(EditCondition="bOverride_PointLightIntensityUnits")
RectLightIntensity float Total energy that the rect light emits. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light|Intensity|RectLight"
  • Meta=(EditCondition="bOverride_RectLightIntensity", UIMin="0.0", UIMax="20.0")
RectLightIntensityUnits ELightUnits Units used for the rect light intensity. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light|Intensity|RectLight"
  • Meta=(EditCondition="bOverride_RectLightIntensityUnits")
SamplesPerPixel int Samples per pixel for ray tracing. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="RayTracing"
  • Meta=(EditCondition="bOverride_SamplesPerPixel")
SkyLightIntensityScale float Total energy that the sky light emits. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light|Intensity"
  • Meta=(EditCondition="bOverride_SkyLightIntensityScale", UIMin="0.0", UIMax="50000.0", SliderExponent="10.0")
SpotLightIntensity float Total energy that the spot light emits. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light|Intensity|SpotLight"
  • Meta=(EditCondition="bOverride_SpotLightIntensity", UIMin="0.0", UIMax="20.0")
SpotLightIntensityUnits ELightUnits Units used for the spot light intensity. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light|Intensity|SpotLight"
  • Meta=(EditCondition="bOverride_SpotLightIntensityUnits")
VolumetricScatteringIntensity float Intensity of the volumetric scattering from this light. This scales Intensity and LightColor. Graph/Nodes/MovieGraphLightModifierNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Light"
  • Meta=(UIMin="0.25", UIMax="4.0", EditCondition="bOverride_VolumetricScatteringIntensity")

Protected

Name Type Remarks Include Path Unreal Specifiers
bOverride_Collections uint8 Always merge collection names, no need for the user to do this explicitly. Graph/Nodes/MovieGraphLightModifierNode.h  
bOverride_CustomPropertyInfo uint8 Same with the custom property info; always merge it. Graph/Nodes/MovieGraphLightModifierNode.h  
Collections TArray< FName > The collections modified by this node. Only lights will be modified. Graph/Nodes/MovieGraphLightModifierNode.h
  • Meta=(HideInActiveRenderSettings)
CustomPropertyInfo TMap< FName, FMovieGraphPropertyReference > Stores supplemental information for each "Custom" lighting property. Graph/Nodes/MovieGraphLightModifierNode.h
  • Meta=(HideInActiveRenderSettings)
Modifier TObjectPtr< UMovieGraphPropertyModifier > The light modifier associated with this node. Graph/Nodes/MovieGraphLightModifierNode.h
  • Meta=(HideInActiveRenderSettings)

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddCustomLightProperty ( UClass* InLightComponentClass,
const FName& InPropertyName
)

 Adds the property from the specified class to the "Custom" lighting properties. Graph/Nodes/MovieGraphLightModifierNode.h
  • BlueprintCallable
  • Category="Properties"

bool AddCustomLightProperty ( UClass* InLightComponentClass,
const FProperty* InLightProperty
)

 Adds the property from the specified class to the "Custom" lighting properties. Graph/Nodes/MovieGraphLightModifierNode.h  

int32 GetNumCustomLightProperties()

 Gets how many "Custom" lighting properties have been added. Graph/Nodes/MovieGraphLightModifierNode.h
  • BlueprintCallable
  • Category="Properties"

bool HasCustomLightProperty ( const UClass* InLightComponentClass,
const FName& InPropertyName
) const

 Determines if the given property exists within the "Custom" lighting properties. Graph/Nodes/MovieGraphLightModifierNode.h
  • BlueprintCallable
  • Category="Properties"

bool HasCustomLightProperty ( const UClass* InLightComponentClass,
const FProperty* InLightProperty
) const

 Determines if the given property exists within the "Custom" lighting properties. Graph/Nodes/MovieGraphLightModifierNode.h  

bool IsCustomLightPropertyOverridden ( const UClass* InLightComponentClass,
const FName& InPropertyName
) const

 Determines if the given "Custom" light property has been marked as overridden. Graph/Nodes/MovieGraphLightModifierNode.h
  • BlueprintCallable
  • Category="Properties"

bool RemoveCustomLightProperty ( const UClass* InLightComponentClass,
const FProperty* InLightProperty
)

 Removes the property in the specified class from the "Custom" lighting properties. Graph/Nodes/MovieGraphLightModifierNode.h  

bool RemoveCustomLightProperty ( const UClass* InLightComponentClass,
const FName& InPropertyName
)

 Removes the property in the specified class from the "Custom" lighting properties. Graph/Nodes/MovieGraphLightModifierNode.h
  • BlueprintCallable
  • Category="Properties"

bool UpdateCustomLightPropertyOverrideState ( const UClass* InLightComponentClass,
const FName& InPropertyName,
const bool bIsOverridden
)

 Updates the override state for a "Custom" light property. Graph/Nodes/MovieGraphLightModifierNode.h
  • BlueprintCallable
  • Category="Properties"

Public Virtual

Overridden from UMovieGraphSettingNode

Name Remarks Include Path Unreal Specifiers
An identifier that distinguishes this node from other nodes of the same type within a branch. Graph/Nodes/MovieGraphLightModifierNode.h  

virtual void PrepareForFlattening ( const UMovieGraphSettingNode* InSourceNode
)

 In some very rare cases, a node needs to be "primed" from the node that the flattening is starting from before it's actually put through the flattening process. Graph/Nodes/MovieGraphLightModifierNode.h  

virtual void UpdateTelemetry ( FMoviePipelineShotRenderTelemetry* InTelemetry
) const

 Updates telemetry data for this node. Graph/Nodes/MovieGraphLightModifierNode.h  

Overridden from UMovieGraphNode

Name Remarks Include Path Unreal Specifiers
Gets the descriptions of properties which can be dynamically added to the node. Graph/Nodes/MovieGraphLightModifierNode.h  

virtual FSlateIcon GetIconAndTint ( FLinearColor& OutColor
) const

 Gets the node's icon and icon tint, as visible in the graph. Graph/Nodes/MovieGraphLightModifierNode.h  

virtual FText GetMenuCategory()

 Gets the category that the node belongs under. Graph/Nodes/MovieGraphLightModifierNode.h  

virtual FText GetNodeTitle ( const bool bGetDescriptive
) const

 Gets the node's title. Graph/Nodes/MovieGraphLightModifierNode.h  

virtual FLinearColor GetNodeTitleColor()

 Gets the node's title color, as visible in the graph. Graph/Nodes/MovieGraphLightModifierNode.h  

virtual TArray< FMovieGraphPropertyInfo > GetOverrideablePropertyInfo()

 Gets the information about properties which can be exposed as a pin on the node. Graph/Nodes/MovieGraphLightModifierNode.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Graph/Nodes/MovieGraphLightModifierNode.h  

Overridden from IMovieGraphModifierNodeInterface

Name Remarks Include Path Unreal Specifiers

virtual void AddCollection ( const FName& InCollectionName
)

 Adds a collection identified by the given name which will be affected by the modifiers on this node. Graph/Nodes/MovieGraphLightModifierNode.h  

virtual TArray< FName > GetAllCollections()

 Gets all collections that will be affected by the modifiers used by this node. Graph/Nodes/MovieGraphLightModifierNode.h  

virtual TArray< UMovieGraphModifierBase * > GetAllModifiers()

 Gets all modifiers that will be applied with this modifier node. Graph/Nodes/MovieGraphLightModifierNode.h  

virtual bool RemoveCollection ( const FName& InCollectionName
)

 Removes a collection identified by the given name. Graph/Nodes/MovieGraphLightModifierNode.h  

virtual bool SupportsCollections()

 Gets whether this modifier node supports/uses collections. Graph/Nodes/MovieGraphLightModifierNode.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetLightingOverridePropertyName ( const FName& InMainPropertyName
)

 Gets the bOverride_* property name used for the given property within the DynamicProperties property bag. Graph/Nodes/MovieGraphLightModifierNode.h  

static FName GetLightingPropertyName ( const UClass* InLightComponentClass,
const FProperty* InLightProperty
)

 Gets the property name used for the given property within the DynamicProperties property bag. Graph/Nodes/MovieGraphLightModifierNode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page