1. Epic GamesDeveloper
  3. SCurveEditor

SCurveEditor

API > API/Editor > API/Editor/UnrealEd

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

Syntax

class SCurveEditor :  
    public SCompoundWidget ,  
    public FGCObject ,  
    public FEditorUndoClient

Inheritance Hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

~SCurveEditor()

 Destructor SCurveEditor.h  

Structs

Name Remarks
FArguments  
FSelectedCurveKey Used to track a key and the curve that owns it
FSelectedTangent Used to track a key and tangent

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bAllowAutoFrame bool Flag to allow auto framing SCurveEditor.h  
bAllowZoomOutput bool If we should allow zoom for output SCurveEditor.h  
bAlwaysDisplayColorCurves bool If we always show the color curves or allow the user to toggle this SCurveEditor.h  
bAlwaysHideGradientEditor bool If we always hide the gradient editor SCurveEditor.h  
bCanEditTrack bool Flag to enable/disable track editing SCurveEditor.h  
bDrawCurve bool If we should draw the curve SCurveEditor.h  
bDrawInputGridNumbers bool Whether or not to draw the numbers for the input grid. SCurveEditor.h  
bDrawOutputGridNumbers bool Whether or not to draw the numbers for the output grid. SCurveEditor.h  
bHideUI bool If we should hide the UI when the mouse leaves the control SCurveEditor.h  
bIsGradientEditorVisible bool True if the gradient editor is being displayed SCurveEditor.h  
bIsPendingRebuilt bool   SCurveEditor.h  
bRequireFocusToZoom bool Flag to allow scrolling up/down over the widget from the outside without it handling the scroll wheel event SCurveEditor.h  
Commands TSharedPtr< FUICommandList >   SCurveEditor.h  
CurveFactory TObjectPtr< UCurveFactory > Reference to curve factor instance SCurveEditor.h  
CurveOwner FCurveOwnerInterface * Interface for curve supplier SCurveEditor.h  
CurveSelectionWidget TWeakPtr< SBox > Curve selection SCurveEditor.h  
DataMaxInput TAttribute< TOptional< float > > Maximum input of data range SCurveEditor.h  
DataMinInput TAttribute< TOptional< float > > Minimum input of data range SCurveEditor.h  
DesiredSize TAttribute< FVector2D > Editor Size SCurveEditor.h  
GradientViewer TSharedPtr< class SColorGradientEditor > Gradient editor SCurveEditor.h  
OnCreateAsset FSimpleDelegate Function pointer to execute callback function when user select 'Create external curve' SCurveEditor.h  
PropertyUtilitiesWeak TWeakPtr< IPropertyUtilities >   SCurveEditor.h  
RootPropertyHandleWeak TWeakPtr< IPropertyHandle >   SCurveEditor.h  
SelectedKeys TArray< FSelectedCurveKey > Array of selected keys SCurveEditor.h  
SelectedTangents TArray< FSelectedTangent > Array of selected tangents SCurveEditor.h  
SetAreCurvesVisibleHandler FOnSetAreCurvesVisible Handler for setting whether or not curves are being displayed. SCurveEditor.h  
SetInputViewRangeHandler FOnSetInputViewRange Handler for adjust timeline panning viewing SCurveEditor.h  
SetOutputViewRangeHandler FOnSetOutputViewRange Handler for adjust timeline panning viewing SCurveEditor.h  
Settings TObjectPtr< UCurveEditorSettings > User-supplied object for this curve editor SCurveEditor.h  
TransactionIndex int32 Index for the current transaction if any SCurveEditor.h  
WarningMessageText TSharedPtr< SErrorText > Text block used to display warnings related to curves SCurveEditor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Construct ( const FArguments& InArgs
)

   SCurveEditor.h  

UObject * CreateCurveObject ( TSubclassOf< UCurveBase > CurveType,
UObject* PackagePtr,
FName& AssetName
)

 Function to create a curve object and return its reference. SCurveEditor.h  

bool GetAllowAutoFrame()

 Gets or sets whether autoframing is allowed SCurveEditor.h  

bool GetAutoFrame()

 Gets whether autoframe will be invoked (combination of allow auto frame and curve editor auto frame setting) SCurveEditor.h  

TSharedPtr< FUICommandList > GetCommands()

 Gets a list of the commands handled by this control SCurveEditor.h  

UCurveFactory * GetCurveFactory()

 Construct an object of type UCurveFactory and return it's reference SCurveEditor.h  

FCurveOwnerInterface * GetCurveOwner()

 Get the currently edited curve SCurveEditor.h  

TArray< FRealCurve * > GetCurvesToFit()

 Get the curves to will be used during a fit operation SCurveEditor.h  

void RegisterToPropertyChangedEvent ( const TSharedPtr< IPropertyHandle >& InRootPropertyHandle
)

   SCurveEditor.h  

void SetAllowAutoFrame ( bool bInAllowAutoFrame
)

   SCurveEditor.h  

void SetCurveOwner ( FCurveOwnerInterface* InCurveOwner,
bool bCanEdit
)

 Set the curve that is being edited by this track widget. SCurveEditor.h  

void SetPropertyUtils ( const TSharedPtr< IPropertyUtilities >& InPropertyUtils
)

   SCurveEditor.h  

void SetRequireFocusToZoom ( bool bInRequireFocusToZoom
)

 Set flag that allows scrolling up/down over the widget from the outside without it handling the scroll wheel event SCurveEditor.h  

void SetZoomToFit ( bool bNewZoomToFitVertical,
bool bNewZoomToFitHorizontal
)

 Set new zoom to fit SCurveEditor.h  

void ZoomToFit ( const bool bZoomToFitAll
)

   SCurveEditor.h  

void ZoomToFitHorizontal ( const bool bZoomToFitAll
)

 Zoom to fit SCurveEditor.h  

void ZoomToFitVertical ( const bool bZoomToFitAll
)

   SCurveEditor.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual TOptional< bool > OnQueryShowFocus ( const EFocusCause InFocusCause
) const

   SCurveEditor.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

 Since we create a UFactory object, it needs to be serialized SCurveEditor.h  

virtual FString GetReferencerName()

   SCurveEditor.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool AnyCurveViewModelsSelected()

 Return whether any curve view models are selected SCurveEditor.h  

void ClearSelectedCurveViewModels()

 Clear the selected curve view models SCurveEditor.h  

void CloseEntryPopupMenu()

 Closes the popup created by GenericTextEntryModeless SCurveEditor.h  

void EmptyAllCurveViewModels()

 Empty all the curve view models SCurveEditor.h  

float FrameToTime ( int32 InFrame
) const

   SCurveEditor.h  

void GenericTextEntryModeless ( const FText& DialogText,
const FText& DefaultText,
FOnTextCommitted OnTextComitted
)

 Modeless Version of the String Entry Box SCurveEditor.h  

UCurveEditorSettings * GetSettings()

 Access the user-supplied settings object SCurveEditor.h  

virtual float GetTimeStep ( FTrackScaleInfo& ScaleInfo
) const

 Get Time Step for vertical line drawing SCurveEditor.h  

virtual void SetDefaultOutput ( const float MinZoomRange
)

 Set Default output values when range is too small SCurveEditor.h  

void SetInputMinMax ( float NewMin,
float NewMax
)

 Update view range SCurveEditor.h  

void SetOutputMinMax ( float NewMin,
float NewMax
)

   SCurveEditor.h  

void SetSelectedCurveViewModel ( FRealCurve* Curve
)

 Set the selected curve view model that matches the rich curve SCurveEditor.h  

int32 TimeToFrame ( float InTime
) const

 Convert time to frames and vice versa SCurveEditor.h  

void ValidateSelection()

 Ensure that selected keys and tangents are still valid SCurveEditor.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   SCurveEditor.h  

virtual FReply OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   SCurveEditor.h  

virtual FReply OnMouseButtonUp ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   SCurveEditor.h  

virtual void OnMouseCaptureLost ( const FCaptureLostEvent& CaptureLostEvent
)

   SCurveEditor.h  

virtual FReply OnMouseMove ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   SCurveEditor.h  

virtual FReply OnMouseWheel ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   SCurveEditor.h  

virtual int32 OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
) const

   SCurveEditor.h  

Static

Name Remarks Include Path Unreal Specifiers

static float CalcGridLineStepDistancePow2 ( double RawValue
)

 Calculate the distance between grid lines: determines next lowest power of 2, works with fractional numbers SCurveEditor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page