FMovieSceneEvaluationField Struct Reference

#include <MovieSceneEvaluationField.h>

Public Member Functions
MOVIESCENE_API int32	GetSegmentFromTime (FFrameNumber Time) const
MOVIESCENE_API TRange< int32 >	OverlapRange (const TRange< FFrameNumber > &Range) const
MOVIESCENE_API void	Invalidate (const TRange< FFrameNumber > &Range)
MOVIESCENE_API int32	Insert (const TRange< FFrameNumber > &InRange, FMovieSceneEvaluationGroup &&InGroup, FMovieSceneEvaluationMetaData &&InMetaData)
MOVIESCENE_API void	Add (const TRange< FFrameNumber > &InRange, FMovieSceneEvaluationGroup &&InGroup, FMovieSceneEvaluationMetaData &&InMetaData)
int32	Size () const
TArrayView< const FMovieSceneFrameRange >	GetRanges () const
const TRange< FFrameNumber > &	GetRange (int32 Index) const
const FMovieSceneEvaluationGroup &	GetGroup (int32 Index) const
const FMovieSceneEvaluationMetaData &	GetMetaData (int32 Index) const

Detailed Description

Memory layout optimized primarily for speed of searching the applicable ranges

Member Function Documentation

Add()

void FMovieSceneEvaluationField::Add	(	const TRange< FFrameNumber > &	InRange,
		FMovieSceneEvaluationGroup &&	InGroup,
		FMovieSceneEvaluationMetaData &&	InMetaData
	)

Add the specified data to this field, assuming the specified range lies after any other entries

Parameters

InRange	The range to add
InGroup	The group defining what should happen at this time
InMetaData	The meta-data defining efficient access to what happens in this frame

GetGroup()

const FMovieSceneEvaluationGroup & FMovieSceneEvaluationField::GetGroup ( int32  Index ) const

inline

Lookup a valid evaluation group by entry index

Parameters

Index

The valid index within the evaluation group array to lookup

Returns

The group

GetMetaData()

const FMovieSceneEvaluationMetaData & FMovieSceneEvaluationField::GetMetaData ( int32  Index ) const

inline

Lookup valid meta-data by entry index

Parameters

Index

The valid index within the meta-data array to lookup

Returns

The meta-data

GetRange()

const TRange< FFrameNumber > & FMovieSceneEvaluationField::GetRange ( int32  Index ) const

inline

Lookup a valid range by index

Parameters

Index

The valid index within the ranges to lookup

Returns

The range

GetRanges()

TArrayView< const FMovieSceneFrameRange > FMovieSceneEvaluationField::GetRanges ( ) const

inline

Access this entire field's set of ranges

GetSegmentFromTime()

int32 FMovieSceneEvaluationField::GetSegmentFromTime

(

FFrameNumber

Time

)

const

Efficiently find the entry that exists at the specified time, if any

Parameters

Time	The time at which to seach

Returns

The index within Ranges, Groups and MetaData that the current time resides, or INDEX_NONE if there is nothing to do at the requested time

Insert()

int32 FMovieSceneEvaluationField::Insert	(	const TRange< FFrameNumber > &	InRange,
		FMovieSceneEvaluationGroup &&	InGroup,
		FMovieSceneEvaluationMetaData &&	InMetaData
	)

Insert a new range into this field

Parameters

InRange	The total range to insert to the field. Will potentially be intersected with preexisting adjacent ranges
InGroup	The group defining what should happen at this time
InMetaData	The meta-data defining efficient access to what happens in this frame

Returns

The index the entries were inserted at

Invalidate()

void FMovieSceneEvaluationField::Invalidate

(

const TRange< FFrameNumber > &

Range

)

Invalidate a range in this field

Parameters

Range

The range to overlap with our field

Returns

A range of indices into Ranges and Groups that overlap with the requested range

OverlapRange()

TRange< int32 > FMovieSceneEvaluationField::OverlapRange

(

const TRange< FFrameNumber > &

Range

)

const

Deduce the indices into Ranges and Groups that overlap with the specified time range

Parameters

Range

The range to overlap with our field

Returns

A range of indices for which GetRange() overlaps the specified Range, of the form [First, First+Num)

Size()

int32 FMovieSceneEvaluationField::Size ( ) const

inline

Access this field's signature Access this field's size

---

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

• Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneEvaluationField.h
• Engine/Source/Runtime/MovieScene/Private/Evaluation/MovieSceneEvaluationField.cpp