1. Epic GamesDeveloper
  3. FCurveEditorSelection

FCurveEditorSelection

Class responsible for tracking selections of keys.

API > API/Editor > API/Editor/CurveEditor

Class responsible for tracking selections of keys. Only one type of point selection is supported at a time (key, arrive tangent, or leave tangent)

   
Name FCurveEditorSelection
Type struct
Header File /Engine/Source/Editor/CurveEditor/Public/CurveEditorSelection.h
Include Path #include "CurveEditorSelection.h"

Syntax

struct FCurveEditorSelection

Constructors

Name Remarks Include Path Unreal Specifiers

FCurveEditorSelection ( TWeakPtr< FCurveEditor > InWeakCurveEditor
)

 Constructor which takes a reference to the curve editor, which is used to find if a model is read only CurveEditorSelection.h  
Default constructor CurveEditorSelection.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CurveToSelectedKeys TMap< FCurveModelID, FKeyHandleSet > A map of selected handles stored by curve ID CurveEditorSelection.h  
SerialNumber uint32 A serial number that increments every time a change is made to the selection CurveEditorSelection.h  
WeakCurveEditor TWeakPtr< FCurveEditor > Weak reference to the curve editor to check whether keys are locked or not CurveEditorSelection.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Add ( FCurvePointHandle InHandle
)

 Add a point handle to this selection, changing the selection type if necessary. CurveEditorSelection.h  

void Add ( FCurveModelID CurveID,
ECurvePointType PointType,
TArrayView< const FKeyHandle > Keys
)

 Add key handles to this selection, changing the selection type if necessary. CurveEditorSelection.h  

void Add ( FCurveModelID CurveID,
ECurvePointType PointType,
FKeyHandle KeyHandle
)

 Add a key handle to this selection, changing the selection type if necessary. CurveEditorSelection.h  

void Clear()

 Clear the selection entirely CurveEditorSelection.h  

bool Contains ( FCurveModelID CurveID,
FKeyHandle KeyHandle,
ECurvePointType PointType
) const

 Check whether the specified handle and curve ID is contained in this selection. CurveEditorSelection.h  

int32 Count()

 Count the total number of selected keys by accumulating the number of selected keys for each curve CurveEditorSelection.h  

const FKeyHandleSet * FindForCurve ( FCurveModelID InCurveID
) const

 Retrieve a set of selected key handles for the specified curve CurveEditorSelection.h  

const TMap< FCurveModelID, FKeyHandleSet > & GetAll()

 Retrieve all selected key handles, organized by curve ID CurveEditorSelection.h  

uint32 GetSerialNumber()

 Retrieve this selection's serial number. Incremented whenever a change is made to the selection. CurveEditorSelection.h  

bool IsEmpty()

 Check whether the selection is empty CurveEditorSelection.h  

bool IsSelected ( FCurvePointHandle InHandle
) const

 Check whether the specified handle is selected CurveEditorSelection.h  

void Remove ( FCurvePointHandle InHandle
)

 Remove the specified point handle from the selection CurveEditorSelection.h  

void Remove ( FCurveModelID InCurveID
)

 Remove all key handles associated with the specified curve ID from the selection CurveEditorSelection.h  

void Remove ( FCurveModelID CurveID,
ECurvePointType PointType,
FKeyHandle KeyHandle
)

 Remove the specified key handle from the selection CurveEditorSelection.h  

void Remove ( FCurveModelID CurveID,
ECurvePointType PointType,
TArrayView< const FKeyHandle > Keys
)

 Remove the specified key handles from the selection CurveEditorSelection.h  

void SerializeSelection ( FArchive& Ar
)

 Serializes the SerialNumber and CurveToSelectedKeys. CurveEditorSelection.h  

void Toggle ( FCurveModelID CurveID,
ECurvePointType PointType,
FKeyHandle KeyHandle
)

 Toggle the selection of the specified key handle, changing the selection type if necessary. CurveEditorSelection.h  

void Toggle ( FCurvePointHandle InHandle
)

 Toggle the selection of the specified point handle, changing the selection type if necessary. CurveEditorSelection.h  

void Toggle ( FCurveModelID CurveID,
ECurvePointType PointType,
TArrayView< const FKeyHandle > Keys
)

 Toggle the selection of the specified key handles, changing the selection type if necessary. CurveEditorSelection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page