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

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

   
Name IKeyArea
Type class
Header File /Engine/Source/Editor/Sequencer/Public/IKeyArea.h
Include Path #include "IKeyArea.h"

Syntax

class IKeyArea : public TSharedFromThis< IKeyArea >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

IKeyArea ( TWeakPtr< ISequencerSection > InSection,
FMovieSceneChannelHandle InChannel,
const FCurveModelID& InCurveId
)

 Constructor IKeyArea.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
TreeSerialNumber uint32 Serial number of the node tree from the last time this key area was seen IKeyArea.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ChannelHandle FMovieSceneChannelHandle Handle to the channel itself IKeyArea.h  
ChannelName FName The name of this channel. IKeyArea.h  
Color TOptional< FLinearColor > The color of this channel that should be drawn underneath its keys IKeyArea.h  
CurveModelID const TPimplPtr< FCurveModelID > Consistent ID that is reused and injected into the curve model every time it is created. IKeyArea.h  
DisplayText FText The display text of this channel. IKeyArea.h  
PropertyBindings TOptional< FTrackInstancePropertyBindings > Optional property bindings class where the section resides inside a UMovieScenePropertyTrack IKeyArea.h  
WeakSection TWeakPtr< ISequencerSection > A weak pointer back to the originating section interface that owns this channel IKeyArea.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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 IKeyArea.h  

bool CanCreateKeyEditor()

 Check whether this key area can create an editor on the sequencer node tree IKeyArea.h  

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

 Copy all the keys specified in KeyMask to the specified clipboard IKeyArea.h  

TUniquePtr< FCurveModel > CreateCurveEditorModel ( TSharedRef< ISequencer > InSequencer
) const

 Create a new model for this key area that can be used on the curve editor interface IKeyArea.h  

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

 Create an editor on the sequencer node tree IKeyArea.h  

void DeleteKeys ( TArrayView< const FKeyHandle > InHandles,
FFrameNumber InTime
)

 Delete the specified keys. IKeyArea.h  

int32 DrawExtra ( const FSequencerChannelPaintArgs& PaintArgs,
int32 LayerId
) const

 Draw additional content in addition to keys for a particular IKeyArea IKeyArea.h  

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

 Gather key drawing information for the specified key handles IKeyArea.h  

FKeyHandle DuplicateKey ( FKeyHandle InKeyHandle
) const

 Duplicate the key represented by the specified handle IKeyArea.h  
Locate the sequencer channel interface for this key area's channel IKeyArea.h  

const FMovieSceneChannelHandle & GetChannel()

 Access the channel handle that this key area represents IKeyArea.h  

FName GetChannelTypeName()

 Access the channel type identifier for the channel that this key area wraps IKeyArea.h  

TOptional< FLinearColor > GetColor()

 Get the color of this channel that should be drawn underneath its keys IKeyArea.h  

EMovieSceneKeyInterpolation GetInterpolationMode ( FFrameNumber InTime,
EMovieSceneKeyInterpolation DefaultMode
) const

 Retrieve the interpolation mode for this key area's channel for the specified time IKeyArea.h  

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

 Get all key handles that exist within the given time range IKeyArea.h  

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

 Populate the specified handle and/or time arrays with information pertaining to keys that exist within the given range IKeyArea.h  

TSharedPtr< FStructOnScope > GetKeyStruct ( FKeyHandle KeyHandle
) const

 Get a key structure for editing a value on this channel IKeyArea.h  

FFrameNumber GetKeyTime ( FKeyHandle InKeyHandle
) const

 Get the time of the key represented by the specified handle IKeyArea.h  

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

 Get the times of every key represented by the specified handles IKeyArea.h  

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

 Get all key times that exist within the given time range IKeyArea.h  

FName GetName()

 Get this key area's name IKeyArea.h  
Access object that owns the channel this key area represents. IKeyArea.h  

UMovieSceneSection * GetOwningSection()

 Access section that owns the channel this key area represents IKeyArea.h  

FRichCurve * GetRichCurve()

   IKeyArea.h  

TSharedPtr< ISequencerSection > GetSectionInterface()

 Access section editor interface IKeyArea.h  

TArray< FKeyHandle > PasteKeys ( const FMovieSceneClipboardKeyTrack& KeyTrack,
const FMovieSceneClipboardEnvironment& SrcEnvironment,
const FSequencerPasteEnvironment& DstEnvironment
)

 Paste the specified key track into this key area IKeyArea.h  

void Reinitialize ( TWeakPtr< ISequencerSection > InSection,
FMovieSceneChannelHandle InChannel
)

 Reinitialize this key area with a new channel IKeyArea.h  

FMovieSceneChannel * ResolveChannel()

 Resolve this key area's channel handle IKeyArea.h  

void SetKeyTime ( FKeyHandle InKeyHandle,
FFrameNumber InKeyTime
) const

 Set the time of the key with the specified handle IKeyArea.h  

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

 Set the times of the each key with the specified handles IKeyArea.h  

void SetName ( FName InName
)

 Set this key area's name IKeyArea.h  

bool ShouldShowCurve()

 Check whether we should show this key area's curve on its channel UI or not IKeyArea.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page