FCurveModel

Class that models an underlying curve data structure through a generic abstraction that the curve editor understands.

Unreal Engine C++ API Reference > Editor > CurveEditor

Inheritance Hierarchy

  • FCurveModel

References

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

Syntax

class FCurveModel  

Remarks

Class that models an underlying curve data structure through a generic abstraction that the curve editor understands.

Variables

Type Name Description
TAttribute< boo... bKeyDrawEnabled Whether or not to draw curve's keys
FLinearColor Color This curve's display color
FSimpleMulticas... CurveModifiedDelegate Multicast delegate broadcast on curve modification
FString IntentionName This curve's short intention (such as Transform.X or Scale.X).
FText LongDisplayName This curve's long display name.
FString LongIntentionName This curve's long intention (such as foot_fk_l.Transform.X or foot_fk_r.Scale.X).
FText ShortDisplayName This curve's short display name.
ECurveEditorVie... SupportedViews A set of views supported by this curve

Constructors

Type Name Description
  FCurveModel ()  

Destructors

Type Name Description
  ~FCurveModel ()  

Functions

Type Name Description
TOptional< F... AddKey ( const FKeyPosition& NewKeyPosition, const FKeyAttributes& InAttributes ) Helper function for adding a single key to this curve
void AddKeys ( TArrayView< const FKeyPosition > In..., TArrayView< const FKeyAttributes > ..., TArrayView< TOptional< FKeyHandle >... ) Add keys to this curve
TUniquePtr< ... CreateBufferedCurveCopy () Creates a copy of this curve, stored in a minimal buffered curve object.
void CreateKeyProxies ( TArrayView< const FKeyHandle > InKe..., TArrayView< UObject* > OutObje... ) Create key proxy objects for the specified key handles.
void DrawCurve ( const FCurveEditor& CurveEditor, const FCurveEditorScreenSpace& Scr..., TArray< TTuple< double, double >>&... ) Draw the curve for the specified curve editor by populating an array with points on the curve between which lines should be drawn
bool Evaluate ( double InTime, double& OutValue ) Evaluate this curve at the specified time
FLinearColor GetColor () Retrieve this curve's color
const void &... GetCurve () Access the raw pointer of the curve data
void GetCurveAttributes ( FCurveAttributes& OutAttributes ) Retrieve curve attributes for this curve
void GetCurveColorObjectAndName ( UObject** OutObject, FString& OutName ) Get the Object and the name to be used to store the curve model color (see UCurveEditorSettings).
double GetInputDisplayOffset () Retrieve an option input display offset (in seconds) to apply to all this curve's drawing
FString GetIntentionName () This is an internal name used to try to match different curves with each other.
TPair< ERich... GetInterpolationMode ( const double& InTime, ERichCurveInterpMode DefaultInterpo..., ERichCurveTangentMode DefaultTangen... ) Get the interpolation mode to use at a specified time
void GetKeyAttributes ( TArrayView< const FKeyHandle > InKe..., TArrayView< FKeyAttributes > OutAtt... ) Retrieve all key attributes that pertain to the specified input key handles
void GetKeyDrawInfo ( ECurvePointType PointType, const FKeyHandle InKeyHandle, FKeyDrawInfo& OutDrawInfo ) Populate the specified draw info structure with data describing how to draw the specified point type
void GetKeyPositions ( TArrayView< const FKeyHandle > InKe..., TArrayView< FKeyPosition > OutKeyPo... ) Retrieve all key positions that pertain to the specified input key handles
void GetKeys ( const FCurveEditor& CurveEditor, double MinTime, double MaxTime, double MinValue, double MaxValue, TArray< FKeyHandle >& OutKeyHandle... ) Retrieve all keys that lie in the specified time and value range
FText GetLongDisplayName () Access this curve's long display name.
FString GetLongIntentionName ()  
void GetNeighboringKeys ( const FKeyHandle InKeyHandle, TOptional< FKeyHandle >& OutPrevio..., TOptional< FKeyHandle >& OutNextKe... ) Get neighboring keys given the key handle
int32 GetNumKeys () Get the number of keys
UObject *... GetOwningObject () Get the UObject that owns this CurveModel, for example for Sequencer this would be the UMovieSceneSection
FText GetShortDisplayName () Access this curve's short display name.
ECurveEditor... GetSupportedViews () Retrieve this curve's supported views
void GetTimeRange ( double& MinTime, double& MaxTime ) Get range of input time.
void GetValueRange ( double InMinTime, double InMaxTime, double& MinValue, double& MaxValue ) Get range of output value based on specified input times.
void GetValueRange ( double& MinValue, double& MaxValue ) Get range of output values.
bool HasChangedAndResetTest () Get if has changed and then reset it, this can be used for caching
bool IsKeyDrawEnabled () Retrieves whether or not to disable drawing keys
bool IsReadOnly () Returns whether the curve model should be edited or not
void Modify () Explicitly modify the curve data. Called before any change is made to the curve.
FSimpleMulti... OnCurveModified () Get a multicast delegate, fired when modifications are made to this curve
void RemoveKeys ( TArrayView< const FKeyHandle > InKe... ) Remove all the keys with the specified key handles from this curve
void SetColor ( const FLinearColor& InColor, bool bInModify )  
void SetCurveAttributes ( const FCurveAttributes& InAttribut... ) Assign curve attributes for this curve
void SetIntentionName ( const FString& InIntentionName ) Assign an intention name for this curve which is used internally when applying one curve to another in situations where multiple curves are visible.
void SetIsKeyDrawEnabled ( TAttribute< bool > bInKeyDrawEnable... ) Assign whether or not to disable drawing keys
void SetKeyAttributes ( TArrayView< const FKeyHandle > InKe..., TArrayView< const FKeyAttributes > ..., EPropertyChangeType::Type ChangeTyp... ) Assign key attributes for the specified key handles
void SetKeyAttributes ( TArrayView< const FKeyHandle > InKe..., const FKeyAttributes& InAttributes, EPropertyChangeType::Type ChangeTyp... ) Helper function for assigning a the same attributes to a number of keys
void SetKeyPositions ( TArrayView< const FKeyHandle > InKe..., TArrayView< const FKeyPosition > In..., EPropertyChangeType::Type ChangeTyp... ) Assign key positions for the specified key handles
void SetLongDisplayName ( const FText& InLongDisplayName ) Assign a long display name for this curve used in contexts where additional context is useful.
void SetLongIntentionName ( const FString& InIntentionName )  
void SetShortDisplayName ( const FText& InDisplayName ) Assign a short display name for this curve

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library