Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → UMovieGraphNode → UMovieGraphSettingNode → UMovieGraphLightModifierNode
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 |
|
| bOverride_bAffectsWorld | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| bOverride_CastShadows | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| bOverride_DirectionalLightIntensity | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| bOverride_IndirectLightingIntensity | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| bOverride_Intensity | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| bOverride_IntensityMethod | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| bOverride_IntensityUnits | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| bOverride_LightColor | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| bOverride_LightingChannels | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| 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 |
|
|
| bOverride_PointLightIntensityUnits | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| bOverride_RectLightIntensity | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| bOverride_RectLightIntensityUnits | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| bOverride_SamplesPerPixel | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| bOverride_SkyLightIntensityScale | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| bOverride_SpotLightIntensity | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| bOverride_SpotLightIntensityUnits | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| bOverride_VolumetricScatteringIntensity | uint8 | Graph/Nodes/MovieGraphLightModifierNode.h |
|
|
| CastShadows | uint32 | Whether the light should cast any shadows. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| DirectionalLightIntensity | float | Maximum illumination from the light (in lux). | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| IndirectLightingIntensity | float | Scales the indirect lighting contribution from this light. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| Intensity | float | Total energy that the light emits. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| 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 |
|
| IntensityUnits | ELightUnits | Units used for the intensity. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| LightColor | FColor | Filter color of the light. Note that this can change the light's effective intensity. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| LightingChannels | FLightingChannels | Channels that this light should affect. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| ModifierName | FString | The name of this modifier. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| PointLightIntensity | float | Total energy that the point light emits. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| PointLightIntensityUnits | ELightUnits | Units used for the point light intensity. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| RectLightIntensity | float | Total energy that the rect light emits. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| RectLightIntensityUnits | ELightUnits | Units used for the rect light intensity. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| SamplesPerPixel | int | Samples per pixel for ray tracing. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| SkyLightIntensityScale | float | Total energy that the sky light emits. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| SpotLightIntensity | float | Total energy that the spot light emits. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| SpotLightIntensityUnits | ELightUnits | Units used for the spot light intensity. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| VolumetricScatteringIntensity | float | Intensity of the volumetric scattering from this light. This scales Intensity and LightColor. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
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 |
|
| CustomPropertyInfo | TMap< FName, FMovieGraphPropertyReference > | Stores supplemental information for each "Custom" lighting property. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
| Modifier | TObjectPtr< UMovieGraphPropertyModifier > | The light modifier associated with this node. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddCustomLightProperty
(
UClass* InLightComponentClass, |
Adds the property from the specified class to the "Custom" lighting properties. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
bool AddCustomLightProperty
(
UClass* InLightComponentClass, |
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 |
|
bool HasCustomLightProperty
(
const UClass* InLightComponentClass, |
Determines if the given property exists within the "Custom" lighting properties. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
bool HasCustomLightProperty
(
const UClass* InLightComponentClass, |
Determines if the given property exists within the "Custom" lighting properties. | Graph/Nodes/MovieGraphLightModifierNode.h | |
bool IsCustomLightPropertyOverridden
(
const UClass* InLightComponentClass, |
Determines if the given "Custom" light property has been marked as overridden. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
bool RemoveCustomLightProperty
(
const UClass* InLightComponentClass, |
Removes the property in the specified class from the "Custom" lighting properties. | Graph/Nodes/MovieGraphLightModifierNode.h | |
bool RemoveCustomLightProperty
(
const UClass* InLightComponentClass, |
Removes the property in the specified class from the "Custom" lighting properties. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
bool UpdateCustomLightPropertyOverrideState
(
const UClass* InLightComponentClass, |
Updates the override state for a "Custom" light property. | Graph/Nodes/MovieGraphLightModifierNode.h |
|
Public Virtual
Overridden from UMovieGraphSettingNode
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FString GetNodeInstanceName () |
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 |
Updates telemetry data for this node. | Graph/Nodes/MovieGraphLightModifierNode.h |
Overridden from UMovieGraphNode
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TArray< FPropertyBagPropertyDesc > GetDynamicPropertyDescriptions () |
Gets the descriptions of properties which can be dynamically added to the node. | Graph/Nodes/MovieGraphLightModifierNode.h | |
virtual FSlateIcon GetIconAndTint
(
FLinearColor& OutColor |
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 |
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 | |
| 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 | |
| Gets the property name used for the given property within the DynamicProperties property bag. | Graph/Nodes/MovieGraphLightModifierNode.h |