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

Inheritance Hierarchy

References

   
Module MovieSceneTools
Header /Engine/Source/Editor/MovieSceneTools/Public/MovieSceneDirectorBlueprintEndpointCustomization.h
Include #include "MovieSceneDirectorBlueprintEndpointCustomization.h"

Syntax

class FMovieSceneDirectorBlueprintEndpointCustomization : public IPropertyTypeCustomization

Remarks

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

Variables

  Type Name Description
Protected variable TSharedPtr< IPropertyHandle > PropertyHandle The property handle we're reflecting
Protected variable TArray< void * > PropertyRawData RawData taken either from the PropertyHandle, or manually passed into the customization for cases this is used as a helper.
Protected variable TSharedPtr< IPropertyUtilities > PropertyUtilities Property utilities for the property we're editing

Functions

  Type Name Description
Protected function void Clear the endpoint represented by this property handle.
Public function void Creates a single new endpoint represented by this property handle.
Protected function Virtual Const bool  
Public function Virtual void

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

  
Public function Virtual void

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

  
Protected function Const UK2Node *

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

 Called to find the endpoint node in the director blueprint.
Protected function Const UK2Node *

FindEndpoint ( UObject* EditObject,
void* RawData
)

 Find the endpoint node in the director blueprint.
Protected function void

GatherSequenceData ( FSequenceDataMap& AllSequenceData
)

 Gather data for the sequences being edited.
Protected function FMovieSceneDirectorBlueprintEndpointDefinition

GenerateEndpointDefinition ( UMovieSceneSequence* Sequence
)

 Generate endpoint definition for the sequence.
Protected function Const TArray< UK2Node * > Get all the endpoints of all the values in our property handle.
Protected function Const UK2Node * Get the endpoint that is common to all the values in our property handle, or nullptr if they are not all the same.
Protected function Const UMovieSceneSequence * Get the sequence that is common to all the values in our property handle, or nullptr if they are not all the same.
Protected function Virtual Const void

GetEditObjects ( TArray< UObject* >& OutObjects
)

 Get all the objects that the endpoints reside within.
Protected function TSharedRef< SWidget > Generate the content of the main combo button menu dropdown
Protected function Const void

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

 Gets the payload values to pass to the endpoint.
Protected function Const TSharedPtr< IPropertyHandle > Get the property handle for this customization.
Protected function Const TSharedPtr< IPropertyUtilities > Get the property utilities for this customization.
Protected function Virtual Const void

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

 Get the pins that are candidates for any "well-known parameter".
Protected function Virtual Const void

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

 Get the pin names setup with "well-known parameters" for the currently edited objects.
Public function void

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

 Called when a quick bind action has been selected
Protected function Const void

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

 Invoke a callback on all the endpoints.
Protected function void Navigate to the definition of the endpoint represented by this property handle.
Protected function Virtual void

OnCollectAllRebindActions ( UBlueprint* Blueprint,
FBlueprintActionMenuBuilder& MenuBuilder
)

 Collect blueprint actions for rebinding an already connected endpoint.
Protected function Virtual void

OnCollectQuickBindActions ( UBlueprint* Blueprint,
FBlueprintActionMenuBuilder& MenuBuilder
)

 Collect blueprint actions for quick-binding a non-connected endpoint.
Protected function 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.
Protected function void

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

 Called when a payload variable property value is changed on the details panel
Protected function 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.
Protected function 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.
Public function 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)
Protected function void

PopulateRebindSubMenu ( FMenuBuilder& MenuBuilder,
UMovieSceneSequence* Sequence
)

 Generate the content of the rebind sub-menu dropdown (shown if the endpoint is already bound)
Protected function void

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

 Assigns the specified function entry to this property handle.
Protected function bool

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

 Sets a payload value to pass to the endpoint.
Public function void

SetPropertyHandle ( TSharedPtr< IPropertyHandle > InPropertyHandle
)

 Set the property handle to use for customization.
Public function void

SetRawData ( const TArray< void* >& InRawData
)

 Set the raw data to use for customization.
Protected function Virtual bool

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

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

Classes

  Type Name Description
Protected struct FSequenceData    
Protected struct FWellKnownParameterCandidates Structure specifying candidate pins for a given "well-known parameter".  
Protected struct 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 Description
FPayloadVariableMap  
FSequenceDataMap  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page