1. Epic GamesDeveloper
  3. IKeyArea

IKeyArea

Interface that should be implemented for the UI portion of a key area within a section

API > API/Editor > API/Editor/Sequencer

Inheritance Hierarchy

References

   
Module Sequencer
Header /Engine/Source/Editor/Sequencer/Public/IKeyArea.h
Include #include "IKeyArea.h"

Syntax

class IKeyArea : public TSharedFromThis< IKeyArea >

Remarks

Interface that should be implemented for the UI portion of a key area within a section

Variables

  Type Name Description
Public variable uint32 TreeSerialNumber Serial number of the node tree from the last time this key area was seen

Constructors

  Type Name Description
Public function   Constructor

Functions

  Type Name Description
Public function FKeyHandle

AddOrUpdateKey ( FFrameNumber Time,
const FGuid& ObjectBindingID,
ISequencer& InSequencer
)

 Add a key at the specified time with the current value of the channel, updating an existing key if possible
Public function Const bool Check whether this key area can create an editor on the sequencer node tree
Public function Const void

CopyKeys ( FMovieSceneClipboardBuilder& ClipboardBuilder,
TArrayView< const FKeyHandle > KeyMask
)

 Copy all the keys specified in KeyMask to the specified clipboard
Public function Const TUniquePtr< FCurveModel > Create a new model for this key area that can be used on the curve editor interface
Public function TSharedRef< SWidget >

CreateKeyEditor ( TWeakPtr< ISequencer > Sequencer,
const FGuid& ObjectBindingID
)

 Create an editor on the sequencer node tree
Public function Const int32

DrawExtra ( const FSequencerChannelPaintArgs& PaintArgs,
int32 LayerId
)

 Draw additional content in addition to keys for a particular IKeyArea
Public function void

DrawKeys ( TArrayView< const FKeyHandle > InKeyHandles,
TArrayView< FKeyDrawParams > OutKeyDrawParams
)

 Gather key drawing information for the specified key handles
Public function Const FKeyHandle

DuplicateKey ( FKeyHandle InKeyHandle
)

 Duplicate the key represented by the specified handle
Public function Const ISequencerChannelInterface * Locate the sequencer channel interface for this key area's channel
Public function Const const FMovieSceneChannelHandle & Access the channel handle that this key area represents
Public function Const FName Access the channel type identifier for the channel that this key area wraps
Public function Const TOptional< FLinearColor > Get the color of this channel that should be drawn underneath its keys
Public function Const void

GetKeyHandles ( TArray< FKeyHandle >& OutHandles,
const TRange< FFrameNumber >& WithinRange
)

 Get all key handles that exist within the given time range
Public function Const void

GetKeyInfo ( TArray< FKeyHandle >* OutHandles,
TArray< FFrameNumber >* OutTimes,
const TRange< FFrameNumber >& WithinRange
)

 Populate the specified handle and/or time arrays with information pertaining to keys that exist within the given range
Public function Const TSharedPtr< FStructOnScope >

GetKeyStruct ( FKeyHandle KeyHandle
)

 Get a key structure for editing a value on this channel
Public function Const FFrameNumber

GetKeyTime ( FKeyHandle InKeyHandle
)

 Get the time of the key represented by the specified handle
Public function Const void

GetKeyTimes ( TArrayView< const FKeyHandle > InKeyHandles,
TArrayView< FFrameNumber > OutTimes
)

 Get the times of every key represented by the specified handles
Public function Const void

GetKeyTimes ( TArray< FFrameNumber >& OutTimes,
const TRange< FFrameNumber >& WithinRange
)

 Get all key times that exist within the given time range
Public function Const FName

GetName ()

 Get this key area's name
Public function Const UMovieSceneSection * Access section that owns the channel this key area represents
Public function Const FRichCurve *  
Public function Const TSharedPtr< ISequencerSection > Access section editor interface
Public function TArray< FKeyHandle >

PasteKeys ( const FMovieSceneClipboardKeyTrack& KeyTrack,
const FMovieSceneClipboardEnvironment& SrcEnvironment,
const FSequencerPasteEnvironment& DstEnvironment
)

 Paste the specified key track into this key area
Public function void Reinitialize this key area with a new channel
Public function Const FMovieSceneChannel * Resolve this key area's channel handle
Public function Const void

SetKeyTime ( FKeyHandle InKeyHandle,
FFrameNumber InKeyTime
)

 Set the time of the key with the specified handle
Public function Const void

SetKeyTimes ( TArrayView< const FKeyHandle > InKeyHandles,
TArrayView< const FFrameNumber > InKeyTimes
)

 Set the times of the each key with the specified handles
Public function void

SetName ( FName InName
)

 Set this key area's name
Public function Const bool Check whether we should show this key area's curve on its channel UI or not

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page