1. Epic GamesDeveloper
  3. FCurveEditor

FCurveEditor

API > API/Editor > API/Editor/CurveEditor

Inheritance Hierarchy

References

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

Syntax

class FCurveEditor :  
    public FEditorUndoClient,  
    public TSharedFromThis< FCurveEditor >

Variables

  Type Name Description
Protected variable uint32 ActiveCurvesSerialNumber A serial number that is incremented any time the currently active set of curves are changed
Protected variable TOptional< FCurveEditorToolID > ActiveTool The currently active tool if any.
Protected variable FCurveEditorAxisSnap AxisSnapMetrics Track which axis UI movements should be snapped to (where applicable) based on limitations imposed by the UI.
Protected variable 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.
Protected variable TUniquePtr< ICurveEditorBounds > Bounds Curve editor bounds implementation
Protected variable TArray< TUniquePtr< IBufferedCurveModel > > BufferedCurves Buffered Curves.
Protected variable TSharedPtr< FUICommandList > CommandList UI command list of actions mapped to this curve editor
Protected variable TMap< FCurveModelID, TUniquePtr< FCurveModel > > CurveData Map from curve model ID to the actual curve model
Public variable TAttribute< FKeyAttributes > DefaultKeyAttributes Attribute used for determining default attributes to apply to a newly create key
Protected variable TArray< TSharedRef< ICurveEditorExtension > > EditorExtensions List of editor extensions we have initialized.
Public variable TAttribute< TOptional< float > > FixedGridSpacingAttribute Attribute used to retrieve the current value-axis grid line state
Public variable TAttribute< FText > GridLineLabelFormatXAttribute Grid line label text format strings for the X and Y axis
Public variable TAttribute< FText > GridLineLabelFormatYAttribute  
Public variable TAttribute< bool > InputSnapEnabledAttribute Attribute used to determine if we should snap input values
Public variable TAttribute< FFrameRate > InputSnapRateAttribute Attribute used to retrieve the current input snap rate (also used for display)
Public variable TAttribute< double > InputZoomToFitPadding Padding applied to zoom-to-fit the input
Public variable FOnActiveToolChanged OnActiveToolChangedDelegate Delegate that is invoked when a tool becomes active. Also fired when the tool goes inactive.
Public variable FOnCurveArrayChanged OnCurveArrayChanged Delegate that's broadcast when the curve display changes.
Public variable FOnSetBoolean OnInputSnapEnabledChanged Delegate that is invoked when the input snapping has been enabled/disabled
Public variable FOnSetBoolean OnOutputSnapEnabledChanged Delegate that is invoked when the output snapping has been enabled/disabled
Public variable TAttribute< bool > OutputSnapEnabledAttribute Attribute used to determine if we should snap output values
Public variable TAttribute< double > OutputZoomToFitPadding Padding applied to zoom-to-fit the output
Protected variable TSet< FCurveModelID > PinnedCurves Set of pinned curve models
Public variable FCurveEditorSelection Selection Container holding the current key/tangent selection
Protected variable UCurveEditorSettings * Settings Curve editor settings object
Protected variable int32 SuspendBroadcastCount Counter to suspend broadcasting of changed delegates
Protected variable TMap< FCurveEditorToolID, TUniquePtr< ICurveEditorToolExtension > > ToolExtensions List of tool extensions we have initialized.
Protected variable FCurveEditorTree Tree Hierarchical information pertaining to curve data
Protected variable TMap< FCurveModelID, FCurveEditorTreeItemID > TreeIDByCurveID Map from curve model ID to its originating tree item
Protected variable TWeakPtr< SCurveEditorPanel > WeakPanel  
Protected variable TWeakPtr< ITimeSliderController > WeakTimeSliderController Optional external Time Slider controller to sync with. Enables some additional functionality.
Protected variable TWeakPtr< SCurveEditorView > WeakView  

Constructors

  Type Name Description
Public function   Constructor
Public function   Non-copyable (shared ptr semantics)

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddBufferedCurves ( const TSet< FCurveModelID >& InCurves
)

 Create a copy of the specified set of curves.
Public function FCurveModelID

AddCurve ( TUniquePtr< FCurveModel >&& InCurve
)

 Add a new curve to this editor
Public function FCurveModelID Add a new curve to this editor
Public function FCurveEditorToolID  
Public function FCurveEditorTreeItem * Add a new tree item to this curve editor
Public function 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.
Protected function void

ApplyBufferedCurveToTarget ( const IBufferedCurveModel* BufferedCurve,
FCurveModel* TargetCurve
)

 Apply a specific buffered curve to a specific target curve.
Public function Const bool  
Public function void Bind UI commands that this curve editor responds to
Public function void  
Public function Const bool Do we currently have keys to flatten or straighten?
Public function Const bool

CanPaste ( const FString& TextToImport
)

 Returns whether the current clipboard contains objects which CurveEditor can paste
Public function void  
Protected function Const void

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

 Construct grid lines along the current display frame rate or time-base
Protected function bool

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

  
Public function Const void Copy the currently selected keys
Public function void Cut the currently selected keys
Public function void Delete the currently selected keys
Public function Const FCurveModel *

FindCurve ( FCurveModelID CurveID
)

 Find a curve by its ID
Public function Const const SCurveEditorView *  
Public function Const const FCurveEditorTreeItem * Finds a tree item from its ID
Public function FCurveEditorTreeItem * Finds a tree item from its ID
Public function void Flatten the tangents on the selected keys
Public function Const uint32 Retrieve a serial number that is incremented any time a curve is added or removed
Public function Const FCurveEditorAxisSnap Returned the cached struct for snapping editing movement to a specific axis based on user preferences.
Public function ICurveEditorBounds & Retrieve the current curve editor bounds implementation
Public function Const const ICurveEditorBounds & Retrieve the current curve editor bounds implementation
Public function Const const TArray< TUniquePtr< IBufferedCurveModel > > & Return the array of buffered curves
Protected function Const void

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

  
Public function Const TSharedPtr< FUICommandList > Retrieve this curve editor's command list
Public function Const ICurveEditorToolExtension * Attempts to get the currently active tool.
Public function Const const TMap< FCurveModelID, TUniquePtr< FCurveModel > > & Access all the curves currently contained in the Curve Editor regardless of visibility.
Public function Const FCurveSnapMetrics Generate a utility struct for snapping values
Public function Const TAttribute< FKeyAttributes > Attribute used for determining default attributes to apply to a newly create key
Public function Const TAttribute< FKeyAttributes >  
Public function Const TSet< FCurveModelID >  
Public function Const const TArray< TSharedRef< ICurveEditorExtension > >  
Public function Const TAttribute< FText >  
Public function Const TAttribute< FText >  
Public function Virtual Const void

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

 Called by SCurveEditorPanel to determine where to draw grid lines along the X-axis.
Public function Const TOptional< float > Returns the value grid line spacing state
Public function Const int32 Return the number of stored Buffered Curves.
Public function Const TSharedPtr< SCurveEditorPanel >  
Public function Const FCurveEditorScreenSpaceH  
Public function Const const TSet< FCurveModelID > &  
Public function Const const TArray< FCurveEditorTreeItemID > & Get const access to the entire set of root tree items
Public function FCurveEditorSelection &  
Public function Const TSet< FCurveModelID > Return the curve model IDs that are selected in the tree or have selected keys
Public function Const UCurveEditorSettings * Retrieve this curve editor's settings
Public function Virtual int32  
Protected function Const TSet< FCurveModelID >  
Public function Const TSharedPtr< ITimeSliderController > Retrieve the optional Time Slider Controller that this Curve Editor may be sync'd with.
Public function Const const TMap< FCurveEditorToolID, TUniquePtr< ICurveEditorToolExtension > > &  
Public function Const const FCurveEditorTree *

GetTree ()

 Access the curve editor tree.
Public function FCurveEditorTree *

GetTree ()

 Access the curve editor tree.
Public function Const FCurveEditorTreeItemID Find a tree ID id associated with a CurveModelID
Public function FCurveEditorTreeItem & Retrieve a tree item from its ID
Public function Const const FCurveEditorTreeItem & Retrieve a tree item from its ID
Public function Const const TMap< FCurveEditorTreeItemID, ECurveEditorTreeSelectionState > & Retrieve the current tree selection
Public function Const ECurveEditorTreeSelectionState Check whether this tree item is selected
Public function Const TSharedPtr< SCurveEditorView >

GetView ()

  
Protected function Const void

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

  
Public function void

InitCurveEditor ( const FCurveEditorInitParams& InInitParams
)

  
Public function Const bool Returns whether the buffered curve is to be acted on, ie. selected, in the tree view or with selected keys
Public function bool  
Public function Const bool  
Public function Const bool 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?
Public function Const bool Check whether keys should be snapped to the input display rate when dragging around
Public function Const bool Check whether keys should be snapped to the output snap interval when dragging around
Public function Const bool

IsToolActive ( const FCurveEditorToolID InToolID
)

 Returns true of the specified tool is currently active.
Public function void  
Public function void  
Public function void

MakeToolActive ( const FCurveEditorToolID InToolID
)

 Attempts to make the specified tool the active tool.
Protected function void  
Public function void

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

 Paste keys
Public function void

PinCurve ( FCurveModelID InCurveID
)

  
Public function void Remove all curves from this editor
Public function void Remove all tree items from the curve editor
Public function void

RemoveCurve ( FCurveModelID InCurveID
)

 Remove a curve from this editor.
Public function void Removes items from the current tree selection.
Public function void Remove a tree item from the curve editor
Public function void  
Public function void  
Public function void Selection
Public function void  
Public function void  
Public function void  
Public function void

SetAxisSnap ( const FCurveEditorAxisSnap& InAxisSnap
)

  
Public function void Assign a new bounds container to this curve editor
Public function void Pick a curve color and set on selected
Public function void  
Public function void Set random curve colors
Public function void  
Public function void Selection range for ie. looping playback
Public function void Sets a Time Slider controller for this Curve Editor to be sync'd against. Can be null.
Public function void Set the tree selection directly
Public function void  
Public function Const bool Check whether this curve editor can automatically zoom to the current selection
Public function void Snap time to the first selected key
Public function void  
Public function void Step forward/backward, jump to start/end
Public function void Step to next or previous key from the current time
Public function void  
Public function void Straighten the tangents on the selected keys
Public function void

SuppressBoundTransformUpdates ( bool bSuppress
)

  
Public function void Suspend or resume broadcast of curve array changing
Public function void

ToggleExpandCollapseNodes ( bool bRecursive
)

 Toggle the expansion state of the selected nodes or all nodes if none selected
Public function void  
Public function void  
Public function void

TranslateSelectedKeys ( double SecondsToAdd
)

 Nudge left or right
Public function void Nudge left or right
Public function void Nudge left or right
Public function void

UnpinCurve ( FCurveModelID InCurveID
)

  
Public function void

UpdateGeometry ( const FGeometry& CurrentGeometry
)

 Called by SCurveEditorPanel to update the allocated geometry for this curve editor.
Public function void Zoom the curve editor to fit all the selected curves (or all curves if none selected)
Public function void Zoom the curve editor to fit all the currently visible curves
Public function void

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

 Zoom the curve editor to fit the requested curves.
Protected function void Internal zoom to fit implementation
Public function void Zoom the curve editor to fit all the current key selection.

Overridden from FEditorUndoClient

  Type Name Description
Public function Virtual void

PostRedo ( bool bSuccess
)

 Signal that client should run any PostRedo code
Public function Virtual void

PostUndo ( bool bSuccess
)

 FEditorUndoClient.

Operators

  Type Name Description
Public function FCurveEditor &

operator= ( const FCurveEditor&
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page