1. Epic GamesDeveloper
  3. FCurveEditorSelection

FCurveEditorSelection

Class responsible for tracking selections of keys.

API > API/Editor > API/Editor/CurveEditor

References

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

Syntax

struct FCurveEditorSelection

Remarks

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

Constructors

  Type Name Description
Public function   Default constructor
Public function  

FCurveEditorSelection ( TWeakPtr< FCurveEditor > InWeakCurveEditor
)

 Constructor which takes a reference to the curve editor, which is used to find if a model is read only

Functions

  Type Name Description
Public function void

Add ( FCurveModelID CurveID,
ECurvePointType PointType,
FKeyHandle KeyHandle
)

 Add a key handle to this selection, changing the selection type if necessary.
Public function void

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

 Add key handles to this selection, changing the selection type if necessary.
Public function void

Add ( FCurvePointHandle InHandle
)

 Add a point handle to this selection, changing the selection type if necessary.
Public function void

Clear ()

 Clear the selection entirely
Public function Const bool

Contains ( FCurveModelID CurveID,
FKeyHandle KeyHandle,
ECurvePointType PointType
)

 Check whether the specified handle and curve ID is contained in this selection.
Public function Const int32

Count ()

 Count the total number of selected keys by accumulating the number of selected keys for each curve
Public function Const const FKeyHandleSet *

FindForCurve ( FCurveModelID InCurveID
)

 Retrieve a set of selected key handles for the specified curve
Public function Const const TMap< FCurveModelID, FKeyHandleSet > &

GetAll ()

 Retrieve all selected key handles, organized by curve ID
Public function Const uint32 Retrieve this selection's serial number. Incremented whenever a change is made to the selection.
Public function Const bool

IsEmpty ()

 Check whether the selection is empty
Public function Const bool Check whether the specified handle is selected
Public function void

Remove ( FCurvePointHandle InHandle
)

 Remove the specified point handle from the selection
Public function void

Remove ( FCurveModelID InCurveID
)

 Remove all key handles associated with the specified curve ID from the selection
Public function void

Remove ( FCurveModelID CurveID,
ECurvePointType PointType,
FKeyHandle KeyHandle
)

 Remove the specified key handle from the selection
Public function void

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

 Remove the specified key handles from the selection
Public function void

Toggle ( FCurveModelID CurveID,
ECurvePointType PointType,
FKeyHandle KeyHandle
)

 Toggle the selection of the specified key handle, changing the selection type if necessary.
Public function void

Toggle ( FCurvePointHandle InHandle
)

 Toggle the selection of the specified point handle, changing the selection type if necessary.
Public function void

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

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page