Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > UnrealEd > SCurveEditor

Light Theme

Dark Theme

SCurveEditor

Windows

MacOS

Linux

Inheritance Hierarchy

SCompoundWidget

FGCObject

FEditorUndoClient

SCurveEditor

References

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

Syntax

class SCurveEditor :
    public SCompoundWidget,
    public FGCObject,
    public FEditorUndoClient

Variables

	Name	Description
TAttribute< boo...	bAreCurvesVisible	Whether or not curves are being displayed
TAttribute< boo...	bInputSnappingEnabled	Whether or not input snapping is enabled.
bool	bIsUsingSlider	True if the sliders are being used to adjust point values
TAttribute< boo...	bOutputSnappingEnabled	Whether or not output snapping is enabled.
bool	bShowCurveSelector	Whether or not to show the curve selector widgets.
TAttribute< boo...	bShowTimeInFrames	Show time in frames.
bool	bShowZoomButtons	True if the internal zoom buttons should be visible.
bool	bZoomToFitHorizontal	True if you want the curve editor to fit to zoom
bool	bZoomToFitVertical	True if you want the curve editor to fit to zoom
TSharedPtr< STo...	CurveToolTip	The tooltip control for the curves.
FText	CurveToolTipInputText	The text for the input portion of the tooltip.
FText	CurveToolTipNameText	The text for the name portion of the tooltip.
FText	CurveToolTipOutputText	The text for the output portion of the tooltip.
TArray< TShared...	CurveViewModels	The view models for the curves.
FKeyHandle	DraggedKeyHandle	A handle to the key which was clicked to start a key drag operation.
EDragState	DragState	The state of the current drag operation happening with the widget, if any.
float	DragThreshold	The number of pixels which the mouse must move before a drag operation starts.
TWeakPtr< IMenu...	EntryPopupMenu	Generic Popup Entry
FLinearColor	GridColor	The color used to draw the grid lines.
FText	InputAxisName	The text to display for the input axis.
FText	InputFrameAxisName	The text to display for the input (frame) axis.
TAttribute< flo...	InputSnap	The snapping value for the input domain.
FVector2D	MouseDownLocation	The location of mouse during the last OnMouseButtonDown callback in widget local coordinates.
FVector2D	MouseMoveLocation	The location of the mouse during the last OnMouseMove callback in widget local coordinates.
EMovementAxisLo...	MovementAxisLock	The movement axis lock state
FText	OutputAxisName	The text to display for the output axis.
TAttribute< flo...	OutputSnap	The snapping value for the output domain.
TMap< FKeyHandl...	PreDragKeyLocations	A map of selected key handle to their starting locations at the beginning of a drag operation.
TMap< FKeyHandl...	PreDragTangents	A map of selected key handles to their tangent values at the beginning of a drag operation.
float	ReduceTolerance	The tolerance to use when reducing curves
TAttribute< flo...	TimelineLength	How long the overall timeline is
TAttribute< flo...	ViewMaxInput	Maximum input of view range
TAttribute< flo...	ViewMaxOutput	Min output view range
TAttribute< flo...	ViewMinInput	Minimum input of view range
TAttribute< flo...	ViewMinOutput	Max output view range

Destructors

	Name	Description
	~SCurveEditor()	Destructor

Functions

	Name	Description
bool	AnyCurveViewModelsSelected()	Return whether any curve view models are selected
void	ClearSelectedCurveViewModels()	Clear the selected curve view models
void	CloseEntryPopupMenu()	Closes the popup created by GenericTextEntryModeless
void	Construct ( const FArguments& InArgs )
UObject *...	CreateCurveObject ( TSubclassOf< UCurveBase > CurveType, UObject* PackagePtr, FName& AssetName )	Function to create a curve object and return its reference.
float	FrameToTime ( int32 InFrame )
void	GenericTextEntryModeless ( const FText& DialogText, const FText& DefaultText, FOnTextCommitted OnTextComitted )	Modeless Version of the String Entry Box
bool	GetAllowAutoFrame()	Gets or sets whether autoframing is allowed
bool	GetAutoFrame()	Gets whether autoframe will be invoked (combination of allow auto frame and curve editor auto frame setting)
TSharedPtr< ...	GetCommands()	Gets a list of the commands handled by this control
UCurveFactor...	GetCurveFactory()	Construct an object of type UCurveFactory and return it's reference
FCurveOwnerI...	GetCurveOwner()	Get the currently edited curve
TArray< FRea...	GetCurvesToFit()	Get the curves to will be used during a fit operation
UCurveEditor...	GetSettings()	Access the user-supplied settings object
float	GetTimeStep ( FTrackScaleInfo& ScaleInfo )	Get Time Step for vertical line drawing
void	SetAllowAutoFrame ( bool bInAllowAutoFrame )
void	SetCurveOwner ( FCurveOwnerInterface* InCurveO..., bool bCanEdit )	Set the curve that is being edited by this track widget.
void	SetDefaultOutput ( const float MinZoomRange )	Set Default output values when range is too small
void	SetInputMinMax ( float NewMin, float NewMax )	Update view range
void	SetOutputMinMax ( float NewMin, float NewMax )
void	SetRequireFocusToZoom ( bool bInRequireFocusToZoom )	Set flag that allows scrolling up/down over the widget from the outside without it handling the scroll wheel event
void	SetSelectedCurveViewModel ( FRealCurve* Curve )	Set the selected curve view model that matches the rich curve
void	SetZoomToFit ( bool bNewZoomToFitVertical, bool bNewZoomToFitHorizontal )	Set new zoom to fit
int32	TimeToFrame ( float InTime )	Convert time to frames and vice versa
void	ValidateSelection()	Ensure that selected keys and tangents are still valid
void	ZoomToFit ( const bool bZoomToFitAll )
void	ZoomToFitHorizontal ( const bool bZoomToFitAll )	Zoom to fit
void	ZoomToFitVertical ( const bool bZoomToFitAll )

Overridden from SWidget

	Name	Description
FReply	OnKeyDown ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )	Called after a key is pressed when this widget has focus (this event bubbles if not handled)
FReply	OnMouseButtonDown ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
FReply	OnMouseButtonUp ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse button was release within it.
void	OnMouseCaptureLost ( const FCaptureLostEvent& CaptureLo... )	Called when this widget had captured the mouse, but that capture has been revoked for some reason.
FReply	OnMouseMove ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse moved within it.
FReply	OnMouseWheel ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	Called when the mouse wheel is spun. This event is bubbled.
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.
TOptional< b...	OnQueryShowFocus ( const EFocusCause InFocusCause )	Called to determine if we should render the focus brush.

Overridden from FGCObject

		Name	Description
	void	AddReferencedObjects ( FReferenceCollector& Collector )	Since we create a UFactory object, it needs to be serialized

Classes

	Name	Description
	FArguments

Enums

	Name	Description
	EDragState	Represents the different states of a drag operation
	EMovementAxisLock

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss