FMovieSceneFloatChannel

Windows
MacOS
Linux

Inheritance Hierarchy

FMovieSceneChannel

FMovieSceneFloatChannel

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneFloatChannel.h

Include

#include "Channels/MovieSceneFloatChannel.h"

Syntax

struct FMovieSceneFloatChannel : public FMovieSceneChannel

Variables

Name Description

Public variable

TEnumAsByte< ER...

 

PostInfinityExtrap

Post-infinity extrapolation state

Public variable

TEnumAsByte< ER...

 

PreInfinityExtrap

Pre-infinity extrapolation state

Constructors

Name Description

Public function

FMovieSceneFloatChannel()

Functions

Name Description

Public function

int32

 

AddConstantKey

(
    FFrameNumber InTime,
    float InValue
)

Public function

int32

 

AddCubicKey

(
    FFrameNumber InTime,
    float InValue,
    ERichCurveTangentMode TangentMode,
    const FMovieSceneTangentData& Tang...
)

Public function

void

 

AddKeys

(
    const TArray< FFrameNumber >& InTi...,
    const TArray< FMovieSceneFloatValue...
)

Add keys with these times to channel.

Public function

int32

 

AddLinearKey

(
    FFrameNumber InTime,
    float InValue
)

Public function

void

 

AutoSetTangents

(
    float Tension
)

Public function Const

bool

 

Evaluate

(
    FFrameTime InTime,
    float& OutValue
)

Evaluate this channel with the frame resolution

Public function

TMovieSceneC...

 

GetData()

Access a mutable interface for this channel's data

Public function Const

TMovieSceneC...

 

GetData()

Access a constant interface for this channel's data

Public function Const

TOptional< f...

 

GetDefault()

Get this channel's default value that will be used when no keys are present

Public function Const

TArrayView< ...

 

GetTimes()

Const access to this channel's times

Public function Const

TArrayView< ...

 

GetValues()

Const access to this channel's values

Public function Const

void

 

PopulateCurvePoints

(
    double StartTimeSeconds,
    double EndTimeSeconds,
    double TimeThreshold,
    float ValueThreshold,
    FFrameRate TickResolution,
    TArray< TTuple< double, double >>&...
)

Populate the specified array with times and values that represent the smooth interpolation of this channel across the specified range

Public function

void

 

PostSerialize

(
    const FArchive& Ar
)

Public function

void

 

RemoveDefault()

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

Public function

bool

 

Serialize

(
    FArchive& Ar
)

Public function

bool

 

SerializeFromMismatchedTag

(
    const FPropertyTag& Tag,
    FStructuredArchive::FSlot Slot
)

Serialize this float function from a mismatching property tag (FRichCurve)

Public function

void

 

Set

(
    TArray< FFrameNumber > InTimes,
    TArray< FMovieSceneFloatValue > InV...
)

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

Public function

void

 

SetDefault

(
    float InDefaultValue
)

Set this channel's default value that should be used when no keys are present

Public function

void

 

SetTickResolution

(
    FFrameRate InTickSolution
)

Set it's frame resolution.

Overridden from FMovieSceneChannel

Name Description

Public function Virtual

void

 

ChangeFrameResolution

(
    FFrameRate SourceRate,
    FFrameRate DestinationRate
)

Called when the frame resolution of this channel is to be changed.

Public function Virtual

void

 

ClearDefault()

Clear all the default value on this channel

Public function Virtual Const

TRange< FFra...

 

ComputeEffectiveRange()

Compute the effective range of this channel, for example, the extents of its key times

Public function Virtual

void

 

DeleteKeys

(
    TArrayView< const FKeyHandle > InHa...
)

Delete the keys for the specified key handles

Public function Virtual

void

 

DeleteKeysFrom

(
    FFrameNumber InTime,
    bool bDeleteKeysBefore
)

Delete keys before or after a specified time

Public function Virtual

void

 

DuplicateKeys

(
    TArrayView< const FKeyHandle > InHa...,
    TArrayView< FKeyHandle > OutNewHand...
)

Duplicate the keys for the specified key handles

Public function Virtual

void

 

GetKeys

(
    const TRange< FFrameNumber >& With...,
    TArray< FFrameNumber >* OutKey...,
    TArray< FKeyHandle >* OutKeyHa...
)

Get key information pertaining to all keys that exist within the specified range

Public function Virtual

void

 

GetKeyTimes

(
    TArrayView< const FKeyHandle > InHa...,
    TArrayView< FFrameNumber > OutKeyTi...
)

Get all key times for the specified key handles

Public function Virtual Const

int32

 

GetNumKeys()

Get the total number of keys on this channel

Public function Virtual

void

 

Offset

(
    FFrameNumber DeltaPosition
)

Offset the keys within this channel by a given delta position

Public function Virtual

void

 

Optimize

(
    const FKeyDataOptimizationParams& ...
)

Optimize this channel by removing any redundant data according to the specified parameters

Public function Virtual

void

 

PostEditChange()

Perfor a possibly heavy operation after an edit change

Public function Virtual

void

 

Reset()

Reset this channel back to its original state

Public function Virtual

void

 

SetKeyTimes

(
    TArrayView< const FKeyHandle > InHa...,
    TArrayView< const FFrameNumber > In...
)

Set key times for the specified key handles
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss