FIndexedCurve

A curve base class which enables key handles to index lookups.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Curves/IndexedCurve.h

Include

#include "Curves/IndexedCurve.h"

Syntax

struct FIndexedCurve

Remarks

A curve base class which enables key handles to index lookups.

Variables

Name Description

Protected variable

FKeyHandleMap

 

KeyHandlesToIndices

Map of which key handles go to which indices.

Constructors

Name Description

Public function

FIndexedCurve()

Default constructor.

Destructors

Name Description

Public function Virtual

~FIndexedCurve()

Functions

Name Description

Public function Virtual Const

FIndexedCurve *

 

Duplicate()

Allocates a duplicate of the curve

Protected function Const

void

 

EnsureAllIndicesHaveHandles()

Makes sure our handles are all valid and correct.

Protected function Const

void

 

EnsureIndexHasAHandle

(
    int32 KeyIndex
)

Protected function Const

const int32 *

 

FindIndex

(
    FKeyHandle KeyHandle
)

Gets the index of a handle .

Public function Const

FKeyHandle

 

GetFirstKeyHandle()

Gets the key handle for the first key in the curve

Protected function Const

int32

 

GetIndex

(
    FKeyHandle KeyHandle
)

Gets the index of a handle.

Public function Const

int32

 

GetIndexSafe

(
    FKeyHandle KeyHandle
)

Gets the index of a handle, checks if the key handle is valid first.

Protected function Const

FKeyHandle

 

GetKeyHandle

(
    int32 KeyIndex
)

Internal tool to get a handle from an index.

Public function Const

TArray< FKeyHandle >::TConstIterator

 

GetKeyHandleIterator()

Const iterator for the handles.

Public function Virtual Const

float

 

GetKeyTime

(
    FKeyHandle KeyHandle
)

Get the time for the Key with the specified index.

Public function Const

FKeyHandle

 

GetLastKeyHandle()

Gets the key handle for the last key in the curve

Public function Const

FKeyHandle

 

GetNextKey

(
    FKeyHandle KeyHandle
)

Get the next key given the key handle

Public function Virtual Const

int32

 

GetNumKeys()

Get number of keys in curve.

Public function Const

FKeyHandle

 

GetPreviousKey

(
    FKeyHandle KeyHandle
)

Get the previous key given the key handle

Public function Const

bool

 

IsKeyHandleValid

(
    FKeyHandle KeyHandle
)

Checks to see if the key handle is valid for this curve.

Public function

void

 

ScaleCurve

(
    float ScaleOrigin,
    float ScaleFactor
)

Scales all keys about an origin, preserving order

Public function

void

 

ScaleCurve

(
    float ScaleOrigin,
    float ScaleFactor,
    const TSet< FKeyHandle >& KeyHandles
)

Scales all keys about an origin, preserving order

Public function Virtual

void

 

SetKeyTime

(
    FKeyHandle KeyHandle,
    float NewTime
)

Move a key to a new time. This may change the index of the key, so the new key index is returned.

Public function

void

 

ShiftCurve

(
    float DeltaTime
)

Shifts all keys forwards or backwards in time by an even amount, preserving order

Public function

void

 

ShiftCurve

(
    float DeltaTime,
    const TSet< FKeyHandle >& KeyHandles
)

Shifts all keys forwards or backwards in time by an even amount, preserving order

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback