Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. SCurveEditorView

SCurveEditorView

This is the base widget type for all views that exist on a curve editor panel.

API > API/Editor > API/Editor/CurveEditor

Inheritance Hierarchy

References

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

Syntax

class SCurveEditorView : public SCompoundWidget

Remarks

This is the base widget type for all views that exist on a curve editor panel. A view may contain 0 or more curves (stored in CurveInfoByID). SCurveEditorViews are directly housed within a single SCurveEditorViewContainer which arranges each view vertically in order.

View types: A view may have a centrally registered ID (See FCurveEditorViewRegistry and FCurveModel::GetSupportedViews) which allows any external curve model type to express support for any other view type. 3 built-in views are provided: Absolute: Shows 1 or more curves on a single 2D-scrollable grid using a single zoomable view-space. Normalized: Shows 1 or more curves on a single grid scrollable horizontally with all curves normalized to the extents of the view Stacked: Shows 1 or more curves on separate fixed-height grids scrollable horizontally each curve normalized to the extents of its own grid Unregistered curve views may still be added to the view by calling SCurveEditorPanel::AddView

Space Transformations: Views must define a valid 2-dimensional space (ViewSpace) that is used to convert from a pixel position to the virtual view space. Views may additionally implement per-curve transformations from view space to curve space, to allow for specific layouts/scales of curves within them. Per-curve transforms are stored inside FCurveInfo::ViewToCurveTransform

Sizing: Views may be size in one of 2 ways:

  • Auto sized (bAutoSize=true): views derive their height from the widget's desired size;
  • Stretched (bAutoSize=false): views will be stretched to the size of the parent panel with a sensible minimum height.

Variables

  Type Name Description
Public variable uint8: 1 bAllowEmpty (Default: false) Defines whether this view should remain on the panel UI even if it does not represent any curves.
Public variable uint8: 1 bAutoSize (Default: true) See class notes - defines whether this view should size to its desired size (true) or stretch to the height of the panel (false).
Public variable uint8: 1 bFixedOutputBounds (Default: false) When true, this view has fixed vertical bounds that should never be changed by zooming or panning
Public variable uint8: 1 bInteractive (Default: true) When true, this view should accept interactive operations such as drags and tool interaction
Public variable uint8: 1 bPinned (Default: false) When true, this view has been pinned to the top of the view container.
Protected variable TArray< FCurveDrawParams > CachedDrawParams Curve draw parameters that are re-generated on tick if the cache has changed.
Protected variable FCachedValuesToCheck CachedValues  
Protected variable ECurveCacheFlags CurveCacheFlags Curve cache flags that change based upon data or view getting modified
Protected variable TSortedMap< FCurveModelID, FCurveInfo, TInlineAllocator< 1 > > CurveInfoByID Map from curve identifier to specific info pertaining to that curve for this view.
Public variable TAttribute< float > FixedHeight (Optional) Attribute that defines a fixed height for this view.
Public variable int32 MaximumCapacity The maximum number of curves allowed on this view, or 0 for no limit
Protected variable double OutputMax This view's maximum visible output value
Protected variable double OutputMin This view's minimum visible output value
Public variable int32 RelativeOrder Transient integer that is assigned each time the view container order is changed, to guarantee relative ordering of views when the list changes
Protected variable TSharedPtr< SRetainerWidget > RetainerWidget Possible pointer to a retainer widget that we may need to force update
Public variable int8 SortBias (Default: 0) Should be assigned on Construction of derived types.
Public variable ECurveEditorViewID ViewTypeID This view's type identifier. Assigned by the curve editor panel after construction.
Protected variable TWeakPtr< FCurveEditor > WeakCurveEditor The curve editor associated with this view.

Constructors

  Type Name Description
Public function   Default constructor

Functions

  Type Name Description
Public function Virtual void Bind UI commands for this view
Public function Virtual void This should be called every tick by an owning widget, to see if the cache is valid, which will then recreate it and invalidate widget
Public function Virtual void

FrameVertical ( double InOutputMin,
double InOutputMax
)

 Frame the view vertially by the input and output bounds, peformaing any custom clipping as needed
Protected function Const void

GetCurveDrawParam ( TSharedPtr< FCurveEditor >& CurveEditor,
const FCurveModelID& ModelID,
FCurveModel* CurveModel,
double InputMin,
double InputMax,
FCurveDrawParams& OutDrawParam
)

 Get it for just one curve
Protected function void Gets info about the curves being drawn.
Public function Const FCurveEditorScreenSpace Get the screen space ultility that defines the specified curves's input, output and pixel metrics.
Public function Virtual Const bool

GetCurveWithinWidgetRange ( const FSlateRect& WidgetRectangle,
TArray< FCurvePointHandle >* OutPoints
)

 Retrieve all the curve points, if any of the interpolating points overlap the specified rectangle in widget space
Public function Virtual Const void

GetGridLinesX ( TSharedRef< const FCurveEditor > CurveEditor,
TArray< float >& MajorGridLines,
TArray< float >& MinorGridLines,
TArray< FText >* MajorGridLabels
)

  
Public function Virtual Const void

GetGridLinesY ( TSharedRef< const FCurveEditor > CurveEditor,
TArray< float >& MajorGridLines,
TArray< float >& MinorGridLines,
TArray< FText >* MajorGridLabels
)

  
Public function Virtual Const TOptional< FCurveModelID > Retrieve the id of the hovered curve
Public function Const void

GetInputBounds ( double& OutInputMin,
double& OutInputMax
)

 Retrieve this view's input bounds, accounting for any offsets or padding from the outer container
Public function Const double Retrieve this view's maximum output bound in view space
Public function Const double Retrieve this view's minimum output bound in view space
Public function Virtual Const bool

GetPointsWithinWidgetRange ( const FSlateRect& WidgetRectangle,
TArray< FCurvePointHandle >* OutPoints
)

 Retrieve all the curve points that overlap the specified rectangle in widget space
Public function Const FCurveEditorScreenSpace Get the screen space ultility that defines this view's input, output and pixel metrics
Public function Const bool Check whether this view has space for any more curves
Public function Const bool Check whether this view can be interacted with.
Public function Virtual Const bool Should the tools respect the global snapping rules for Time (X axis) input when manipulating a curve in this view.
Public function Virtual Const bool Should the tools respect the global snapping rules for Value (Y axis) input when manipulating a curve in this view.
Public function Const int32 Retrieve the number of curves that exist on this view
Public function Virtual void Invoked when a curve has been added or removed from this list.
Protected function void Request a new render from the retainer widget
Public function void

SetOutputBounds ( double InOutputMin,
double InOutputMax
)

 Set this view's output bounds
Public function void  
Public function Const bool Check whether this view should auto size to fit its FixedHeight or child slot content
Public function Virtual void

UpdateViewToTransformCurves ( double InputMin,
double InputMax
)

 Function to make sure to update the view to the transform curves, we need to do this before we cache
Public function void

Zoom ( const FVector2D& Amount
)

 Zoom this view in or out around its center point
Public function void

ZoomAround ( const FVector2D& Amount,
double InputOrigin,
double OutputOrigin
)

 Zoom this view in or out around the specified point

Overridden from SWidget

  Type Name Description
Protected function Virtual Const FVector2D

ComputeDesiredSize ( float LayoutScaleMultiplier
)

 Compute the ideal size necessary to display this widget.

Classes

  Type Name Description
Protected struct FCachedValuesToCheck Set of Cached values we need to check each tick to see if we need to redo cache  
Protected struct FCurveInfo    

Enums

  Type Name Description
Protected enum ECurveCacheFlags Flag enum signifying how the curve cache has changed since it was last generated Note for a data change it may only effect certain data(curves) not every drawn curve  

Deprecated Functions

  Type Name Description
Public function Virtual void Use UpdateViewToTransformCurves(double InputMin, double InputMax) instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page