FCurveEditor

Unreal Engine C++ API Reference > Editor > CurveEditor

Inheritance Hierarchy

References

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

Syntax

class FCurveEditor :  
    public [FEditorUndoClient](API\Editor\UnrealEd\FEditorUndoClient),  
    public [TSharedFromThis< FCurveEditor >](API\Runtime\Core\Templates\TSharedFromThis)  

Variables

Type Name Description
uint32 ActiveCurvesSerialNumber A serial number that is incremented any time the currently active set of curves are changed
TOptional< FCur... ActiveTool The currently active tool if any.
FCurveEditorAxi... AxisSnapMetrics Track which axis UI movements should be snapped to (where applicable) based on limitations imposed by the UI.
bool bBoundTransformUpdatesSuppressed Should attempts to update the bounds of each curve be ignored? This allows tools to keep the bounds from being automatically updated each frame which allows Normalized views to push past their boundaries without the normalization ratio changing per-frame as you drag.
TUniquePtr< ICu... Bounds Curve editor bounds implementation
TArray< TUnique... BufferedCurves Buffered Curves.
TSharedPtr< FUI... CommandList UI command list of actions mapped to this curve editor
TMap< FCurveMod... CurveData Map from curve model ID to the actual curve model
TAttribute< FKe... DefaultKeyAttributes Attribute used for determining default attributes to apply to a newly create key
TArray< TShared... EditorExtensions List of editor extensions we have initialized.
TAttribute< TOp... FixedGridSpacingAttribute Attribute used to retrieve the current value-axis grid line state
TAttribute< FTe... GridLineLabelFormatXAttribute Grid line label text format strings for the X and Y axis
TAttribute< FTe... GridLineLabelFormatYAttribute  
TAttribute< boo... InputSnapEnabledAttribute Attribute used to determine if we should snap input values
TAttribute< FFr... InputSnapRateAttribute Attribute used to retrieve the current input snap rate (also used for display)
TAttribute< dou... InputZoomToFitPadding Padding applied to zoom-to-fit the input
FOnActiveToolCh... OnActiveToolChangedDelegate Delegate that is invoked when a tool becomes active. Also fired when the tool goes inactive.
FOnCurveArrayCh... OnCurveArrayChanged Delegate that's broadcast when the curve display changes.
FOnSetBoolean OnInputSnapEnabledChanged Delegate that is invoked when the input snapping has been enabled/disabled
FOnSetBoolean OnOutputSnapEnabledChanged Delegate that is invoked when the output snapping has been enabled/disabled
TAttribute< boo... OutputSnapEnabledAttribute Attribute used to determine if we should snap output values
TAttribute< dou... OutputZoomToFitPadding Padding applied to zoom-to-fit the output
TSet< FCurveMod... PinnedCurves Set of pinned curve models
FCurveEditorSel... Selection Container holding the current key/tangent selection
UCurveEditorSet... Settings Curve editor settings object
int32 SuspendBroadcastCount Counter to suspend broadcasting of changed delegates
TMap< FCurveEdi... ToolExtensions List of tool extensions we have initialized.
FCurveEditorTre... Tree Hierarchical information pertaining to curve data
TMap< FCurveMod... TreeIDByCurveID Map from curve model ID to its originating tree item
TWeakPtr< SCurv... WeakPanel  
TWeakPtr< ITime... WeakTimeSliderController Optional external Time Slider controller to sync with. Enables some additional functionality.
TWeakPtr< SCurv... WeakView  

Constructors

Type Name Description
  FCurveEditor () Constructor
  FCurveEditor ( const FCurveEditor& ) Non-copyable (shared ptr semantics)

Destructors

Type Name Description
  ~FCurveEditor ()  

Functions

Type Name Description
void AddBufferedCurves ( const TSet< FCurveModelID >& InCur... ) Create a copy of the specified set of curves.
FCurveModelI... AddCurve ( TUniquePtr< FCurveModel >&& InCurv... ) Add a new curve to this editor
FCurveModelI... AddCurveForTreeItem ( TUniquePtr< FCurveModel >&& InCurv..., FCurveEditorTreeItemID TreeItemID ) Add a new curve to this editor
FCurveEditor... AddTool ( TUniquePtr< ICurveEditorToolExtensi... )  
FCurveEditor... AddTreeItem ( FCurveEditorTreeItemID ParentID ) Add a new tree item to this curve editor
bool ApplyBufferedCurves ( const TSet< FCurveModelID >& InCur..., const bool bSwapBufferCurves ) Attempts to apply the buffered curve to the passed in curve set. Returns true on success.
void ApplyBufferedCurveToTarget ( const IBufferedCurveModel* Buf..., FCurveModel* TargetCurve ) Apply a specific buffered curve to a specific target curve.
bool AreBoundTransformUpdatesSuppressed ()  
void BindCommands () Bind UI commands that this curve editor responds to
void BroadcastCurveChanged ( FCurveModel* InCurve )  
bool CanFlattenOrStraightenSelection () Do we currently have keys to flatten or straighten?
bool CanPaste ( const FString& TextToImport ) Returns whether the current clipboard contains objects which CurveEditor can paste
void ClearSelectionRange ()  
void ConstructXGridLines ( TArray< float >& MajorGridLines, TArray< float >& MinorGridLines, TArray< FText >* MajorGridLabe... ) Construct grid lines along the current display frame rate or time-base
bool CopyBufferCurveToCurveID ( const UCurveEditorCopyableCurveKeys..., const FCurveModelID InTargetCurve, TOptional< double > InTimeOffset, const bool bInAddToSelection, const bool bInOverwriteRange )  
void CopySelection () Copy the currently selected keys
void CutSelection () Cut the currently selected keys
void DeleteSelection () Delete the currently selected keys
FCurveModel ... FindCurve ( FCurveModelID CurveID ) Find a curve by its ID
const SCurve... FindFirstInteractiveView ( FCurveModelID InCurveID )  
const FCurve... FindTreeItem ( FCurveEditorTreeItemID ItemID ) Finds a tree item from its ID
FCurveEditor... FindTreeItem ( FCurveEditorTreeItemID ItemID ) Finds a tree item from its ID
void FlattenSelection () Flatten the tangents on the selected keys
uint32 GetActiveCurvesSerialNumber () Retrieve a serial number that is incremented any time a curve is added or removed
FCurveEditor... GetAxisSnap () Returned the cached struct for snapping editing movement to a specific axis based on user preferences.
ICurveEditor... GetBounds () Retrieve the current curve editor bounds implementation
const ICurve... GetBounds () Retrieve the current curve editor bounds implementation
const TArray... GetBufferedCurves () Return the array of buffered curves
void GetChildCurveModelIDs ( const FCurveEditorTreeItemID TreeIt..., TSet< FCurveModelID >& CurveModelI... )  
TSharedPtr< ... GetCommands () Retrieve this curve editor's command list
ICurveEditor... GetCurrentTool () Attempts to get the currently active tool.
const TMap< ... GetCurves () Access all the curves currently contained in the Curve Editor regardless of visibility.
FCurveSnapMe... GetCurveSnapMetrics ( FCurveModelID CurveModel ) Generate a utility struct for snapping values
TAttribute< ... GetDefaultKeyAttribute () Attribute used for determining default attributes to apply to a newly create key
TAttribute< ... GetDefaultKeyAttributes ()  
TSet< FCurve... GetEditedCurves ()  
const TArray... GetEditorExtensions ()  
TAttribute< ... GetGridLineLabelFormatXAttribute ()  
TAttribute< ... GetGridLineLabelFormatYAttribute ()  
void GetGridLinesX ( TArray< float >& MajorGridLines, TArray< float >& MinorGridLines, TArray< FText >* MajorGridLabe... ) Called by SCurveEditorPanel to determine where to draw grid lines along the X-axis.
TOptional< f... GetGridSpacing () Returns the value grid line spacing state
int32 GetNumBufferedCurves () Return the number of stored Buffered Curves.
TSharedPtr< ... GetPanel ()  
FCurveEditor... GetPanelInputSpace ()  
const TSet< ... GetPinnedCurves ()  
const TArray... GetRootTreeItems () Get const access to the entire set of root tree items
FCurveEditor... GetSelection ()  
TSet< FCurve... GetSelectionFromTreeAndKeys () Return the curve model IDs that are selected in the tree or have selected keys
UCurveEditor... GetSettings () Retrieve this curve editor's settings
int32 GetSupportedTangentTypes ()  
TSet< FCurve... GetTargetCurvesForPaste ()  
TSharedPtr< ... GetTimeSliderController () Retrieve the optional Time Slider Controller that this Curve Editor may be sync'd with.
const TMap< ... GetToolExtensions ()  
const FCurve... GetTree () Access the curve editor tree.
FCurveEditor... GetTree () Access the curve editor tree.
FCurveEditor... GetTreeIDFromCurveID ( FCurveModelID CurveID ) Find a tree ID id associated with a CurveModelID
FCurveEditor... GetTreeItem ( FCurveEditorTreeItemID ItemID ) Retrieve a tree item from its ID
const FCurve... GetTreeItem ( FCurveEditorTreeItemID ItemID ) Retrieve a tree item from its ID
const TMap< ... GetTreeSelection () Retrieve the current tree selection
ECurveEditor... GetTreeSelectionState ( FCurveEditorTreeItemID TreeItemID ) Check whether this tree item is selected
TSharedPtr< ... GetView ()  
void ImportCopyBufferFromText ( const FString& TextToImport, TArray< UCurveEditorCopyBuffer*... )  
void InitCurveEditor ( const FCurveEditorInitParams& InIn... )  
bool IsActiveBufferedCurve ( const TUniquePtr< IBufferedCurveMod... ) Returns whether the buffered curve is to be acted on, ie. selected, in the tree view or with selected keys
bool IsBroadcasting ()  
bool IsCurvePinned ( FCurveModelID InCurveID )  
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?
bool IsInputSnappingEnabled () Check whether keys should be snapped to the input display rate when dragging around
bool IsOutputSnappingEnabled () Check whether keys should be snapped to the output snap interval when dragging around
bool IsToolActive ( const FCurveEditorToolID InToolID ) Returns true of the specified tool is currently active.
void JumpToEnd ()  
void JumpToStart ()  
void MakeToolActive ( const FCurveEditorToolID InToolID ) Attempts to make the specified tool the active tool.
void OnCustomColorsChanged ()  
void PasteKeys ( TSet< FCurveModelID > CurveModelIDs, const bool bInOverwriteRange ) Paste keys
void PinCurve ( FCurveModelID InCurveID )  
void RemoveAllCurves () Remove all curves from this editor
void RemoveAllTreeItems () Remove all tree items from the curve editor
void RemoveCurve ( FCurveModelID InCurveID ) Remove a curve from this editor.
void RemoveFromTreeSelection ( TArrayView< const FCurveEditorTreeI... ) Removes items from the current tree selection.
void RemoveTreeItem ( FCurveEditorTreeItemID ItemID ) Remove a tree item from the curve editor
void ResetMinMaxes ()  
void ResumeBroadcast ()  
void SelectAllKeys () Selection
void SelectBackward ()  
void SelectForward ()  
void SelectNone ()  
void SetAxisSnap ( const FCurveEditorAxisSnap& InAxis... )  
void SetBounds ( TUniquePtr< ICurveEditorBounds >&&... ) Assign a new bounds container to this curve editor
void SetCurveColorsForSelected () Pick a curve color and set on selected
void SetPanel ( TSharedPtr< SCurveEditorPanel > InP... )  
void SetRandomCurveColorsForSelected () Set random curve colors
void SetSelectionRangeEnd ()  
void SetSelectionRangeStart () Selection range for ie. looping playback
void SetTimeSliderController ( TSharedPtr< ITimeSliderController >... ) Sets a Time Slider controller for this Curve Editor to be sync'd against. Can be null.
void SetTreeSelection ( TArray< FCurveEditorTreeItemID >&&... ) Set the tree selection directly
void SetView ( TSharedPtr< SCurveEditorView > InPa... )  
bool ShouldAutoFrame () Check whether this curve editor can automatically zoom to the current selection
void SnapToSelectedKey () Snap time to the first selected key
void StepBackward ()  
void StepForward () Step forward/backward, jump to start/end
void StepToNextKey () Step to next or previous key from the current time
void StepToPreviousKey ()  
void StraightenSelection () Straighten the tangents on the selected keys
void SuppressBoundTransformUpdates ( bool bSuppress )  
void SuspendBroadcast () Suspend or resume broadcast of curve array changing
void ToggleExpandCollapseNodes ( bool bRecursive ) Toggle the expansion state of the selected nodes or all nodes if none selected
void ToggleInputSnapping ()  
void ToggleOutputSnapping ()  
void TranslateSelectedKeys ( double SecondsToAdd ) Nudge left or right
void TranslateSelectedKeysLeft () Nudge left or right
void TranslateSelectedKeysRight () Nudge left or right
void UnpinCurve ( FCurveModelID InCurveID )  
void UpdateGeometry ( const FGeometry& CurrentGeometry ) Called by SCurveEditorPanel to update the allocated geometry for this curve editor.
void ZoomToFit ( EAxisList::Type Axes ) Zoom the curve editor to fit all the selected curves (or all curves if none selected)
void ZoomToFitAll ( EAxisList::Type Axes ) Zoom the curve editor to fit all the currently visible curves
void ZoomToFitCurves ( TArrayView< const FCurveModelID > C..., EAxisList::Type Axes ) Zoom the curve editor to fit the requested curves.
void ZoomToFitInternal ( EAxisList::Type Axes, const TMap< FCurveModelID, FKeyHand... ) Internal zoom to fit implementation
void ZoomToFitSelection ( EAxisList::Type Axes ) Zoom the curve editor to fit all the current key selection.

Overridden from FEditorUndoClient

Type Name Description
void PostRedo ( bool bSuccess ) Signal that client should run any PostRedo code
void PostUndo ( bool bSuccess ) FEditorUndoClient.

Operators

Type Name Description
FCurveEditor... operator= ( const FCurveEditor& )  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library