TMovieSceneChannelData< const ValueType > Struct Template Reference

#include <MovieSceneChannelData.h>

Public Types
typedef TCallTraits< ValueType >::ParamType	ParamType

Public Member Functions
	TMovieSceneChannelData (const TArray< FFrameNumber > *InTimes, const TArray< ValueType > *InValues)
TArrayView< const FFrameNumber >	GetTimes () const
TArrayView< const ValueType >	GetValues () const
int32	FindKey (FFrameNumber InTime, FFrameNumber InTolerance=0) const
void	FindKeys (FFrameNumber InTime, int32 MaxNum, int32 &OutMinIndex, int32 &OutMaxIndex, FFrameNumber InTolerance) const
TRange< FFrameNumber >	GetTotalRange () const

Detailed Description

template<typename ValueType>
struct TMovieSceneChannelData< const ValueType >

Specialization of TMovieSceneChannelData for const value types (limited read-only access to data)

Member Typedef Documentation

ParamType

template<typename ValueType >

typedef TCallTraits<ValueType>::ParamType TMovieSceneChannelData< const ValueType >::ParamType

Constructor & Destructor Documentation

TMovieSceneChannelData()

template<typename ValueType >

TMovieSceneChannelData< const ValueType >::TMovieSceneChannelData ( const TArray< FFrameNumber > *  InTimes, const TArray< ValueType > *  InValues  )

inline

Constructor that takes a non-owning pointer to an array of times and values, and a key handle map

Parameters

InTimes	A pointer to an array of times that should be operated on by this class. Externally owned.
InValues	A pointer to an array of values that should be operated on by this class. Externally owned.
InKeyHandles	A key handle map used for persistent, order independent identification of keys

Member Function Documentation

FindKey()

template<typename ValueType >

int32 TMovieSceneChannelData< const ValueType >::FindKey ( FFrameNumber  InTime, FFrameNumber  InTolerance = 0  ) const

inline

Attempt to find a key at a given time and tolerance

Parameters

InTime	The time at which to search
InTolerance	A tolerance of frame numbers to allow either side of the specified time

Returns

The index of the key closest to InTime and within InTolerance, INDEX_NONE or Times.Num()

FindKeys()

template<typename ValueType >

void TMovieSceneChannelData< const ValueType >::FindKeys ( FFrameNumber  InTime, int32  MaxNum, int32 &  OutMinIndex, int32 &  OutMaxIndex, FFrameNumber  InTolerance  ) const

inline

Find the range of keys that fall around InTime +/- InTolerance up to a maximum

Parameters

InTime	The time around which to search
MaxNum	A maximum number of times to find, starting with those closest to the predicate time
OutMin	The earliest index that met the conditions of the search
OutMax	The latest index that met the conditions of the search
InTolerance	The tolerance range to search around PredicateTime with

GetTimes()

template<typename ValueType >

TArrayView< const FFrameNumber > TMovieSceneChannelData< const ValueType >::GetTimes ( ) const

inline

Read-only access to this channel's key times.

GetTotalRange()

template<typename ValueType >

TRange< FFrameNumber > TMovieSceneChannelData< const ValueType >::GetTotalRange ( ) const

inline

Compute the total time range of the channel data.

Returns

The range of this channel data

GetValues()

template<typename ValueType >

TArrayView< const ValueType > TMovieSceneChannelData< const ValueType >::GetValues ( ) const

inline

Read-only access to this channel's values

---

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

• Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneChannelData.h