Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > Sequencer > IKeyArea

Light Theme

Dark Theme

IKeyArea

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

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

IKeyArea

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

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

Constructors

	Name	Description
	IKeyArea ( TWeakPtr< ISequencerSection > InSec..., FMovieSceneChannelHandle InChannel )	Constructor

Functions

	Name	Description
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
bool	CanCreateKeyEditor()	Check whether this key area can create an editor on the sequencer node tree
void	CopyKeys ( FMovieSceneClipboardBuilder& Clipb..., TArrayView< const FKeyHandle > KeyM... )	Copy all the keys specified in KeyMask to the specified clipboard
TUniquePtr< ...	CreateCurveEditorModel ( TSharedRef< ISequencer > InSequence... )	Create a new model for this key area that can be used on the curve editor interface
TSharedRef< ...	CreateKeyEditor ( TWeakPtr< ISequencer > Sequencer, const FGuid& ObjectBindingID )	Create an editor on the sequencer node tree
void	DrawKeys ( TArrayView< const FKeyHandle > InKe..., TArrayView< FKeyDrawParams > OutKey... )	Gather key drawing information for the specified key handles
FKeyHandle	DuplicateKey ( FKeyHandle InKeyHandle )	Duplicate the key represented by the specified handle
ISequencerCh...	FindChannelEditorInterface()	Locate the sequencer channel interface for this key area's channel @note Channel interfaces are registered via ISequencerModule::RegisterChannelInterface
const FMovie...	GetChannel()	Access the channel handle that this key area represents
FName	GetChannelTypeName()	Access the channel type identifier for the channel that this key area wraps
TOptional< F...	GetColor()	Get the color of this channel that should be drawn underneath its keys
void	GetKeyHandles ( TArray< FKeyHandle >& OutHandles, const TRange< FFrameNumber >& With... )	Get all key handles that exist within the given time range
void	GetKeyInfo ( TArray< FKeyHandle >* OutHandl..., TArray< FFrameNumber >* OutTim..., const TRange< FFrameNumber >& With... )	Populate the specified handle and/or time arrays with information pertaining to keys that exist within the given range
TSharedPtr< ...	GetKeyStruct ( FKeyHandle KeyHandle )	Get a key structure for editing a value on this channel
FFrameNumber	GetKeyTime ( FKeyHandle InKeyHandle )	Get the time of the key represented by the specified handle
void	GetKeyTimes ( TArrayView< const FKeyHandle > InKe..., TArrayView< FFrameNumber > OutTimes )	Get the times of every key represented by the specified handles
void	GetKeyTimes ( TArray< FFrameNumber >& OutTimes, const TRange< FFrameNumber >& With... )	Get all key times that exist within the given time range
FName	GetName()	Get this key area's name
UMovieSceneS...	GetOwningSection()	Access section that owns the channel this key area represents
FRichCurve &...	GetRichCurve()
TSharedPtr< ...	GetSectionInterface()	Access section editor interface
void	PasteKeys ( const FMovieSceneClipboardKeyTrack ..., const FMovieSceneClipboardEnvironme..., const FSequencerPasteEnvironment& ... )	Paste the specified key track into this key area
void	Reinitialize ( TWeakPtr< ISequencerSection > InSec..., FMovieSceneChannelHandle InChannel )	Reinitialize this key area with a new channel
FMovieSceneC...	ResolveChannel()	Resolve this key area's channel handle
void	SetKeyTime ( FKeyHandle InKeyHandle, FFrameNumber InKeyTime )	Set the time of the key with the specified handle
void	SetKeyTimes ( TArrayView< const FKeyHandle > InKe..., TArrayView< const FFrameNumber > In... )	Set the times of the each key with the specified handles
void	SetName ( FName InName )	Set this key area's name

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss