Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineCore > API/Plugins/MovieRenderPipelineCore/Graph
Inheritance Hierarchy
- UObject
- UMovieGraphNode
- UMovieGraphBranchNode
- UMovieGraphInputNode
- UMovieGraphOutputNode
- UMovieGraphRemoveRenderSettingNode
- UMovieGraphSelectNode
- UMovieGraphSettingNode
- UMovieGraphApplyCVarPresetNode
- UMovieGraphCameraSettingNode
- UMovieGraphCollectionNode
- UMovieGraphCommandLineEncoderNode
- UMovieGraphDebugSettingNode
- UMovieGraphExecuteScriptNode
- UMovieGraphFileOutputNode
- UMovieGraphAudioOutputNode
- UMovieGraphImageSequenceOutputNode
- UMovieGraphImageSequenceOutputNode_BMP
- UMovieGraphImageSequenceOutputNode_EXR
- UMovieGraphImageSequenceOutputNode_MultiLayerEXR
- UMovieGraphImageSequenceOutputNode_JPG
- UMovieGraphImageSequenceOutputNode_PNG
- UMovieGraphVideoOutputNode
- UMovieGraphGlobalGameOverridesNode
- UMovieGraphGlobalOutputSettingNode
- UMovieGraphModifierNode
- UMovieGraphRenderLayerNode
- UMovieGraphRenderPassNode
- UMovieGraphImagePassBaseNode
- UMovieGraphDeferredRenderPassNode
- UMovieGraphPathTracerRenderPassNode
- UMovieGraphSamplingMethodNode
- UMovieGraphSetCVarValueNode
- UMovieGraphSetMetadataAttributesNode
- UMovieGraphSetStartEndConsoleCommandsNode
- UMovieGraphWarmUpSettingNode
- UMovieGraphSubgraphNode
- UMovieGraphVariableNode
References
| Module | MovieRenderPipelineCore |
| Header | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/Graph/MovieGraphNode.h |
| Include | #include "Graph/MovieGraphNode.h" |
Syntax
UCLASS (Abstract)
class UMovieGraphNode : public UObject
Remarks
This is a base class for all nodes that can exist in the UMovieGraphConfig network. In the editor, each node in the network will have an editor-only representation too which contains data about it's visual position in the graph, comments, etc.
Variables
| Type | Name | Description | |
|---|---|---|---|
| uint8: 1 | bIsCommentBubblePinned | ||
| uint8: 1 | bIsCommentBubbleVisible | ||
| uint8: 1 | bIsDisabled | Whether this node is currently disabled in the graph. | |
| FInstancedPropertyBag | DynamicProperties | Properties which can be dynamically declared on the node (vs. native properties which are always present). | |
| TArray< FMovieGraphPropertyInfo > | ExposedPropertyInfo | Tracks which properties have been exposed on the node as inputs. | |
| TObjectPtr< UEdGraphNode > | GraphNode | Editor Node Graph representation. | |
| FGuid | Guid | A GUID which uniquely identifies this node. | |
| TArray< TObjectPtr< UMovieGraphPin > > | InputPins | ||
| FString | NodeComment | ||
| int32 | NodePosX | ||
| int32 | NodePosY | ||
| FOnMovieGraphNodeChanged | OnNodeChangedDelegate | ||
| TArray< TObjectPtr< UMovieGraphPin > > | OutputPins | ||
| TArray< FString > | ScriptTags | Tags that can be used to identify this node within a pre/post render script. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | Determines if this node type can be added to the graph interactively by a user or via the API when constructing a graph. | ||
| bool | Determines if this node can be disabled. | ||
| TArray< UMovieGraphPin * > | EvaluatePinsToFollow
(
FMovieGraphEvaluationContext& InContext |
Used to determine which pins we should follow when trying to traverse the graph. | |
| const FBoolProperty * | FindOverridePropertyForDynamicProperty
(
const FName& InPropertyName |
Gets the override property for the specified dynamic property. | |
| TArray< const FProperty * > | Gets all overrideable properties that are defined on the node. | ||
| EMovieGraphBranchRestriction | Determines which types of branches the node can be created in. | ||
| TArray< FPropertyBagPropertyDesc > | Gets the descriptions of properties which can be dynamically added to the node. | ||
| bool | GetDynamicPropertyValue
(
const FName PropertyName, |
Gets the value of the dynamic property with the specified name. | |
| TArray< FMovieGraphPinProperties > | Gets the pin properties for all properties which have been exposed on the node. | ||
| TArray< FMovieGraphPropertyInfo > | Gets the information about properties which are currently exposed as pins on the node. | ||
| UMovieGraphPin * | Gets the first input pin on the node which has a connection, or nullptr if no pins are connected. | ||
| UMovieGraphPin * | Gets the first output pin on the node which has a connection, or nullptr if no pins are connected. | ||
| UMovieGraphConfig * | GetGraph () |
||
| UEdGraphNode * | GetGraphNode () |
||
| const FGuid & | GetGuid () |
Gets the GUID which uniquely identifies this node. | |
| FSlateIcon | GetIconAndTint
(
FLinearColor& OutColor |
Gets the node's icon and icon tint, as visible in the graph. | |
| UMovieGraphPin * | GetInputPin
(
const FName& InPinLabel, |
Gets the input pin with the specified name, or nullptr if one could not be found. | |
| TArray< FMovieGraphPinProperties > | Gets the properties for all input pins. | ||
| const TArray< UMovieGraphPin * > & | GetInputPins () |
Gets all input pins on the node. | |
| FText | GetKeywords () |
Gets the keywords (space-separated) that will be searched in the node creation context menu. | |
| FText | Gets the category that the node belongs under. | ||
| FString | |||
| int32 | GetNodePosX () |
||
| int32 | GetNodePosY () |
||
| FText | GetNodeTitle
(
const bool bGetDescriptive |
Gets the node's title. | |
| FLinearColor | Gets the node's title color, as visible in the graph. | ||
| UMovieGraphPin * | GetOutputPin
(
const FName& InPinLabel |
Gets the output pin with the specified name, or nullptr if one could not be found. | |
| TArray< FMovieGraphPinProperties > | Gets the properties for all output pins. | ||
| const TArray< UMovieGraphPin * > & | Gets all output pins on the node. | ||
| TArray< FMovieGraphPropertyInfo > | Gets the information about properties which can be exposed as a pin on the node. | ||
| UMovieGraphValueContainer * | GetPropertyValueContainerForPin
(
const FString& InPinName |
When a non-branch pin type is being evaluated on a node, the calling node will ask this node for the value connected to the given pin name. | |
| FString | GetResolvedValueForOutputPin
(
const FName& InPinName, |
Gets the resolved value of a named output pin (one that is returned in GetOutputPinProperties()). | |
| bool | GetResolvedValueForOutputPin
(
const FName& InPinName, |
The same functionality as the other method that returns a string. | |
| bool | |||
| bool | |||
| bool | IsDisabled () |
Determines if this node is currently disabled. | |
| bool | IsDynamicPropertyOverridden
(
const FName& InPropertyName |
Returns true if the dynamic property with the provided name has been overridden, else false. | |
| void | PostDuplicate
(
EDuplicateMode::Type DuplicateMode |
||
| void | PostLoad () |
||
| void | Register any delegates that need to be set up on the node. | ||
| void | SetDisabled
(
const bool bNewDisableState |
Set whether this node is currently disabled. | |
| void | SetDynamicPropertyOverridden
(
const FName& InPropertyName, |
Sets the dynamic property with the provided name to the specified override state. | |
| bool | SetDynamicPropertyValue
(
const FName PropertyName, |
Sets the value of the dynamic property with the specified name. | |
| void | SetIsCommentBubblePinned
(
const uint8 bIsPinned |
||
| void | SetIsCommentBubbleVisible
(
uint8 bIsVisible |
||
| void | SetNodeComment
(
const FString& InNodeComment |
||
| void | SetNodePosX
(
const int32 InNodePosX |
||
| void | SetNodePosY
(
const int32 InNodePosY |
||
| void | TogglePromotePropertyToPin
(
const FName& PropertyName |
Toggles the promotion of the property with the given name to a pin on the node. | |
| void | |||
| void | UpdatePins () |
Constants
| Name | Description |
|---|---|
| GlobalsPinName | |
| GlobalsPinNameString |