1. Epic GamesDeveloper
  3. FCurveEditor

FCurveEditor

API > API/Editor > API/Editor/CurveEditor

   
Name FCurveEditor
Type class
Header File /Engine/Source/Editor/CurveEditor/Public/CurveEditor.h
Include Path #include "CurveEditor.h"

Syntax

class FCurveEditor :  
    public FEditorUndoClient,  
    public TSharedFromThis< FCurveEditor >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
Non-copyable (shared ptr semantics) CurveEditor.h  
Constructor CurveEditor.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FCurveEditor()

   CurveEditor.h  

Structs

Name Remarks
FCurveFlipRangeSettings Settings for Curve Flip dropdown menu selections

Enums

Public

Name Remarks
ECurveFlipDirection Curve flip direction types
ECurveFlipRangeType Curve Flip selection types

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
DefaultKeyAttributes TAttribute< FKeyAttributes > Attribute used for determining default attributes to apply to a newly create key CurveEditor.h  
FixedGridSpacingAttribute TAttribute< TOptional< float > > Attribute used to retrieve the current value-axis grid line state CurveEditor.h  
GridLineLabelFormatXAttribute TAttribute< FText > Grid line label text format strings for the X and Y axis CurveEditor.h  
GridLineLabelFormatYAttribute TAttribute< FText >   CurveEditor.h  
HorizontalCurveFlipRangeSettings FCurveFlipRangeSettings   CurveEditor.h  
InputSnapEnabledAttribute TAttribute< bool > Attribute used to determine if we should snap input values CurveEditor.h  
InputSnapRateAttribute TAttribute< FFrameRate > Attribute used to retrieve the current input snap rate (also used for display) CurveEditor.h  
InputZoomToFitPadding TAttribute< double > Padding applied to zoom-to-fit the input CurveEditor.h  
OnActiveToolChangedDelegate FOnActiveToolChanged Delegate that is invoked when a tool becomes active. Also fired when the tool goes inactive. CurveEditor.h  
OnCurveArrayChanged FOnCurveArrayChanged Delegate that's broadcast when the curve display changes. CurveEditor.h  
OnCurveColorsChangedDelegate FOnCurveColorsChanged Delegate that is invoked when the curve colors are changed. CurveEditor.h  
OnInputSnapEnabledChanged FOnSetBoolean Delegate that is invoked when the input snapping has been enabled/disabled CurveEditor.h  
OnOutputSnapEnabledChanged FOnSetBoolean Delegate that is invoked when the output snapping has been enabled/disabled CurveEditor.h  
OutputSnapEnabledAttribute TAttribute< bool > Attribute used to determine if we should snap output values CurveEditor.h  
OutputZoomToFitPadding TAttribute< double > Padding applied to zoom-to-fit the output CurveEditor.h  
Selection FCurveEditorSelection Container holding the current key/tangent selection CurveEditor.h  
VerticalCurveFlipRangeSettings FCurveFlipRangeSettings   CurveEditor.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedPhysicalSize FVector2D Cached physical size of the panel representing this editor CurveEditor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddAxis ( const FName& InIdentifier,
TSharedPtr< FCurveEditorAxis > InAxis
)

 Adds a new axis to this curve editor with the specified name. CurveEditor.h  

void AddBufferedCurves ( const TSet< FCurveModelID >& InCurves
)

 Create a copy of the specified set of curves. CurveEditor.h  

FCurveModelID AddCurve ( TUniquePtr< FCurveModel >&& InCurve
)

 Add a new curve to this editor CurveEditor.h  

FCurveModelID AddCurveForTreeItem ( TUniquePtr< FCurveModel >&& InCurve,
FCurveEditorTreeItemID TreeItemID
)

   CurveEditor.h  
  CurveEditor.h  

FCurveEditorTreeItem * AddTreeItem ( FCurveEditorTreeItemID ParentID
)

 Add a new tree item to this curve editor CurveEditor.h  

bool ApplyBufferedCurves ( const TSet< FCurveModelID >& InCurvesToApplyTo,
const bool bSwapBufferCurves
)

 Attempts to apply the buffered curve to the passed in curve set. Returns true on success. CurveEditor.h  

bool AreBoundTransformUpdatesSuppressed()

   CurveEditor.h  

void BindCommands()

 Bind UI commands that this curve editor responds to CurveEditor.h  

void BroadcastCurveChanged ( FCurveModel* InCurve
)

   CurveEditor.h  

bool CanFlattenOrStraightenSelection()

 Do we currently have keys to flatten or straighten? CurveEditor.h  

bool CanPaste ( const FString& TextToImport
) const

 Returns whether the current clipboard contains objects which CurveEditor can paste CurveEditor.h  

bool CanSmartSnapSelection()

   CurveEditor.h  

void ClearAxes()

 Remove all custom axes definitions CurveEditor.h  

void ClearSelectionRange()

   CurveEditor.h  

void CopySelection()

 Copy the currently selected keys CurveEditor.h  

void CutSelection()

 Cut the currently selected keys CurveEditor.h  

void DeleteSelection()

 Delete the currently selected keys CurveEditor.h  

TSharedPtr< FCurveEditorAxis > FindAxis ( const FName& InIdentifier
) const

 Find an axis by its ID CurveEditor.h  

FCurveModel * FindCurve ( FCurveModelID CurveID
) const

 Find a curve by its ID CurveEditor.h  

const SCurveEditorView * FindFirstInteractiveView ( FCurveModelID InCurveID
) const

   CurveEditor.h  
Finds a tree item from its ID CurveEditor.h  
Finds a tree item from its ID CurveEditor.h  

void FlattenSelection()

 Flatten the tangents on the selected keys CurveEditor.h  

void FlipCurve ( ECurveFlipDirection Direction
)

 Flip the selected curve horizontally or vertically CurveEditor.h  

uint32 GetActiveCurvesSerialNumber()

 Retrieve a serial number that is incremented any time a curve is added or removed CurveEditor.h  

FCurveEditorAxisSnap GetAxisSnap()

 Returned the cached struct for snapping editing movement to a specific axis based on user preferences. CurveEditor.h  
Retrieve the current curve editor bounds implementation CurveEditor.h  
Retrieve the current curve editor bounds implementation CurveEditor.h  

const TArray< TUniquePtr< IBufferedCurveModel > > & GetBufferedCurves()

 Return the array of buffered curves CurveEditor.h  

TSharedPtr< FUICommandList > GetCommands()

 Retrieve this curve editor's command list CurveEditor.h  
Attempts to get the currently active tool. CurveEditor.h  

const TMap< FCurveModelID, TUniquePtr< FCurveModel > > & GetCurves()

 Access all the curves currently contained in the Curve Editor regardless of visibility. CurveEditor.h  

FCurveSnapMetrics GetCurveSnapMetrics ( FCurveModelID CurveModel
) const

 Generate a utility struct for snapping values CurveEditor.h  

TAttribute< FKeyAttributes > GetDefaultKeyAttribute()

 Attribute used for determining default attributes to apply to a newly create key CurveEditor.h  

TAttribute< FKeyAttributes > GetDefaultKeyAttributes()

   CurveEditor.h  

TSet< FCurveModelID > GetEditedCurves()

   CurveEditor.h  

const TArray< TSharedRef< ICurveEditorExtension > > GetEditorExtensions()

   CurveEditor.h  

TAttribute< FText > GetGridLineLabelFormatXAttribute()

   CurveEditor.h  

TAttribute< FText > GetGridLineLabelFormatYAttribute()

   CurveEditor.h  

virtual void GetGridLinesX ( TArray< float >& MajorGridLines,
TArray< float >& MinorGridLines,
TArray< FText >* MajorGridLabels
) const

 Called by SCurveEditorPanel to determine where to draw grid lines along the X-axis. CurveEditor.h  

TOptional< float > GetGridSpacing()

 Returns the value grid line spacing state CurveEditor.h  

int32 GetNumBufferedCurves()

 Return the number of stored Buffered Curves. CurveEditor.h  
  CurveEditor.h  

FCurveEditorScreenSpaceH GetPanelInputSpace()

   CurveEditor.h  

const TSet< FCurveModelID > & GetPinnedCurves()

   CurveEditor.h  

const TArray< FCurveEditorTreeItemID > & GetRootTreeItems()

 Get const access to the entire set of root tree items CurveEditor.h  
  CurveEditor.h  
  CurveEditor.h  

TSet< FCurveModelID > GetSelectionFromTreeAndKeys()

 Return the curve model IDs that are selected in the tree or have selected keys CurveEditor.h  

UCurveEditorSettings * GetSettings()

 Retrieve this curve editor's settings CurveEditor.h  

virtual int32 GetSupportedTangentTypes()

   CurveEditor.h  

TSharedPtr< ITimeSliderController > GetTimeSliderController()

 Retrieve the optional Time Slider Controller that this Curve Editor may be sync'd with. CurveEditor.h  

TSharedPtr< UE::CurveEditor::FPromotedFilterContainer > GetToolbarPromotedFilters()

   CurveEditor.h  

const TMap< FCurveEditorToolID, TUniquePtr< ICurveEditorToolExtension > > & GetToolExtensions()

   CurveEditor.h  

UE::CurveEditor::FTransactionManager * GetTransactionManager()

   CurveEditor.h  
Access the curve editor tree. CurveEditor.h  
Access the curve editor tree. CurveEditor.h  

FCurveEditorTreeItemID GetTreeIDFromCurveID ( FCurveModelID CurveID
) const

 Find a tree ID id associated with a CurveModelID CurveEditor.h  
Retrieve a tree item from its ID CurveEditor.h  
Retrieve a tree item from its ID CurveEditor.h  

const TMap< FCurveEditorTreeItemID, ECurveEditorTreeSelectionState > & GetTreeSelection()

 Retrieve the current tree selection CurveEditor.h  

ECurveEditorTreeSelectionState GetTreeSelectionState ( FCurveEditorTreeItemID TreeItemID
) const

 Check whether this tree item is selected CurveEditor.h  
  CurveEditor.h  

const FCurveEditorZoomScaleConfig & GetZoomScaleConfig()

   CurveEditor.h  

void InitCurveEditor ( const FCurveEditorInitParams& InInitParams
)

   CurveEditor.h  

void InvertSelection()

   CurveEditor.h  

bool IsActiveBufferedCurve ( const TUniquePtr< IBufferedCurveModel >& BufferedCurve
) const

 Returns whether the buffered curve is to be acted on, ie. selected, in the tree view or with selected keys CurveEditor.h  

bool IsBroadcasting()

   CurveEditor.h  

bool IsCurvePinned ( FCurveModelID InCurveID
) const

   CurveEditor.h  

bool IsDoingDirectSelection()

 Whether or not we are are doign a direct selection, could be used to see why a curve model is being created or destroyed, by direct selection or by sequencer filtering? CurveEditor.h  

bool IsInputSnappingEnabled()

 Check whether keys should be snapped to the input display rate when dragging around CurveEditor.h  

bool IsOutputSnappingEnabled()

 Check whether keys should be snapped to the output snap interval when dragging around CurveEditor.h  

bool IsToolActive ( const FCurveEditorToolID InToolID
) const

 Returns true of the specified tool is currently active. CurveEditor.h  

void MakeToolActive ( const FCurveEditorToolID InToolID
)

 Attempts to make the specified tool the active tool. CurveEditor.h  

void MatchLastTangentToFirst ( bool bLastToFirst
)

 Sets the last keys tangents to match the first, if bFirstToLast is false do the opposite CurveEditor.h  

void PasteKeys ( TSet< FCurveModelID > CurveModelIDs,
const bool bInOverwriteRange
)

 Paste keys CurveEditor.h  
Pastes keys. CurveEditor.h  

void PinCurve ( FCurveModelID InCurveID
)

   CurveEditor.h  

virtual void PostRedo ( bool bSuccess
)

   CurveEditor.h  

virtual void PostUndo ( bool bSuccess
)

 FEditorUndoClient. CurveEditor.h  

void RemoveAllCurves()

 Remove all curves from this editor CurveEditor.h  

void RemoveAllTreeItems()

 Remove all tree items from the curve editor CurveEditor.h  

void RemoveAxis ( const FName& InIdentifier
)

 Remove the axis with the specified ID CurveEditor.h  

void RemoveCurve ( FCurveModelID InCurveID
)

 Remove a curve from this editor. CurveEditor.h  

void RemoveFromTreeSelection ( TArrayView< const FCurveEditorTreeItemID > TreeItems
)

 Removes items from the current tree selection. CurveEditor.h  

void RemoveTreeItem ( FCurveEditorTreeItemID ItemID
)

 Remove a tree item from the curve editor CurveEditor.h  

void ResetMinMaxes()

   CurveEditor.h  

void ResumeBroadcast()

   CurveEditor.h  

void SelectAllKeys()

 Selection CurveEditor.h  

void SelectBackward()

   CurveEditor.h  

void SelectForward()

   CurveEditor.h  

void SelectNone()

   CurveEditor.h  

void SetAxisSnap ( const FCurveEditorAxisSnap& InAxisSnap
)

   CurveEditor.h  

void SetBounds ( TUniquePtr< ICurveEditorBounds >&& InBounds
)

 Assign a new bounds container to this curve editor CurveEditor.h  

void SetCurveColorsForSelected()

 Pick a curve color and set on selected CurveEditor.h  

void SetPanel ( TSharedPtr< SCurveEditorPanel > InPanel
)

   CurveEditor.h  

void SetRandomCurveColorsForSelected()

 Set random curve colors CurveEditor.h  

void SetSelectionRangeEnd()

   CurveEditor.h  

void SetSelectionRangeStart()

 Selection range for ie. looping playback CurveEditor.h  

void SetTimeSliderController ( TSharedPtr< ITimeSliderController > InTimeSliderController
)

 Sets a Time Slider controller for this Curve Editor to be sync'd against. Can be null. CurveEditor.h  

void SetTreeSelection ( TArray< FCurveEditorTreeItemID >&& TreeItems
)

 Set the tree selection directly CurveEditor.h  

void SetView ( TSharedPtr< SCurveEditorView > InPanel
)

   CurveEditor.h  

bool ShouldAutoFrame()

 Check whether this curve editor can automatically zoom to the current selection CurveEditor.h  

void SmartSnapSelection()

 Snaps the selected keys to their nearest whole frames and positions them on the frame intersection with the frame. CurveEditor.h  

void SnapToSelectedKey()

 Snap time to the first selected key CurveEditor.h  

void StraightenSelection()

 Straighten the tangents on the selected keys CurveEditor.h  

void SuppressBoundTransformUpdates ( bool bSuppress
)

   CurveEditor.h  

void SuspendBroadcast()

 Suspend or resume broadcast of curve array changing CurveEditor.h  

void ToggleExpandCollapseNodes ( bool bRecursive
)

 Toggle the expansion state of the selected nodes or all nodes if none selected CurveEditor.h  

void ToggleInputSnapping()

   CurveEditor.h  

void ToggleOutputSnapping()

   CurveEditor.h  

void TranslateSelectedKeys ( double SecondsToAdd
)

 Nudge left or right CurveEditor.h  

void TranslateSelectedKeysLeft()

   CurveEditor.h  

void TranslateSelectedKeysRight()

   CurveEditor.h  

void UnpinCurve ( FCurveModelID InCurveID
)

   CurveEditor.h  

void UpdateGeometry ( const FGeometry& CurrentGeometry
)

 Called by SCurveEditorPanel to update the allocated geometry for this curve editor. CurveEditor.h  

void ZoomToFit ( EAxisList::Type Axes
)

 Zoom the curve editor to fit all the selected curves (or all curves if none selected) CurveEditor.h  

void ZoomToFitAll ( EAxisList::Type Axes
)

 Zoom the curve editor to fit all the currently visible curves CurveEditor.h  

void ZoomToFitCurves ( TArrayView< const FCurveModelID > CurveModelIDs,
EAxisList::Type Axes
)

 Zoom the curve editor to fit the requested curves. CurveEditor.h  
Zoom the curve editor to fit all the current key selection. CurveEditor.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ApplyBufferedCurveToTarget ( const IBufferedCurveModel* BufferedCurve,
FCurveModel* TargetCurve
)

 Apply a specific buffered curve to a specific target curve. CurveEditor.h  

void ConstructXGridLines ( TArray< float >& MajorGridLines,
TArray< float >& MinorGridLines,
TArray< FText >* MajorGridLabels
) const

 Construct grid lines along the current display frame rate or time-base CurveEditor.h  

bool CopyBufferCurveToCurveID ( const UCurveEditorCopyableCurveKeys* InSourceCurve,
const FCurveModelID InTargetCurve,
TOptional< double > InTimeOffset,
UE::CurveEditor::ECurveEditorPasteMode InMode,
UE::CurveEditor::ECurveEditorPasteFlags InFlags
)

   CurveEditor.h  

bool CopyBufferCurveToCurveID ( const UCurveEditorCopyableCurveKeys* InSourceCurve,
const FCurveModelID InTargetCurve,
TOptional< double > InTimeOffset,
const bool bInAddToSelection,
const bool bInOverwriteRange
)

   CurveEditor.h  

void GetChildCurveModelIDs ( const FCurveEditorTreeItemID TreeItemID,
TSet< FCurveModelID >& CurveModelIDs
) const

   CurveEditor.h  

TSet< FCurveModelID > GetTargetCurvesForPaste()

   CurveEditor.h  

void ImportCopyBufferFromText ( const FString& TextToImport,
TArray< UCurveEditorCopyBuffer* >& ImportedCopyBuffers
) const

   CurveEditor.h  

void OnAxisSnappingChanged()

   CurveEditor.h  

void OnCustomColorsChanged()

   CurveEditor.h  

void ZoomToFitInternal ( EAxisList::Type Axes,
const TMap< FCurveModelID, FKeyHandleSet >& CurveKeySet
)

 Internal zoom to fit implementation CurveEditor.h  

Static

Name Remarks Include Path Unreal Specifiers

static void FlipCurveHorizontal ( TArray< FKeyPosition >& AllKeyPositions,
TArray< FKeyAttributes >& AllKeyAttributes,
ECurveFlipRangeType RangeType,
float InRangeMin,
float InRangeMax,
double CurveMinTime,
double CurveMaxTime
)

   CurveEditor.h  

static void FlipCurveVertical ( TArray< FKeyPosition >& AllKeyPositions,
TArray< FKeyAttributes >& AllKeyAttributes,
ECurveFlipRangeType RangeType,
float InRangeMin,
float InRangeMax,
double CurveMinVal,
double CurveMaxVal
)

   CurveEditor.h  

Operators

Name Remarks Include Path Unreal Specifiers

FCurveEditor & operator= ( const FCurveEditor&
)

   CurveEditor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page