1. Epic GamesDeveloper
  3. FCurveModel

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

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
Protected variable TAttribute< bool > bKeyDrawEnabled Whether or not to draw curve's keys
Protected variable FName ChannelName The original channel name, used mostly to make sure names match with BP/Scripting
Protected variable FLinearColor Color This curve's display color
Protected variable FSimpleMulticastDelegate CurveModifiedDelegate Multicast delegate broadcast on curve modification
Protected variable float DashLengthPx When this curve is to be drawn dashed, the length of each dash (or 0.f if solid)
Protected variable FString IntentionName This curve's short intention (such as Transform.X or Scale.X).
Protected variable FText LongDisplayName This curve's long display name.
Protected variable FString LongIntentionName This curve's long intention (such as foot_fk_l.Transform.X or foot_fk_r.Scale.X).
Protected variable FText ShortDisplayName This curve's short display name.
Protected variable ECurveEditorViewID SupportedViews A set of views supported by this curve
Protected variable float Thickness Default thickness for this curve

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function TOptional< FKeyHandle >

AddKey ( const FKeyPosition& NewKeyPosition,
const FKeyAttributes& InAttributes
)

 Helper function for adding a single key to this curve
Public function void

AddKeys ( TArrayView< const FKeyPosition > InPositions,
TArrayView< const FKeyAttributes > InAttributes,
TArrayView< TOptional< FKeyHandle > >* OutKeyHandles
)

 Add keys to this curve
Public function Virtual Const void

AllocateAxes ( FCurveEditor* InCurveEditor,
TSharedPtr< FCurveEditorAxis >& OutHorizontalAxis,
TSharedPtr< FCurveEditorAxis >& OutVerticalAxis
)

 Allocate and/or assign axes for the this curve
Public function Virtual Const TUniquePtr< IBufferedCurveModel > Creates a copy of this curve, stored in a minimal buffered curve object.
Public function Virtual void

CreateKeyProxies ( TArrayView< const FKeyHandle > InKeyHandles,
TArrayView< UObject* > OutObjects
)

 Create key proxy objects for the specified key handles.
Public function Const void

DrawCurve ( const FCurveEditor& CurveEditor,
const FCurveEditorScreenSpace& ScreenSpace,
TArray< TTuple< double, double > >& InterpolatingPoints
)

 Draw the curve for the specified curve editor by populating an array with points on the curve between which lines should be drawn
Public function Const bool

Evaluate ( double InTime,
double& OutValue
)

 Evaluate this curve at the specified time
Public function Const FName  
Public function Virtual Const FLinearColor Retrieve this curve's color
Public function Const const void * Access the raw pointer of the curve data
Public function Virtual Const void

GetCurveAttributes ( FCurveAttributes& OutAttributes
)

 Retrieve curve attributes for this curve
Public function Virtual Const void

GetCurveColorObjectAndName ( UObject** OutObject,
FString& OutName
)

 Get the Object and the name to be used to store the curve model color (see UCurveEditorSettings).
Public function Virtual Const FTransform2d Return a per-curve transform for this model, if used by the view
Public function Const float Get the dash length used for rendering this curve (0 indicates a solid line should be used)
Public function Virtual Const double Retrieve an option input display offset (in seconds) to apply to all this curve's drawing
Public function Const FString This is an internal name used to try to match different curves with each other.
Public function Virtual Const TPair< ERichCurveInterpMode, ERichCurveTangentMode >

GetInterpolationMode ( const double& InTime,
ERichCurveInterpMode DefaultInterpolationMode,
ERichCurveTangentMode DefaultTangentMode
)

 Get the interpolation mode to use at a specified time
Public function Virtual Const void

GetKeyAttributes ( TArrayView< const FKeyHandle > InKeys,
TArrayView< FKeyAttributes > OutAttributes
)

 Retrieve all key attributes that pertain to the specified input key handles
Public function Const 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
Public function Const void

GetKeyPositions ( TArrayView< const FKeyHandle > InKeys,
TArrayView< FKeyPosition > OutKeyPositions
)

 Retrieve all key positions that pertain to the specified input key handles
Public function Virtual Const void

GetKeys ( const FCurveEditor& CurveEditor,
double MinTime,
double MaxTime,
double MinValue,
double MaxValue,
TArray< FKeyHandle >& OutKeyHandles
)

  
Public function Const void

GetKeys ( double MinTime,
double MaxTime,
double MinValue,
double MaxValue,
TArray< FKeyHandle >& OutKeyHandles
)

 Retrieve all keys that lie in the specified time and value range
Public function Const FText Access this curve's long display name.
Public function Const FString  
Public function Const void

GetNeighboringKeys ( const FKeyHandle InKeyHandle,
TOptional< FKeyHandle >& OutPreviousKeyHandle,
TOptional< FKeyHandle >& OutNextKeyHandle
)

 Get neighboring keys given the key handle
Public function Const int32 Get the number of keys
Public function Virtual Const UObject * Get the UObject that owns this CurveModel, for example for Sequencer this would be the UMovieSceneSection
Public function Const T * Get the owning object of this curve as the specified template type, or search is outer chain if it is not the specified type.
Public function Const FText Access this curve's short display name.
Public function Const ECurveEditorViewID Retrieve this curve's supported views
Public function Const float Get this curve's visual thickness in screen space
Public function Const void

GetTimeRange ( double& MinTime,
double& MaxTime
)

 Get range of input time.
Public function Virtual Const void

GetValueRange ( double InMinTime,
double InMaxTime,
double& MinValue,
double& MaxValue
)

 Get range of output value based on specified input times.
Public function Const void

GetValueRange ( double& MinValue,
double& MaxValue
)

 Get range of output values.
Public function Virtual bool Get if has changed and then reset it, this can be used for caching
Public function Const bool Retrieves whether or not to disable drawing keys
Public function Virtual Const bool Returns whether the curve model should be edited or not
Public function Virtual Const void

MakeChildCurves ( TArray< TUniquePtr< FCurveModel > >& OutChildCurves
)

 Called when this curve model is added to a curve editor in order to construct additional 'child' curves that are owned by this curve
Public function void

Modify ()

 Explicitly modify the curve data. Called before any change is made to the curve.
Public function FSimpleMulticastDelegate & Get a multicast delegate, fired when modifications are made to this curve
Public function void

RemoveKeys ( TArrayView< const FKeyHandle > InKeys
)

 Remove all the keys with the specified key handles from this curve
Public function void

SetChannelName ( const FName& InChannelName
)

  
Public function void

SetColor ( const FLinearColor& InColor,
bool bInModify
)

  
Public function Virtual void

SetCurveAttributes ( const FCurveAttributes& InAttributes
)

 Assign curve attributes for this curve
Public function void

SetDashLength ( float InDashLengthPx
)

 Set the dash length used for rendering this curve (0 indicates a solid line should be used)
Public function 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.
Public function void

SetIsKeyDrawEnabled ( TAttribute< bool > bInKeyDrawEnabled
)

 Assign whether or not to disable drawing keys
Public function Virtual void

SetKeyAttributes ( TArrayView< const FKeyHandle > InKeys,
TArrayView< const FKeyAttributes > InAttributes,
EPropertyChangeType::Type ChangeType
)

 Assign key attributes for the specified key handles
Public function void

SetKeyAttributes ( TArrayView< const FKeyHandle > InKeys,
const FKeyAttributes& InAttributes,
EPropertyChangeType::Type ChangeType
)

 Helper function for assigning a the same attributes to a number of keys
Public function void

SetKeyPositions ( TArrayView< const FKeyHandle > InKeys,
TArrayView< const FKeyPosition > InKeyPositions,
EPropertyChangeType::Type ChangeType
)

 Assign key positions for the specified key handles
Public function void

SetLongDisplayName ( const FText& InLongDisplayName
)

 Assign a long display name for this curve used in contexts where additional context is useful.
Public function void

SetLongIntentionName ( const FString& InIntentionName
)

  
Public function void

SetShortDisplayName ( const FText& InDisplayName
)

 Assign a short display name for this curve
Public function void

SetThickness ( float InThickness
)

 Set this curve's visual thickness in screen space

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page