#include <MovieSceneTextChannel.h>

Inheritance diagram for FMovieSceneTextChannel:

Public Types
typedef FText	CurveValueType

Public Member Functions
TMovieSceneChannelData< FText >	GetData ()

TMovieSceneChannelData< const FText >	GetData () const

TConstArrayView< FFrameNumber >	GetTimes () const

bool	HasAnyData () const

MOVIESCENETRACKS_API const FText *	Evaluate (FFrameTime InTime) const

void	AddKeys (const TArray< FFrameNumber > &InTimes, const TArray< FText > &InValues)

void	SetDefault (FText InDefaultValue)

TOptional< FText >	GetDefault () const

void	RemoveDefault ()

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

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

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

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

virtual MOVIESCENETRACKS_API void	DeleteKeys (TArrayView< const FKeyHandle > InHandles) override

virtual MOVIESCENETRACKS_API void	DeleteKeysFrom (FFrameNumber InTime, bool bDeleteKeysBefore) override

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

virtual MOVIESCENETRACKS_API TRange< FFrameNumber >	ComputeEffectiveRange () const override

virtual MOVIESCENETRACKS_API int32	GetNumKeys () const override

virtual MOVIESCENETRACKS_API void	Reset () override

virtual MOVIESCENETRACKS_API void	Offset (FFrameNumber DeltaPosition) override

virtual MOVIESCENETRACKS_API void	Optimize (const FKeyDataOptimizationParams &InParameters) override

virtual MOVIESCENETRACKS_API void	ClearDefault () override

Public Member Functions inherited from FMovieSceneChannel
	FMovieSceneChannel ()

virtual	~FMovieSceneChannel ()

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

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

virtual MOVIESCENE_API void	ChangeFrameResolution (FFrameRate SourceRate, FFrameRate DestinationRate)

virtual void	PostEditChange ()

virtual FKeyHandle	GetHandle (int32 Index)

virtual int32	GetIndex (FKeyHandle Handle)

FMovieSceneChannelDataKeyAddedEvent &	OnKeyAddedEvent ()

FMovieSceneChannelDataKeyDeletedEvent &	OnKeyDeletedEvent ()

FMovieSceneChannelDataKeyMovedEvent &	OnKeyMovedEvent ()

Additional Inherited Members
Protected Attributes inherited from FMovieSceneChannel
FMovieSceneChannelDataKeyAddedEvent	KeyAddedEvent

FMovieSceneChannelDataKeyDeletedEvent	KeyDeletedEvent

FMovieSceneChannelDataKeyMovedEvent	KeyMovedEvent

Member Typedef Documentation

◆ CurveValueType

typedef FText FMovieSceneTextChannel::CurveValueType

Member Function Documentation

◆ AddKeys()

void FMovieSceneTextChannel::AddKeys	(	const TArray< FFrameNumber > &	InTimes,
		const TArray< FText > &	InValues
	)

inline

Add keys with these times to channel. The number of elements in both arrays much match or nothing is added.

Parameters

InTimes	Times to add
InValues	Values to add

◆ ClearDefault()

void FMovieSceneTextChannel::ClearDefault ( )

overridevirtual

Clear all the default value on this channel

Reimplemented from FMovieSceneChannel.

◆ ComputeEffectiveRange()

TRange< FFrameNumber > FMovieSceneTextChannel::ComputeEffectiveRange ( ) const

overridevirtual

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 from FMovieSceneChannel.

◆ DeleteKeys()

void FMovieSceneTextChannel::DeleteKeys ( TArrayView< const FKeyHandle > InHandles )

overridevirtual

Delete the keys for the specified key handles

Parameters

InHandles Array of handles to delete

Reimplemented from FMovieSceneChannel.

◆ DeleteKeysFrom()

void FMovieSceneTextChannel::DeleteKeysFrom	(	FFrameNumber	InTime,
		bool	bDeleteKeysBefore
	)

overridevirtual

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 from FMovieSceneChannel.

◆ DuplicateKeys()

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

overridevirtual

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 from FMovieSceneChannel.

◆ Evaluate()

const FText * FMovieSceneTextChannel::Evaluate ( FFrameTime InTime ) const

Evaluate this channel

Parameters

InTime The time to evaluate at

Returns: A pointer to the string, or nullptr

◆ GetData() [1/2]

TMovieSceneChannelData< FText > FMovieSceneTextChannel::GetData ( )

inline

Access a mutable interface for this channel's data

Returns: An object that is able to manipulate this channel's data

◆ GetData() [2/2]

TMovieSceneChannelData< const FText > FMovieSceneTextChannel::GetData ( ) const

inline

Access a constant interface for this channel's data

Returns: An object that is able to interrogate this channel's data

◆ GetDefault()

TOptional< FText > FMovieSceneTextChannel::GetDefault ( ) const

inline

Get this channel's default value that will be used when no keys are present

Returns: (Optional) The channel's default value

◆ GetKeys()

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

overridevirtual

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 from FMovieSceneChannel.

◆ GetKeyTimes()

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

overridevirtual

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 from FMovieSceneChannel.

◆ GetNumKeys()

int32 FMovieSceneTextChannel::GetNumKeys ( ) const

overridevirtual

Get the total number of keys on this channel

Returns: The number of keys on this channel

Reimplemented from FMovieSceneChannel.

◆ GetTimes()

TConstArrayView< FFrameNumber > FMovieSceneTextChannel::GetTimes ( ) const

inline

◆ HasAnyData()

bool FMovieSceneTextChannel::HasAnyData ( ) const

inline

Returns whether this channel has any values

◆ Offset()

void FMovieSceneTextChannel::Offset ( FFrameNumber DeltaPosition )

overridevirtual

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 from FMovieSceneChannel.

◆ Optimize()

void FMovieSceneTextChannel::Optimize ( const FKeyDataOptimizationParams & InParameters )

overridevirtual

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

Parameters

InParameters Parameter struct specifying how to optimize the channel

Reimplemented from FMovieSceneChannel.

◆ RemapTimes()

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

overridevirtual

Remap the times contained within this channel using a custom remapper

Reimplemented from FMovieSceneChannel.

◆ RemoveDefault()

void FMovieSceneTextChannel::RemoveDefault ( )

inline

Remove this channel's default value causing the channel to have no effect where no keys are present

◆ Reset()

void FMovieSceneTextChannel::Reset ( )

overridevirtual

Reset this channel back to its original state

Reimplemented from FMovieSceneChannel.

◆ SetDefault()

void FMovieSceneTextChannel::SetDefault ( FText InDefaultValue )

inline

Set this channel's default value that should be used when no keys are present

Parameters

InDefaultValue The desired default value

◆ SetKeyTimes()

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

overridevirtual

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 from FMovieSceneChannel.

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

Engine/Source/Runtime/MovieSceneTracks/Public/Channels/MovieSceneTextChannel.h
Engine/Source/Runtime/MovieSceneTracks/Private/Channels/MovieSceneTextChannel.cpp

Public Types

Public Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ CurveValueType

Member Function Documentation

◆ AddKeys()

◆ ClearDefault()

◆ ComputeEffectiveRange()

◆ DeleteKeys()

◆ DeleteKeysFrom()

◆ DuplicateKeys()

◆ Evaluate()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ GetDefault()

◆ GetKeys()

◆ GetKeyTimes()

◆ GetNumKeys()

◆ GetTimes()

◆ HasAnyData()

◆ Offset()

◆ Optimize()

◆ RemapTimes()

◆ RemoveDefault()

◆ Reset()

◆ SetDefault()

◆ SetKeyTimes()