UControlRigGraphNode

Base class for animation ControlRig-related nodes

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

ControlRigDeveloper

Header

/Engine/Plugins/Experimental/ControlRig/Source/ControlRigDeveloper/Public/Graph/ControlRigGraphNode.h

Include

#include "Graph/ControlRigGraphNode.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UControlRigGraphNode : public UEdGraphNode

Remarks

Base class for animation ControlRig-related nodes

Constructors

Name Description

Public function

UControlRigGraphNode()

Functions

Name Description

Public function

void

 

CopyPinDefaultsToModel

(
    UEdGraphPin* Pin,
    bool bUndo
)

Propagate pin defaults to underlying properties if they have changed

Protected function

void

 

CreateExecutionPins()

Helper function for AllocateDefaultPins

Protected function

void

 

CreateInputOutputPins

(
    URigVMPin* InParentPin,
    bool bHidden
)

Protected function

void

 

CreateInputPins

(
    URigVMPin* InParentPin
)

Protected function

void

 

CreateOutputPins

(
    URigVMPin* InParentPin
)

Protected function

void

 

DestroyPinList

(
    TArray< UEdGraphPin* >& InPin...
)

Destroy all pins in an array

Public function Const

UControlRigB...

 

GetBlueprint()

Get the blueprint that this node is contained within

Protected function Const

UClass *

 

GetControlRigGeneratedClass()

Protected function Const

UClass *

 

GetControlRigSkeletonGeneratedClass()

Public function Const

const FVecto...

 

GetDimensions()

Get the cached dimensions of this node

Public function Const

URigVMNode &...

 

GetModelNode()

Get the VM node this is node is wrapping

Public function Const

FName

 

GetModelNodeName()

Get the VM node name this node is wrapping

Public function Const

URigVMPin &#...

 

GetModelPinFromPinPath

(
    const FString& InPinPath
)

Protected function Const

FLinearColor

 

GetNodeOpacityColor()

Public function

FNodeTitleDi...

 

GetNodeTitleDirtied()

Protected function Static

FEdGraphPinT...

 

GetPinTypeForModelPin

(
    URigVMPin* InModelPin
)

Public function

void

 

HandleAddArrayElement

(
    FString InPinPath
)

Add a new array element to the array referred to by the property path

Public function

void

 

HandleClearArray

(
    FString InPinPath
)

Clear the array referred to by the property path

Public function

void

 

HandleInsertArrayElement

(
    FString InPinPath
)

Insert a new array element after the element referred to by the property path

Public function

void

 

HandleRemoveArrayElement

(
    FString InPinPath
)

Remove the array element referred to by the property path

Protected function Const

void

 

InvalidateNodeTitle()

Something that could change our title has changed

Public function

bool

 

IsPinExpanded

(
    const FString& InPinPath
)

Check a pin's expansion state

Protected function Virtual

void

 

PostReconstructNode()

Handle anything post-reconstruction

Protected function Virtual

void

 

ReallocatePinsDuringReconstruction

(
    const TArray< UEdGraphPin* >&...
)

Recreate pins when we reconstruct this node

Public function Virtual

void

 

ReconstructNode_Internal

(
    bool bForce
)

Protected function Virtual

void

 

RewireOldPinsToNewPins

(
    TArray< UEdGraphPin* >& InOld...,
    TArray< UEdGraphPin* >& InNew...
)

Wire-up new pins given old pin wiring

Protected function

void

 

SetColorFromModel

(
    const FLinearColor& InColor
)

Sets the body + title color from a color provided by the model

Public function

void

 

SetDimensions

(
    const FVector2D& InDimensions
)

Set the cached dimensions of this node

Protected function

void

 

SetupPinDefaultsFromModel

(
    UEdGraphPin* Pin
)

Copies default values from underlying properties into pin defaults, for editing

Overridden from UEdGraphNode

Name Description

Public function Virtual

void

 

AllocateDefaultPins()

Allocate default pins for a given node, based only the NodeType, which should already be filled in.

Public function Virtual

void

 

AutowireNewNode

(
    UEdGraphPin* FromPin
)

Autowire a newly created node.

Public function Virtual Const

bool

 

CanCreateUnderSpecifiedSchema

(
    const UEdGraphSchema* Schema
)

Determine if this node can be created under the specified schema

Public function Virtual

void

 

DestroyNode()

Destroy the specified node

Public function Virtual Const

FEdGraphNode...

 

GetDeprecationResponse

(
    EEdGraphNodeDeprecationType Depreca...
)

Returns the response to use when reporting a deprecation.

Public function Virtual Const

FSlateIcon

 

GetIconAndTint

(
    FLinearColor& OutColor
)

Public function Virtual Const

FLinearColor

 

GetNodeBodyTintColor()

Gets the draw color of a node's body tine

Public function Virtual Const

void

 

GetNodeContextMenuActions

(
    UToolMenu* Menu,
    UGraphNodeContextMenuContext* ...
)

Gets a list of actions that can be done to this particular node

Public function Virtual Const

FText

 

GetNodeTitle

(
    ENodeTitleType::Type TitleType
)

Gets the name of this node, shown in title bar

Public function Virtual Const

FLinearColor

 

GetNodeTitleColor()

Gets the draw color of a node's title bar

Public function Virtual Const

FText

 

GetTooltipText()

Gets the tooltip to display when over the node

Public function Virtual Const

bool

 

IsDeprecated()

Returns true if this node is deprecated.

Public function Virtual

void

 

PinDefaultValueChanged

(
    UEdGraphPin* Pin
)

Called when the DefaultValue of one of the pins of this node is changed in the editor

Public function Virtual

void

 

ReconstructNode()

Refresh the connectors on a node, preserving as many connections as it can.

Public function Virtual Const

bool

 

ShouldDrawNodeAsControlPointOnly

(
    int32& OutInputPinIndex,
    int32& OutOutputPinIndex
)

Returns whether to draw this node as a control point only (knot/reroute node).

Public function Virtual Const

bool

 

SupportsCommentBubble()

Returns true if this node supports comment bubbles

Overridden from UObject

Name Description

Public function Virtual Const

bool

 

IsSelectedInEditor()

Test the selection state of a UObject

Typedefs

Name

Description

FNodeTitleDirtied

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