FMovieSceneSequenceTickInterval Struct Reference

#include <MovieSceneSequenceTickInterval.h>

Public Member Functions
	FMovieSceneSequenceTickInterval ()=default
MOVIESCENE_API	FMovieSceneSequenceTickInterval (const AActor *InActor)
MOVIESCENE_API	FMovieSceneSequenceTickInterval (const UActorComponent *InActorComponent)
MOVIESCENE_API int32	RoundTickIntervalMs () const

Static Public Member Functions
static MOVIESCENE_API FMovieSceneSequenceTickInterval	GetInheritedInterval (UObject *ContextObject)

Public Attributes
float	TickIntervalSeconds = 0.f
float	EvaluationBudgetMicroseconds = 0.f
bool	bTickWhenPaused = false
bool	bAllowRounding = true

Friends
bool	operator== (const FMovieSceneSequenceTickInterval &A, const FMovieSceneSequenceTickInterval &B)
bool	operator!= (const FMovieSceneSequenceTickInterval &A, const FMovieSceneSequenceTickInterval &B)

Detailed Description

Structure defining a concrete tick interval for a Sequencer based evaluation

Constructor & Destructor Documentation

FMovieSceneSequenceTickInterval() [1/3]

FMovieSceneSequenceTickInterval::FMovieSceneSequenceTickInterval ( )

default

FMovieSceneSequenceTickInterval() [2/3]

FMovieSceneSequenceTickInterval::FMovieSceneSequenceTickInterval

(

const AActor *

InActor

)

Generate a tick interval from an actor's primary tick function

FMovieSceneSequenceTickInterval() [3/3]

FMovieSceneSequenceTickInterval::FMovieSceneSequenceTickInterval

(

const UActorComponent *

InActorComponent

)

Generate a tick interval from an component's primary tick function

Member Function Documentation

GetInheritedInterval()

FMovieSceneSequenceTickInterval FMovieSceneSequenceTickInterval::GetInheritedInterval ( UObject *  ContextObject )

static

Resolve this tick interval within the specified context object (usually a movie scene player) inheriting properties from the first valid parent if possible

RoundTickIntervalMs()

int32 FMovieSceneSequenceTickInterval::RoundTickIntervalMs

(

)

const

Round this interval to the nearest Sequencer.TickIntervalGroupingResolutionMs milliseconds

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const FMovieSceneSequenceTickInterval &  A, const FMovieSceneSequenceTickInterval &  B  )

friend

Inequality comparison operator

operator==

bool operator== ( const FMovieSceneSequenceTickInterval &  A, const FMovieSceneSequenceTickInterval &  B  )

friend

Equality comparison operator

Member Data Documentation

bAllowRounding

bool FMovieSceneSequenceTickInterval::bAllowRounding = true

When true, allow the sequence to be grouped with other sequences based on Sequencer.TickIntervalGroupingResolutionMs. Otherwise the interval will be used precisely.

bTickWhenPaused

bool FMovieSceneSequenceTickInterval::bTickWhenPaused = false

When true, the sequence will continue to tick and progress even when the world is paused

EvaluationBudgetMicroseconds

float FMovieSceneSequenceTickInterval::EvaluationBudgetMicroseconds = 0.f

Defines an approximate budget for evaluation of this sequence (and any other sequences with the same tick interval)

TickIntervalSeconds

float FMovieSceneSequenceTickInterval::TickIntervalSeconds = 0.f

Defines the rate at which the sequence should update, in seconds

---

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

• Engine/Source/Runtime/MovieScene/Public/MovieSceneSequenceTickInterval.h
• Engine/Source/Runtime/MovieScene/Private/MovieSceneSequenceTickInterval.cpp