#include <MovieSceneChannel.h>

Inheritance diagram for FMovieSceneChannel:

Public Member Functions
	FMovieSceneChannel ()

virtual	~FMovieSceneChannel ()

MOVIESCENE_API void	GetKeyTime (const FKeyHandle InHandle, FFrameNumber &OutKeyTime)

MOVIESCENE_API void	SetKeyTime (const FKeyHandle InHandle, const FFrameNumber InKeyTime)

virtual void	GetKeys (const TRange< FFrameNumber > &WithinRange, TArray< FFrameNumber > OutKeyTimes, TArray< FKeyHandle > OutKeyHandles)

virtual void	GetKeyTimes (TArrayView< const FKeyHandle > InHandles, TArrayView< FFrameNumber > OutKeyTimes)

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

virtual void	DuplicateKeys (TArrayView< const FKeyHandle > InHandles, TArrayView< FKeyHandle > OutNewHandles)

virtual void	DeleteKeys (TArrayView< const FKeyHandle > InHandles)

virtual void	DeleteKeysFrom (FFrameNumber InTime, bool bDeleteKeysBefore)

virtual MOVIESCENE_API void	ChangeFrameResolution (FFrameRate SourceRate, FFrameRate DestinationRate)

virtual void	RemapTimes (const UE::MovieScene::IRetimingInterface &Retimer)

virtual TRange< FFrameNumber >	ComputeEffectiveRange () const

virtual int32	GetNumKeys () const

virtual void	Reset ()

virtual void	Offset (FFrameNumber DeltaPosition)

virtual void	Optimize (const FKeyDataOptimizationParams &InParameters)

virtual void	ClearDefault ()

virtual void	PostEditChange ()

virtual FKeyHandle	GetHandle (int32 Index)

virtual int32	GetIndex (FKeyHandle Handle)

FMovieSceneChannelDataKeyAddedEvent &	OnKeyAddedEvent ()

FMovieSceneChannelDataKeyDeletedEvent &	OnKeyDeletedEvent ()

FMovieSceneChannelDataKeyMovedEvent &	OnKeyMovedEvent ()

Protected Attributes
FMovieSceneChannelDataKeyAddedEvent	KeyAddedEvent

FMovieSceneChannelDataKeyDeletedEvent	KeyDeletedEvent

FMovieSceneChannelDataKeyMovedEvent	KeyMovedEvent

Constructor & Destructor Documentation

◆ FMovieSceneChannel()

FMovieSceneChannel::FMovieSceneChannel ( )

inline

◆ ~FMovieSceneChannel()

virtual FMovieSceneChannel::~FMovieSceneChannel ( )

inlinevirtual

Member Function Documentation

◆ ChangeFrameResolution()

void FMovieSceneChannel::ChangeFrameResolution	(	FFrameRate	SourceRate,
		FFrameRate	DestinationRate
	)

virtual

Called when the frame resolution of this channel is to be changed.

Parameters

SourceRate	The previous frame resolution that the channel is currently in
DestinationRate	The desired new frame resolution. All keys should be transformed into this time-base.

◆ ClearDefault()

virtual void FMovieSceneChannel::ClearDefault ( )

inlinevirtual

Clear all the default value on this channel

Reimplemented in FMovieSceneBoolChannel, FMovieSceneByteChannel, FMovieSceneDoubleChannel, FMovieSceneFloatChannel, FMovieSceneIntegerChannel, FMovieSceneObjectPathChannel, FMovieSceneStringChannel, FMovieSceneTextChannel, FMovieSceneActorReferenceData, and FMovieSceneEventSectionData.

◆ ComputeEffectiveRange()

virtual TRange< FFrameNumber > FMovieSceneChannel::ComputeEffectiveRange ( ) const

inlinevirtual

Compute the effective range of this channel, for example, the extents of its key times

Returns: A range that represents the greatest range of times occupied by this channel, in the sequence's frame resolution

Reimplemented in FMovieSceneAudioTriggerChannel, FMovieSceneBoolChannel, FMovieSceneByteChannel, FMovieSceneDoubleChannel, FMovieSceneFloatChannel, FMovieSceneIntegerChannel, FMovieSceneObjectPathChannel, FMovieSceneCameraShakeSourceTriggerChannel, FMovieSceneEventChannel, FMovieSceneStringChannel, FMovieSceneTextChannel, FMovieSceneActorReferenceData, and FMovieSceneEventSectionData.

◆ DeleteKeys()

virtual void FMovieSceneChannel::DeleteKeys ( TArrayView< const FKeyHandle > InHandles )

inlinevirtual

Delete the keys for the specified key handles

Parameters

InHandles Array of handles to delete

Reimplemented in FMovieSceneAudioTriggerChannel, FMovieSceneBoolChannel, FMovieSceneByteChannel, FMovieSceneDoubleChannel, FMovieSceneFloatChannel, FMovieSceneIntegerChannel, FMovieSceneObjectPathChannel, FMovieSceneCameraShakeSourceTriggerChannel, FMovieSceneEventChannel, FMovieSceneStringChannel, FMovieSceneTextChannel, FMovieSceneActorReferenceData, and FMovieSceneEventSectionData.

◆ DeleteKeysFrom()

virtual void FMovieSceneChannel::DeleteKeysFrom	(	FFrameNumber	InTime,
		bool	bDeleteKeysBefore
	)

inlinevirtual

Delete keys before or after a specified time

Parameters

InTime	Delete keys after this time
bDeleteKeysBefore	Whether to delete keys before the specified time

Reimplemented in FMovieSceneAudioTriggerChannel, FMovieSceneBoolChannel, FMovieSceneByteChannel, FMovieSceneDoubleChannel, FMovieSceneFloatChannel, FMovieSceneIntegerChannel, FMovieSceneObjectPathChannel, FMovieSceneCameraShakeSourceTriggerChannel, FMovieSceneEventChannel, FMovieSceneStringChannel, FMovieSceneTextChannel, FMovieSceneActorReferenceData, and FMovieSceneEventSectionData.

◆ DuplicateKeys()

virtual void FMovieSceneChannel::DuplicateKeys	(	TArrayView< const FKeyHandle >	InHandles,
		TArrayView< FKeyHandle >	OutNewHandles
	)

inlinevirtual

Duplicate the keys for the specified key handles

Parameters

InHandles	Array of handles to duplicate
OutKeyTimes	Pre-sized array to receive duplicated key handles. Invalid key handles will not be assigned to this array. Must match size of InHandles

Reimplemented in FMovieSceneAudioTriggerChannel, FMovieSceneBoolChannel, FMovieSceneByteChannel, FMovieSceneDoubleChannel, FMovieSceneFloatChannel, FMovieSceneIntegerChannel, FMovieSceneObjectPathChannel, FMovieSceneCameraShakeSourceTriggerChannel, FMovieSceneEventChannel, FMovieSceneStringChannel, FMovieSceneTextChannel, FMovieSceneActorReferenceData, and FMovieSceneEventSectionData.

◆ GetHandle()

virtual FKeyHandle FMovieSceneChannel::GetHandle ( int32 Index )

inlinevirtual

Retrieve a key handle for the specified key time index

Parameters

Index The index to retrieve

Returns: A key handle that identifies the key at the specified index, regardless of re-ordering

Reimplemented in FMovieSceneAudioTriggerChannel, FMovieSceneBoolChannel, FMovieSceneDoubleChannel, FMovieSceneFloatChannel, FMovieSceneIntegerChannel, FMovieSceneObjectPathChannel, FMovieSceneEventChannel, FMovieSceneStringChannel, FMovieSceneActorReferenceData, and FMovieSceneEventSectionData.

◆ GetIndex()

virtual int32 FMovieSceneChannel::GetIndex ( FKeyHandle Handle )

inlinevirtual

Attempt to retrieve the index of key from its handle

Parameters

Handle The handle to retrieve

Returns: The index of the key, or INDEX_NONE

Reimplemented in FMovieSceneAudioTriggerChannel, FMovieSceneBoolChannel, FMovieSceneDoubleChannel, FMovieSceneFloatChannel, FMovieSceneIntegerChannel, FMovieSceneObjectPathChannel, FMovieSceneEventChannel, FMovieSceneStringChannel, FMovieSceneActorReferenceData, and FMovieSceneEventSectionData.

◆ GetKeys()

virtual void FMovieSceneChannel::GetKeys	(	const TRange< FFrameNumber > &	WithinRange,
		TArray< FFrameNumber > *	OutKeyTimes,
		TArray< FKeyHandle > *	OutKeyHandles
	)

inlinevirtual

Get key information pertaining to all keys that exist within the specified range

Parameters

WithinRange	The range within which to return key information
OutKeyTimes	(Optional) Array to receive key times
OutKeyHandles	(Optional) Array to receive key handles

Reimplemented in FMovieSceneAudioTriggerChannel, FMovieSceneBoolChannel, FMovieSceneByteChannel, FMovieSceneDoubleChannel, FMovieSceneFloatChannel, FMovieSceneIntegerChannel, FMovieSceneObjectPathChannel, FMovieSceneCameraShakeSourceTriggerChannel, FMovieSceneEventChannel, FMovieSceneStringChannel, FMovieSceneTextChannel, FMovieSceneActorReferenceData, and FMovieSceneEventSectionData.

◆ GetKeyTime()

void FMovieSceneChannel::GetKeyTime	(	const FKeyHandle	InHandle,
		FFrameNumber &	OutKeyTime
	)

Get the time for the specified key handle

Parameters

InHandle	The handle of the key to get the time for
OutKeyTime	Out parameter to receive the key's time

◆ GetKeyTimes()

virtual void FMovieSceneChannel::GetKeyTimes	(	TArrayView< const FKeyHandle >	InHandles,
		TArrayView< FFrameNumber >	OutKeyTimes
	)

inlinevirtual

Get all key times for the specified key handles

Parameters

InHandles	Array of handles to get times for
OutKeyTimes	Pre-sized array of key times to set. Invalid key handles will not assign to this array. Must match size of InHandles

Reimplemented in FMovieSceneAudioTriggerChannel, FMovieSceneBoolChannel, FMovieSceneByteChannel, FMovieSceneDoubleChannel, FMovieSceneFloatChannel, FMovieSceneIntegerChannel, FMovieSceneObjectPathChannel, FMovieSceneCameraShakeSourceTriggerChannel, FMovieSceneEventChannel, FMovieSceneStringChannel, FMovieSceneTextChannel, FMovieSceneActorReferenceData, and FMovieSceneEventSectionData.

◆ GetNumKeys()

virtual int32 FMovieSceneChannel::GetNumKeys ( ) const

inlinevirtual

Get the total number of keys on this channel

Returns: The number of keys on this channel

Reimplemented in FMovieSceneAudioTriggerChannel, FMovieSceneBoolChannel, FMovieSceneByteChannel, FMovieSceneDoubleChannel, FMovieSceneFloatChannel, FMovieSceneIntegerChannel, FMovieSceneObjectPathChannel, FMovieSceneCameraShakeSourceTriggerChannel, FMovieSceneEventChannel, FMovieSceneStringChannel, FMovieSceneTextChannel, FMovieSceneActorReferenceData, and FMovieSceneEventSectionData.

◆ Offset()

virtual void FMovieSceneChannel::Offset ( FFrameNumber DeltaPosition )

inlinevirtual

Offset the keys within this channel by a given delta position

Parameters

DeltaPosition The number of frames to offset by, in the sequence's frame resolution

Reimplemented in FMovieSceneAudioTriggerChannel, FMovieSceneBoolChannel, FMovieSceneByteChannel, FMovieSceneDoubleChannel, FMovieSceneFloatChannel, FMovieSceneIntegerChannel, FMovieSceneObjectPathChannel, FMovieSceneCameraShakeSourceTriggerChannel, FMovieSceneEventChannel, FMovieSceneStringChannel, FMovieSceneTextChannel, FMovieSceneActorReferenceData, and FMovieSceneEventSectionData.

◆ OnKeyAddedEvent()

FMovieSceneChannelDataKeyAddedEvent & FMovieSceneChannel::OnKeyAddedEvent ( )

inline

Get delegate that's called when a key is added

Returns: Returns key added event delegate

◆ OnKeyDeletedEvent()

FMovieSceneChannelDataKeyDeletedEvent & FMovieSceneChannel::OnKeyDeletedEvent ( )

inline

Get delegate that's called when a key is deleted

Returns: Returns key deleted event delegate

◆ OnKeyMovedEvent()

FMovieSceneChannelDataKeyMovedEvent & FMovieSceneChannel::OnKeyMovedEvent ( )

inline

Get delegate that's called when a key is moved

Returns: Returns key moved event delegate

◆ Optimize()

virtual void FMovieSceneChannel::Optimize ( const FKeyDataOptimizationParams & InParameters )

inlinevirtual

Optimize this channel by removing any redundant data according to the specified parameters

Parameters

InParameters Parameter struct specifying how to optimize the channel

Reimplemented in FMovieSceneAudioTriggerChannel, FMovieSceneBoolChannel, FMovieSceneByteChannel, FMovieSceneDoubleChannel, FMovieSceneFloatChannel, FMovieSceneIntegerChannel, FMovieSceneObjectPathChannel, FMovieSceneStringChannel, FMovieSceneTextChannel, and FMovieSceneEventSectionData.

◆ PostEditChange()

virtual void FMovieSceneChannel::PostEditChange ( )

inlinevirtual

Perform a possibly heavy operation after an edit change

Reimplemented in FMovieSceneDoubleChannel, and FMovieSceneFloatChannel.

◆ RemapTimes()

virtual void FMovieSceneChannel::RemapTimes ( const UE::MovieScene::IRetimingInterface & Retimer )

inlinevirtual

Remap the times contained within this channel using a custom remapper

Reimplemented in FMovieSceneAudioTriggerChannel, FMovieSceneBoolChannel, FMovieSceneByteChannel, FMovieSceneDoubleChannel, FMovieSceneFloatChannel, FMovieSceneIntegerChannel, FMovieSceneObjectPathChannel, FMovieSceneCameraShakeSourceTriggerChannel, FMovieSceneEventChannel, FMovieSceneStringChannel, FMovieSceneTextChannel, FMovieSceneActorReferenceData, and FMovieSceneEventSectionData.

◆ Reset()

virtual void FMovieSceneChannel::Reset ( )

inlinevirtual

Reset this channel back to its original state

Reimplemented in FMovieSceneAudioTriggerChannel, FMovieSceneBoolChannel, FMovieSceneByteChannel, FMovieSceneDoubleChannel, FMovieSceneFloatChannel, FMovieSceneIntegerChannel, FMovieSceneObjectPathChannel, FMovieSceneCameraShakeSourceTriggerChannel, FMovieSceneEventChannel, FMovieSceneStringChannel, FMovieSceneTextChannel, FMovieSceneActorReferenceData, and FMovieSceneEventSectionData.

◆ SetKeyTime()

void FMovieSceneChannel::SetKeyTime	(	const FKeyHandle	InHandle,
		const FFrameNumber	InKeyTime
	)

Set the time for the specified key handle

Parameters

InHandle	The handle of the key to get the time for
InKeyTime	The new time for the key

◆ SetKeyTimes()

virtual void FMovieSceneChannel::SetKeyTimes	(	TArrayView< const FKeyHandle >	InHandles,
		TArrayView< const FFrameNumber >	InKeyTimes
	)

inlinevirtual

Set key times for the specified key handles

Parameters

InHandles	Array of handles to get times for
InKeyTimes	Array of times to apply - one per handle

Reimplemented in FMovieSceneAudioTriggerChannel, FMovieSceneBoolChannel, FMovieSceneByteChannel, FMovieSceneDoubleChannel, FMovieSceneFloatChannel, FMovieSceneIntegerChannel, FMovieSceneObjectPathChannel, FMovieSceneCameraShakeSourceTriggerChannel, FMovieSceneEventChannel, FMovieSceneStringChannel, FMovieSceneTextChannel, FMovieSceneActorReferenceData, and FMovieSceneEventSectionData.

Member Data Documentation

◆ KeyAddedEvent

FMovieSceneChannelDataKeyAddedEvent FMovieSceneChannel::KeyAddedEvent

protected

Broadcasts a notification whenever key is added

◆ KeyDeletedEvent

FMovieSceneChannelDataKeyDeletedEvent FMovieSceneChannel::KeyDeletedEvent

protected

Broadcasts a notification whenever key is deleted

◆ KeyMovedEvent

FMovieSceneChannelDataKeyMovedEvent FMovieSceneChannel::KeyMovedEvent

protected

Broadcasts a notification whenever key is moved

The documentation for this struct was generated from the following files:

Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneChannel.h
Engine/Source/Runtime/MovieScene/Private/Channels/MovieSceneChannel.cpp

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ FMovieSceneChannel()

◆ ~FMovieSceneChannel()

Member Function Documentation

◆ ChangeFrameResolution()

◆ ClearDefault()

◆ ComputeEffectiveRange()

◆ DeleteKeys()

◆ DeleteKeysFrom()

◆ DuplicateKeys()

◆ GetHandle()

◆ GetIndex()

◆ GetKeys()

◆ GetKeyTime()

◆ GetKeyTimes()

◆ GetNumKeys()

◆ Offset()

◆ OnKeyAddedEvent()

◆ OnKeyDeletedEvent()

◆ OnKeyMovedEvent()

◆ Optimize()

◆ PostEditChange()

◆ RemapTimes()

◆ Reset()

◆ SetKeyTime()

◆ SetKeyTimes()

Member Data Documentation

◆ KeyAddedEvent

◆ KeyDeletedEvent

◆ KeyMovedEvent