FKeyBarCurveModel

Class that provides functionality to represents keys as continuous ranges.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

CurveEditor

Header

/Engine/Source/Editor/CurveEditor/Public/KeyBarCurveModel.h

Include

#include "KeyBarCurveModel.h"

Syntax

class FKeyBarCurveModel : public FCurveModel

Remarks

Class that provides functionality to represents keys as continuous ranges.

Constructors

Name Description

Public function

FKeyBarCurveModel()

Destructors

Name Description

Public function

~FKeyBarCurveModel()

Functions

Name Description

Public function Virtual

void

 

BuildContextMenu

(
    const FCurveEditor& CurveEditor,
    FMenuBuilder& MenuBuilder,
    TOptional< FCurvePointHandle > Clic...
)

New Virtuals for Key Bar Curve Model

Public function Virtual

TArray< FKey...

 

FindRanges()

Find all of the ranges in this model. This should return an increasing set of ranges.

Overridden from FCurveModel

Name Description

Public function Virtual

void

 

AddKeys

(
    TArrayView< const FKeyPosition > In...,
    TArrayView< const FKeyAttributes > ...,
    TArrayView< TOptional< FKeyHandle >...
)

Add keys to this curve

Public function Virtual Const

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

Public function Virtual Const

bool

 

Evaluate

(
    double InTime,
    double& OutValue
)

Evaluate this curve at the specified time

Public function Virtual Const

const void &...

 

GetCurve()

Access the raw pointer of the curve data

Public function Virtual 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 Virtual Const

void

 

GetKeyPositions

(
    TArrayView< const FKeyHandle > InKe...,
    TArrayView< FKeyPosition > OutKeyPo...
)

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 >& OutKeyHandle...
)

Retrieve all keys that lie in the specified time and value range

Public function Virtual Const

void

 

GetNeighboringKeys

(
    const FKeyHandle InKeyHandle,
    TOptional< FKeyHandle >& OutPrevio...,
    TOptional< FKeyHandle >& OutNextKe...
)

Get neighboring keys given the key handle

Public function Virtual Const

int32

 

GetNumKeys()

Get the number of keys

Public function Virtual Const

void

 

GetTimeRange

(
    double& MinTime,
    double& MaxTime
)

Get range of input time.

Public function Virtual Const

void

 

GetValueRange

(
    double& MinValue,
    double& MaxValue
)

Get range of output values.

Public function Virtual

void

 

Modify()

Explicitly modify the curve data. Called before any change is made to the curve.

Public function Virtual

void

 

RemoveKeys

(
    TArrayView< const FKeyHandle > InKe...
)

Remove all the keys with the specified key handles from this curve

Public function Virtual

void

 

SetKeyPositions

(
    TArrayView< const FKeyHandle > InKe...,
    TArrayView< const FKeyPosition > In...,
    const EPropertyChangeType::Type Cha...
)

Assign key positions for the specified key handles

Classes

Name

Description

Public struct

FBarRange

Bar Ranges for the Keys