FMovieSceneActorReferenceData Struct Reference

#include <MovieSceneActorReferenceSection.h>

Inheritance diagram for FMovieSceneActorReferenceData:

Public Types
typedef FMovieSceneActorReferenceKey	CurveValueType

Public Member Functions
	FMovieSceneActorReferenceData ()
TMovieSceneChannelData< FMovieSceneActorReferenceKey >	GetData ()
TMovieSceneChannelData< const FMovieSceneActorReferenceKey >	GetData () const
MOVIESCENETRACKS_API bool	Evaluate (FFrameTime InTime, FMovieSceneActorReferenceKey &OutValue) const
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	ClearDefault () override
virtual MOVIESCENETRACKS_API FKeyHandle	GetHandle (int32 Index) override
virtual MOVIESCENETRACKS_API int32	GetIndex (FKeyHandle Handle) override
void	SetDefault (FMovieSceneActorReferenceKey InDefaultValue)
const FMovieSceneActorReferenceKey &	GetDefault () const
void	UpgradeLegacyTime (UObject *Context, double Time, FMovieSceneActorReferenceKey Value)
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	Optimize (const FKeyDataOptimizationParams &InParameters)
virtual void	PostEditChange ()
FMovieSceneChannelDataKeyAddedEvent &	OnKeyAddedEvent ()
FMovieSceneChannelDataKeyDeletedEvent &	OnKeyDeletedEvent ()
FMovieSceneChannelDataKeyMovedEvent &	OnKeyMovedEvent ()

Additional Inherited Members
Protected Attributes inherited from FMovieSceneChannel
FMovieSceneChannelDataKeyAddedEvent	KeyAddedEvent
FMovieSceneChannelDataKeyDeletedEvent	KeyDeletedEvent
FMovieSceneChannelDataKeyMovedEvent	KeyMovedEvent

Detailed Description

A curve of events

Member Typedef Documentation

CurveValueType

typedef FMovieSceneActorReferenceKey FMovieSceneActorReferenceData::CurveValueType

Constructor & Destructor Documentation

FMovieSceneActorReferenceData()

FMovieSceneActorReferenceData::FMovieSceneActorReferenceData ( )

inline

Member Function Documentation

ClearDefault()

void FMovieSceneActorReferenceData::ClearDefault ( )

overridevirtual

Clear all the default value on this channel

Reimplemented from FMovieSceneChannel.

ComputeEffectiveRange()

TRange< FFrameNumber > FMovieSceneActorReferenceData::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 FMovieSceneActorReferenceData::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 FMovieSceneActorReferenceData::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 FMovieSceneActorReferenceData::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 FMovieSceneActorReferenceData::Evaluate	(	FFrameTime	InTime,
		FMovieSceneActorReferenceKey &	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

GetData() [1/2]

TMovieSceneChannelData< FMovieSceneActorReferenceKey > FMovieSceneActorReferenceData::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 FMovieSceneActorReferenceKey > FMovieSceneActorReferenceData::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()

const FMovieSceneActorReferenceKey & FMovieSceneActorReferenceData::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 FMovieSceneActorReferenceData::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 FMovieSceneActorReferenceData::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 FMovieSceneActorReferenceData::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 FMovieSceneActorReferenceData::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 FMovieSceneActorReferenceData::GetNumKeys ( ) const

overridevirtual

Get the total number of keys on this channel

Returns

The number of keys on this channel

Reimplemented from FMovieSceneChannel.

Offset()

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

RemapTimes()

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

overridevirtual

Remap the times contained within this channel using a custom remapper

Reimplemented from FMovieSceneChannel.

Reset()

void FMovieSceneActorReferenceData::Reset ( )

overridevirtual

Reset this channel back to its original state

Reimplemented from FMovieSceneChannel.

SetDefault()

void FMovieSceneActorReferenceData::SetDefault ( FMovieSceneActorReferenceKey  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 FMovieSceneActorReferenceData::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.

UpgradeLegacyTime()

void FMovieSceneActorReferenceData::UpgradeLegacyTime ( UObject *  Context, double  Time, FMovieSceneActorReferenceKey  Value  )

inline

Upgrade legacy data by appending to the end of the array. Assumes sorted data

---

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

• Engine/Source/Runtime/MovieSceneTracks/Public/Sections/MovieSceneActorReferenceSection.h
• Engine/Source/Runtime/MovieSceneTracks/Private/Sections/MovieSceneActorReferenceSection.cpp