1. Epic GamesDeveloper
  3. FMovieSceneDirectorBlueprintEndpointCustomization

FMovieSceneDirectorBlueprintEndpointCustomization

Base class for details view customizations that operate on sequence director blueprint endpoints.

API > API/Editor > API/Editor/MovieSceneTools

Base class for details view customizations that operate on sequence director blueprint endpoints.

   
Name FMovieSceneDirectorBlueprintEndpointCustomization
Type class
Header File /Engine/Source/Editor/MovieSceneTools/Public/MovieSceneDirectorBlueprintEndpointCustomization.h
Include Path #include "MovieSceneDirectorBlueprintEndpointCustomization.h"

Syntax

class FMovieSceneDirectorBlueprintEndpointCustomization : public IPropertyTypeCustomization

Implements Interfaces

Derived Classes

Structs

Name Remarks
FSequenceData  
FWellKnownParameterCandidates Structure specifying candidate pins for a given "well-known parameter".
FWellKnownParameterMetadata User-interface information for "well-known parameters", i.e. parameters that can be bound to values provided by the underlying system, as opposed to values entered by the user.

Typedefs

Name Type Remarks Include Path
FPayloadVariableMap TMap< FName, FMovieSceneDirectorBlueprintVariableValue, TInlineSetAllocator< 8 > >   MovieSceneDirectorBlueprintEndpointCustomization.h
FSequenceDataMap TMap< UMovieSceneSequence *, FSequenceData >   MovieSceneDirectorBlueprintEndpointCustomization.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedCommonEndpoint TWeakObjectPtr< UK2Node_FunctionEntry > A cache of the common endpoint that is only used when the menu is open to avoid re-computing it every frame. MovieSceneDirectorBlueprintEndpointCustomization.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CreateEndpoint()

 Creates a single new endpoint represented by this property handle. MovieSceneDirectorBlueprintEndpointCustomization.h  

void HandleQuickBindActionSelected ( const TArray< TSharedPtr< FEdGraphSchemaAction > >& SelectedAction,
ESelectInfo::Type InSelectionType,
UBlueprint* Blueprint,
FMovieSceneDirectorBlueprintEndpointDefinition EndpointDefinition
)

 Called when a quick bind action has been selected MovieSceneDirectorBlueprintEndpointCustomization.h  

void PopulateQuickBindSubMenu ( FMenuBuilder& MenuBuilder,
UMovieSceneSequence* Sequence,
FOnQuickBindActionSelected InOnQuickBindActionSelected
)

 Generate the content of the quick bind sub-menu dropdown (shown if the endpoint is not already bound) MovieSceneDirectorBlueprintEndpointCustomization.h  

void SetPropertyHandle ( TSharedPtr< IPropertyHandle > InPropertyHandle
)

 Set the property handle to use for customization. MovieSceneDirectorBlueprintEndpointCustomization.h  

void SetRawData ( const TArray< void* >& InRawData
)

 Set the raw data to use for customization. MovieSceneDirectorBlueprintEndpointCustomization.h  

Overridden from IPropertyTypeCustomization

Name Remarks Include Path Unreal Specifiers

virtual void CustomizeChildren ( TSharedRef< IPropertyHandle > InPropertyHandle,
IDetailChildrenBuilder& ChildBuilder,
IPropertyTypeCustomizationUtils& CustomizationUtils
)

   MovieSceneDirectorBlueprintEndpointCustomization.h  

virtual void CustomizeHeader ( TSharedRef< IPropertyHandle > InPropertyHandle,
FDetailWidgetRow& HeaderRow,
IPropertyTypeCustomizationUtils& CustomizationUtils
)

   MovieSceneDirectorBlueprintEndpointCustomization.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ClearEndpoint ()

 Clear the endpoint represented by this property handle. MovieSceneDirectorBlueprintEndpointCustomization.h  

virtual bool CreateNewCategoryForPayloadVariables()

   MovieSceneDirectorBlueprintEndpointCustomization.h  

UK2Node * FindEndpoint ( UMovieSceneSequence* Sequence,
UBlueprint* Blueprint,
UObject* EditObject,
void* RawData
) const

 Called to find the endpoint node in the director blueprint. MovieSceneDirectorBlueprintEndpointCustomization.h  

UK2Node * FindEndpoint ( UObject* EditObject,
void* RawData
) const

 Find the endpoint node in the director blueprint. MovieSceneDirectorBlueprintEndpointCustomization.h  

void GatherSequenceData ( FSequenceDataMap& AllSequenceData
)

 Gather data for the sequences being edited. MovieSceneDirectorBlueprintEndpointCustomization.h  

FMovieSceneDirectorBlueprintEndpointDefinition GenerateEndpointDefinition ( UMovieSceneSequence* Sequence
)

 Generate endpoint definition for the sequence. MovieSceneDirectorBlueprintEndpointCustomization.h  

TArray< UK2Node * > GetAllValidEndpoints()

 Get all the endpoints of all the values in our property handle. MovieSceneDirectorBlueprintEndpointCustomization.h  

UK2Node * GetCommonEndpoint()

 Get the endpoint that is common to all the values in our property handle, or nullptr if they are not all the same. MovieSceneDirectorBlueprintEndpointCustomization.h  

UMovieSceneSequence * GetCommonSequence()

 Get the sequence that is common to all the values in our property handle, or nullptr if they are not all the same. MovieSceneDirectorBlueprintEndpointCustomization.h  

virtual void GetEditObjects ( TArray< UObject* >& OutObjects
) const

 Get all the objects that the endpoints reside within. MovieSceneDirectorBlueprintEndpointCustomization.h  

TSharedRef< SWidget > GetMenuContent()

 Generate the content of the main combo button menu dropdown MovieSceneDirectorBlueprintEndpointCustomization.h  

void GetPayloadVariables ( UObject* EditObject,
void* RawData,
FPayloadVariableMap& OutPayloadVariables
) const

 Gets the payload values to pass to the endpoint. MovieSceneDirectorBlueprintEndpointCustomization.h  

TSharedPtr< IPropertyHandle > GetPropertyHandle()

 Get the property handle for this customization. MovieSceneDirectorBlueprintEndpointCustomization.h  

TSharedPtr< IPropertyUtilities > GetPropertyUtilities()

 Get the property utilities for this customization. MovieSceneDirectorBlueprintEndpointCustomization.h  

virtual void GetWellKnownParameterCandidates ( UK2Node* Endpoint,
TArray< FWellKnownParameterCandidates >& OutCandidates
) const

 Get the pins that are candidates for any "well-known parameter". MovieSceneDirectorBlueprintEndpointCustomization.h  

virtual void GetWellKnownParameterPinNames ( UObject* EditObject,
void* RawData,
TArray< FName >& OutParameters
) const

 Get the pin names setup with "well-known parameters" for the currently edited objects. MovieSceneDirectorBlueprintEndpointCustomization.h  

void IterateEndpoints ( TFunctionRef< bool(UK2Node*)> Callback
) const

 Invoke a callback on all the endpoints. MovieSceneDirectorBlueprintEndpointCustomization.h  

void NavigateToDefinition()

 Navigate to the definition of the endpoint represented by this property handle. MovieSceneDirectorBlueprintEndpointCustomization.h  

virtual void OnCollectAllRebindActions ( UBlueprint* Blueprint,
FBlueprintActionMenuBuilder& MenuBuilder
)

 Collect blueprint actions for rebinding an already connected endpoint. MovieSceneDirectorBlueprintEndpointCustomization.h  

virtual void OnCollectQuickBindActions ( UBlueprint* Blueprint,
FBlueprintActionMenuBuilder& MenuBuilder
)

 Collect blueprint actions for quick-binding a non-connected endpoint. MovieSceneDirectorBlueprintEndpointCustomization.h  

void OnCreateEndpoint ( UMovieSceneSequence* Sequence,
UBlueprint* Blueprint,
const TArray< UObject* > EditObjects,
const TArray< void* > RawData,
const FMovieSceneDirectorBlueprintEndpointDefinition& EndpointDefinition,
UK2Node* NewEndpoint
)

 Called when an endpoint has been created. MovieSceneDirectorBlueprintEndpointCustomization.h  

void OnPayloadVariableChanged ( TSharedRef< FStructOnScope > InStructData,
TSharedPtr< IPropertyHandle > LocalVariableProperty
)

 Called when a payload variable property value is changed on the details panel MovieSceneDirectorBlueprintEndpointCustomization.h  

virtual bool OnRebindEndpoint ( UMovieSceneSequence* Sequence,
UBlueprint* Blueprint,
const TArray< UObject* > EditObjects,
const TArray< void* > RawData,
const FMovieSceneDirectorBlueprintEndpointDefinition& EndpointDefinition,
TSharedPtr< FEdGraphSchemaAction > Action
)

 Called when an endpoint was set and has been changed to another endpoint. MovieSceneDirectorBlueprintEndpointCustomization.h  

void OnSetEndpoint ( UMovieSceneSequence* Sequence,
UBlueprint* Blueprint,
const TArray< UObject* > EditObjects,
const TArray< void* > RawData,
const FMovieSceneDirectorBlueprintEndpointDefinition& EndpointDefinition,
UK2Node* NewEndpoint
)

 Called when an endpoint has been set. MovieSceneDirectorBlueprintEndpointCustomization.h  

void PopulateRebindSubMenu ( FMenuBuilder& MenuBuilder,
UMovieSceneSequence* Sequence
)

 Generate the content of the rebind sub-menu dropdown (shown if the endpoint is already bound) MovieSceneDirectorBlueprintEndpointCustomization.h  

void SetEndpoint ( const FMovieSceneDirectorBlueprintEndpointDefinition& EndpointDefinition,
UK2Node* NewEndpoint,
UK2Node* PayloadTemplate,
EAutoCreatePayload AutoCreatePayload
)

 Assigns the specified function entry to this property handle. MovieSceneDirectorBlueprintEndpointCustomization.h  

bool SetPayloadVariable ( UObject* EditObject,
void* RawData,
FName FieldName,
const FMovieSceneDirectorBlueprintVariableValue& NewVariableValue
)

 Sets a payload value to pass to the endpoint. MovieSceneDirectorBlueprintEndpointCustomization.h  

virtual bool SetWellKnownParameterPinName ( UObject* EditObject,
void* RawData,
int32 ParameterIndex,
FName BoundPinName
)

 Set the pin name for the given "well-known parameter". MovieSceneDirectorBlueprintEndpointCustomization.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page