#include <MovieSceneFloatChannel.h>

Inheritance diagram for FMovieSceneFloatChannel:

Public Types
typedef float	CurveValueType

typedef FMovieSceneFloatValue	ChannelValueType

Public Member Functions
MOVIESCENE_API	FMovieSceneFloatChannel ()

virtual MOVIESCENE_API	~FMovieSceneFloatChannel ()

MOVIESCENE_API UE::MovieScene::Interpolation::FInterpolationExtents	ComputeExtents (FFrameTime StartTime, FFrameTime EndTime) const

MOVIESCENE_API UE::MovieScene::FPiecewiseCurve	AsPiecewiseCurve (bool bWithPreAndPostInfinityExtrap=true) const

TMovieSceneChannelData< FMovieSceneFloatValue >	GetData ()

TMovieSceneChannelData< const FMovieSceneFloatValue >	GetData () const

TArrayView< const FFrameNumber >	GetTimes () const

TArrayView< const FMovieSceneFloatValue >	GetValues () const

MOVIESCENE_API bool	Evaluate (FFrameTime InTime, float &OutValue) const

MOVIESCENE_API UE::MovieScene::Interpolation::FCachedInterpolation	GetInterpolationForTime (FFrameTime InTime) const

MOVIESCENE_API void	Set (TArray< FFrameNumber > InTimes, TArray< FMovieSceneFloatValue > InValues)

MOVIESCENE_API void	SetKeysOnly (TArrayView< FFrameNumber > InTimes, TArrayView< FMovieSceneFloatValue > InValues)

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

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

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

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

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

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

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

virtual MOVIESCENE_API TRange< FFrameNumber >	ComputeEffectiveRange () const override

virtual MOVIESCENE_API int32	GetNumKeys () const override

virtual MOVIESCENE_API void	Reset () override

virtual MOVIESCENE_API void	Offset (FFrameNumber DeltaPosition) override

virtual MOVIESCENE_API void	Optimize (const FKeyDataOptimizationParams &InParameters) override

virtual MOVIESCENE_API void	ClearDefault () override

virtual MOVIESCENE_API void	PostEditChange () override

virtual MOVIESCENE_API FKeyHandle	GetHandle (int32 Index) override

virtual MOVIESCENE_API int32	GetIndex (FKeyHandle Handle) override

bool	HasAnyData () const

void	SetDefault (float InDefaultValue)

TOptional< float >	GetDefault () const

void	RemoveDefault ()

MOVIESCENE_API bool	Serialize (FArchive &Ar)

MOVIESCENE_API bool	SerializeFromMismatchedTag (const FPropertyTag &Tag, FStructuredArchive::FSlot Slot)

MOVIESCENE_API int32	AddConstantKey (FFrameNumber InTime, float InValue)

MOVIESCENE_API int32	AddLinearKey (FFrameNumber InTime, float InValue)

MOVIESCENE_API int32	AddCubicKey (FFrameNumber InTime, float InValue, ERichCurveTangentMode TangentMode=RCTM_Auto, const FMovieSceneTangentData &Tangent=FMovieSceneTangentData())

MOVIESCENE_API void	AutoSetTangents (float Tension=0.f)

FFrameRate	GetTickResolution () const

void	SetTickResolution (FFrameRate InTickSolution)

MOVIESCENE_API void	PopulateCurvePoints (double StartTimeSeconds, double EndTimeSeconds, double TimeThreshold, float ValueThreshold, FFrameRate TickResolution, TArray< TTuple< double, double > > &InOutPoints) const

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

MOVIESCENE_API void	UpdateOrAddKeys (const TArrayView< const FFrameNumber > InTimes, const TArrayView< FMovieSceneFloatValue > InValues)

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)

FMovieSceneChannelDataKeyAddedEvent &	OnKeyAddedEvent ()

FMovieSceneChannelDataKeyDeletedEvent &	OnKeyDeletedEvent ()

FMovieSceneChannelDataKeyMovedEvent &	OnKeyMovedEvent ()

Public Attributes
TEnumAsByte< ERichCurveExtrapolation >	PreInfinityExtrap

TEnumAsByte< ERichCurveExtrapolation >	PostInfinityExtrap

Friends
struct	TMovieSceneCurveChannelImpl< FMovieSceneFloatChannel >

FArchive &	operator<< (FArchive &Ar, FMovieSceneFloatChannel &Me)

Additional Inherited Members
Protected Attributes inherited from FMovieSceneChannel
FMovieSceneChannelDataKeyAddedEvent	KeyAddedEvent

FMovieSceneChannelDataKeyDeletedEvent	KeyDeletedEvent

FMovieSceneChannelDataKeyMovedEvent	KeyMovedEvent

Member Typedef Documentation

◆ ChannelValueType

typedef FMovieSceneFloatValue FMovieSceneFloatChannel::ChannelValueType

◆ CurveValueType

typedef float FMovieSceneFloatChannel::CurveValueType

Constructor & Destructor Documentation

◆ FMovieSceneFloatChannel()

FMovieSceneFloatChannel::FMovieSceneFloatChannel ( )

◆ ~FMovieSceneFloatChannel()

FMovieSceneFloatChannel::~FMovieSceneFloatChannel ( )

virtualdefault

Member Function Documentation

◆ AddConstantKey()

int32 FMovieSceneFloatChannel::AddConstantKey	(	FFrameNumber	InTime,
		float	InValue
	)

◆ AddCubicKey()

int32 FMovieSceneFloatChannel::AddCubicKey	(	FFrameNumber	InTime,
		float	InValue,
		ERichCurveTangentMode	TangentMode = `RCTM_Auto`,
		const FMovieSceneTangentData &	Tangent = `FMovieSceneTangentData()`
	)

◆ AddKeys()

void FMovieSceneFloatChannel::AddKeys	(	const TArray< FFrameNumber > &	InTimes,
		const TArray< FMovieSceneFloatValue > &	InValues
	)

Add keys with these times to channel. The number of elements in both arrays much match or nothing is added. Also assume that the times are greater than last time in the channel and are increasing. If not bad things can happen.

Parameters

InTimes	Times to add
InValues	Values to add

◆ AddLinearKey()

int32 FMovieSceneFloatChannel::AddLinearKey	(	FFrameNumber	InTime,
		float	InValue
	)

◆ AsPiecewiseCurve()

UE::MovieScene::FPiecewiseCurve FMovieSceneFloatChannel::AsPiecewiseCurve ( bool bWithPreAndPostInfinityExtrap = true ) const

◆ AutoSetTangents()

void FMovieSceneFloatChannel::AutoSetTangents ( float Tension = 0.f )

◆ ClearDefault()

void FMovieSceneFloatChannel::ClearDefault ( )

overridevirtual

Clear all the default value on this channel

Reimplemented from FMovieSceneChannel.

◆ ComputeEffectiveRange()

TRange< FFrameNumber > FMovieSceneFloatChannel::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.

◆ ComputeExtents()

UE::MovieScene::Interpolation::FInterpolationExtents FMovieSceneFloatChannel::ComputeExtents	(	FFrameTime	StartTime,
		FFrameTime	EndTime
	)		const

Compute the value extents of this curve within the specified limits

Parameters

StartTime	The start of the range within which to compute extents
EndTime	The end of the range within which to compute extents

Returns: The extents of this channel

◆ DeleteKeys()

void FMovieSceneFloatChannel::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 FMovieSceneFloatChannel::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 FMovieSceneFloatChannel::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()

bool FMovieSceneFloatChannel::Evaluate	(	FFrameTime	InTime,
		float &	OutValue
	)		const

Evaluate this channel with the frame resolution

Parameters

InTime	The time to evaluate at
InTime	The Frame Rate the time to evaluate at
OutValue	A value to receive the result

Returns: true if the channel was evaluated successfully, false otherwise

◆ GetData() [1/2]

TMovieSceneChannelData< FMovieSceneFloatValue > FMovieSceneFloatChannel::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 FMovieSceneFloatValue > FMovieSceneFloatChannel::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< float > FMovieSceneFloatChannel::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

◆ GetHandle()

FKeyHandle FMovieSceneFloatChannel::GetHandle ( int32 Index )

overridevirtual

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

◆ GetIndex()

int32 FMovieSceneFloatChannel::GetIndex ( FKeyHandle Handle )

overridevirtual

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

◆ GetInterpolationForTime()

UE::MovieScene::Interpolation::FCachedInterpolation FMovieSceneFloatChannel::GetInterpolationForTime ( FFrameTime InTime ) const

Retrieve a cached interpolation from this channel for the specified time

◆ GetKeys()

void FMovieSceneFloatChannel::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 FMovieSceneFloatChannel::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 FMovieSceneFloatChannel::GetNumKeys ( ) const

overridevirtual

Get the total number of keys on this channel

Returns: The number of keys on this channel

Reimplemented from FMovieSceneChannel.

◆ GetTickResolution()

FFrameRate FMovieSceneFloatChannel::GetTickResolution ( ) const

inline

Get the channel's frame resolution

◆ GetTimes()

TArrayView< const FFrameNumber > FMovieSceneFloatChannel::GetTimes ( ) const

inline

Const access to this channel's times

◆ GetValues()

TArrayView< const FMovieSceneFloatValue > FMovieSceneFloatChannel::GetValues ( ) const

inline

Const access to this channel's values

◆ HasAnyData()

bool FMovieSceneFloatChannel::HasAnyData ( ) const

inline

Check whether this channel has any data

◆ Offset()

void FMovieSceneFloatChannel::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 FMovieSceneFloatChannel::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.

◆ PopulateCurvePoints()

void FMovieSceneFloatChannel::PopulateCurvePoints	(	double	StartTimeSeconds,
		double	EndTimeSeconds,
		double	TimeThreshold,
		float	ValueThreshold,
		FFrameRate	TickResolution,
		TArray< TTuple< double, double > > &	InOutPoints
	)		const

Populate the specified array with times and values that represent the smooth interpolation of this channel across the specified range

Parameters

StartTimeSeconds	The first time in seconds to include in the resulting array
EndTimeSeconds	The last time in seconds to include in the resulting array
TimeThreshold	A small time threshold in seconds below which we should stop adding new points
ValueThreshold	A small value threshold below which we should stop adding new points where the linear interpolation would suffice
TickResolution	The tick resolution with which to interpret this channel's times
InOutPoints	An array to populate with the evaluated points

◆ PostEditChange()

void FMovieSceneFloatChannel::PostEditChange ( )

overridevirtual

Perform a possibly heavy operation after an edit change

Reimplemented from FMovieSceneChannel.

◆ RemapTimes()

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

overridevirtual

Remap the times contained within this channel using a custom remapper

Reimplemented from FMovieSceneChannel.

◆ RemoveDefault()

void FMovieSceneFloatChannel::RemoveDefault ( )

inline

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

◆ Reset()

void FMovieSceneFloatChannel::Reset ( )

overridevirtual

Reset this channel back to its original state

Reimplemented from FMovieSceneChannel.

◆ Serialize()

bool FMovieSceneFloatChannel::Serialize ( FArchive & Ar )

◆ SerializeFromMismatchedTag()

bool FMovieSceneFloatChannel::SerializeFromMismatchedTag	(	const FPropertyTag &	Tag,
		FStructuredArchive::FSlot	Slot
	)

Serialize this float function from a mismatching property tag (FRichCurve)

◆ Set()

void FMovieSceneFloatChannel::Set	(	TArray< FFrameNumber >	InTimes,
		TArray< FMovieSceneFloatValue >	InValues
	)

Set the channel's times and values to the requested values

◆ SetDefault()

void FMovieSceneFloatChannel::SetDefault ( float InDefaultValue )

inline

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

Parameters

InDefaultValue The desired default value

◆ SetKeysOnly()

void FMovieSceneFloatChannel::SetKeysOnly	(	TArrayView< FFrameNumber >	InTimes,
		TArrayView< FMovieSceneFloatValue >	InValues
	)

Set the channel's times and values to the requested values, but does not allocate key handles

◆ SetKeyTimes()

void FMovieSceneFloatChannel::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.

◆ SetTickResolution()

void FMovieSceneFloatChannel::SetTickResolution ( FFrameRate InTickSolution )

inline

Set the channel's frame resolution

◆ UpdateOrAddKeys()

void FMovieSceneFloatChannel::UpdateOrAddKeys	(	const TArrayView< const FFrameNumber >	InTimes,
		const TArrayView< FMovieSceneFloatValue >	InValues
	)

Friends And Related Symbol Documentation

◆ operator<<

FArchive & operator<<	(	FArchive &	Ar,
		FMovieSceneFloatChannel &	Me
	)

friend

◆ TMovieSceneCurveChannelImpl< FMovieSceneFloatChannel >

friend struct TMovieSceneCurveChannelImpl< FMovieSceneFloatChannel >

friend

Member Data Documentation

◆ PostInfinityExtrap

TEnumAsByte<ERichCurveExtrapolation> FMovieSceneFloatChannel::PostInfinityExtrap

Post-infinity extrapolation state

◆ PreInfinityExtrap

TEnumAsByte<ERichCurveExtrapolation> FMovieSceneFloatChannel::PreInfinityExtrap

Pre-infinity extrapolation state

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

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

Public Types

Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ ChannelValueType

◆ CurveValueType

Constructor & Destructor Documentation

◆ FMovieSceneFloatChannel()

◆ ~FMovieSceneFloatChannel()

Member Function Documentation

◆ AddConstantKey()

◆ AddCubicKey()

◆ AddKeys()

◆ AddLinearKey()

◆ AsPiecewiseCurve()

◆ AutoSetTangents()

◆ ClearDefault()

◆ ComputeEffectiveRange()

◆ ComputeExtents()

◆ DeleteKeys()

◆ DeleteKeysFrom()

◆ DuplicateKeys()

◆ Evaluate()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ GetDefault()

◆ GetHandle()

◆ GetIndex()

◆ GetInterpolationForTime()

◆ GetKeys()

◆ GetKeyTimes()

◆ GetNumKeys()

◆ GetTickResolution()

◆ GetTimes()

◆ GetValues()

◆ HasAnyData()

◆ Offset()

◆ Optimize()

◆ PopulateCurvePoints()

◆ PostEditChange()

◆ RemapTimes()

◆ RemoveDefault()

◆ Reset()

◆ Serialize()

◆ SerializeFromMismatchedTag()

◆ Set()

◆ SetDefault()

◆ SetKeysOnly()

◆ SetKeyTimes()

◆ SetTickResolution()

◆ UpdateOrAddKeys()

Friends And Related Symbol Documentation

◆ operator<<

◆ TMovieSceneCurveChannelImpl< FMovieSceneFloatChannel >

Member Data Documentation

◆ PostInfinityExtrap

◆ PreInfinityExtrap