#include <MovieSceneIntegerChannel.h>

Inheritance diagram for FMovieSceneIntegerChannel:

Public Types
typedef int32	CurveValueType

Public Member Functions
	FMovieSceneIntegerChannel ()

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

TMovieSceneChannelData< int32 >	GetData ()

TMovieSceneChannelData< const int32 >	GetData () const

TArrayView< const FFrameNumber >	GetTimes () const

TArrayView< const int32 >	GetValues () const

bool	HasAnyData () const

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

bool	Evaluate (FFrameTime InTime, int32 &OutValue) const

MOVIESCENE_API bool	EvaluateInterp (FFrameTime InTime, double &OutValue) const

void	Set (TArray< FFrameNumber > InTimes, TArray< int32 > InValues)

void	AddKeys (const TArray< FFrameNumber > &InTimes, const TArray< int32 > &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 FKeyHandle	GetHandle (int32 Index) override

virtual MOVIESCENE_API int32	GetIndex (FKeyHandle Handle) override

void	SetDefault (int32 InDefaultValue)

TOptional< int32 >	GetDefault () const

void	RemoveDefault ()

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 ()

FMovieSceneChannelDataKeyAddedEvent &	OnKeyAddedEvent ()

FMovieSceneChannelDataKeyDeletedEvent &	OnKeyDeletedEvent ()

FMovieSceneChannelDataKeyMovedEvent &	OnKeyMovedEvent ()

Public Attributes
TEnumAsByte< ERichCurveExtrapolation >	PreInfinityExtrap

TEnumAsByte< ERichCurveExtrapolation >	PostInfinityExtrap

bool	bInterpolateLinearKeys

Additional Inherited Members
Protected Attributes inherited from FMovieSceneChannel
FMovieSceneChannelDataKeyAddedEvent	KeyAddedEvent

FMovieSceneChannelDataKeyDeletedEvent	KeyDeletedEvent

FMovieSceneChannelDataKeyMovedEvent	KeyMovedEvent

Member Typedef Documentation

◆ CurveValueType

typedef int32 FMovieSceneIntegerChannel::CurveValueType

Constructor & Destructor Documentation

◆ FMovieSceneIntegerChannel()

FMovieSceneIntegerChannel::FMovieSceneIntegerChannel ( )

inline

Member Function Documentation

◆ AddKeys()

void FMovieSceneIntegerChannel::AddKeys	(	const TArray< FFrameNumber > &	InTimes,
		const TArray< int32 > &	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 FMovieSceneIntegerChannel::ClearDefault ( )

overridevirtual

Clear all the default value on this channel

Reimplemented from FMovieSceneChannel.

◆ ComputeEffectiveRange()

TRange< FFrameNumber > FMovieSceneIntegerChannel::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 FMovieSceneIntegerChannel::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 FMovieSceneIntegerChannel::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 FMovieSceneIntegerChannel::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() [1/2]

bool FMovieSceneIntegerChannel::Evaluate	(	FFrameTime	InTime,
		int32 &	OutValue
	)		const

inline

◆ Evaluate() [2/2]

bool FMovieSceneIntegerChannel::Evaluate	(	FFrameTime	InTime,
		int64 &	OutValue
	)		const

Evaluate this channel

Parameters

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

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

◆ EvaluateInterp()

bool FMovieSceneIntegerChannel::EvaluateInterp	(	FFrameTime	InTime,
		double &	OutValue
	)		const

Evaluate the interpolated value when bInterpolateLinearKeys is true

Parameters

InTime	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< int32 > FMovieSceneIntegerChannel::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 int32 > FMovieSceneIntegerChannel::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< int32 > FMovieSceneIntegerChannel::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 FMovieSceneIntegerChannel::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 FMovieSceneIntegerChannel::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.

◆ GetKeys()

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

overridevirtual

Get the total number of keys on this channel

Returns: The number of keys on this channel

Reimplemented from FMovieSceneChannel.

◆ GetTimes()

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

inline

Const access to this channel's times

◆ GetValues()

TArrayView< const int32 > FMovieSceneIntegerChannel::GetValues ( ) const

inline

Const access to this channel's values

◆ HasAnyData()

bool FMovieSceneIntegerChannel::HasAnyData ( ) const

inline

Check whether this channel has any data

◆ Offset()

void FMovieSceneIntegerChannel::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 FMovieSceneIntegerChannel::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 FMovieSceneIntegerChannel::RemapTimes ( const UE::MovieScene::IRetimingInterface & Retimer )

overridevirtual

Remap the times contained within this channel using a custom remapper

Reimplemented from FMovieSceneChannel.

◆ RemoveDefault()

void FMovieSceneIntegerChannel::RemoveDefault ( )

inline

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

◆ Reset()

void FMovieSceneIntegerChannel::Reset ( )

overridevirtual

Reset this channel back to its original state

Reimplemented from FMovieSceneChannel.

◆ SerializeFromMismatchedTag()

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

Serialize this type from another

◆ Set()

void FMovieSceneIntegerChannel::Set	(	TArray< FFrameNumber >	InTimes,
		TArray< int32 >	InValues
	)

inline

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

◆ SetDefault()

void FMovieSceneIntegerChannel::SetDefault ( int32 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 FMovieSceneIntegerChannel::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.

Member Data Documentation

◆ bInterpolateLinearKeys

bool FMovieSceneIntegerChannel::bInterpolateLinearKeys

Whether to evaluate linear keys as interpolated or not

◆ PostInfinityExtrap

TEnumAsByte<ERichCurveExtrapolation> FMovieSceneIntegerChannel::PostInfinityExtrap

Post-infinity extrapolation state, integer channel supports them all but linear since that requires a tangent

◆ PreInfinityExtrap

TEnumAsByte<ERichCurveExtrapolation> FMovieSceneIntegerChannel::PreInfinityExtrap

Pre-infinity extrapolation state, integer channel supports them all but linear since that requires a tangent

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

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

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Member Typedef Documentation

◆ CurveValueType

Constructor & Destructor Documentation

◆ FMovieSceneIntegerChannel()

Member Function Documentation

◆ AddKeys()

◆ ClearDefault()

◆ ComputeEffectiveRange()

◆ DeleteKeys()

◆ DeleteKeysFrom()

◆ DuplicateKeys()

◆ Evaluate() [1/2]

◆ Evaluate() [2/2]

◆ EvaluateInterp()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ GetDefault()

◆ GetHandle()

◆ GetIndex()

◆ GetKeys()

◆ GetKeyTimes()

◆ GetNumKeys()

◆ GetTimes()

◆ GetValues()

◆ HasAnyData()

◆ Offset()

◆ Optimize()

◆ RemapTimes()

◆ RemoveDefault()

◆ Reset()

◆ SerializeFromMismatchedTag()

◆ Set()

◆ SetDefault()

◆ SetKeyTimes()

Member Data Documentation

◆ bInterpolateLinearKeys

◆ PostInfinityExtrap

◆ PreInfinityExtrap