1. Epic GamesDeveloper
  3. FMovieSceneFloatChannel

FMovieSceneFloatChannel

Unreal Engine C++ API Reference > Runtime > MovieScene > Channels

Inheritance Hierarchy

References

   
Module MovieScene
Header /Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneFloatChannel.h
Include #include "Channels/MovieSceneFloatChannel.h"

Syntax

struct FMovieSceneFloatChannel : public FMovieSceneChannel

Variables

  Type Name Description
Public variable TEnumAsByte< ERichCurveExtrapolation > PostInfinityExtrap Post-infinity extrapolation state
Public variable TEnumAsByte< ERichCurveExtrapolation > PreInfinityExtrap Pre-infinity extrapolation state

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function int32

AddConstantKey ( FFrameNumber InTime,
float InValue
)

  
Public function int32

AddCubicKey ( FFrameNumber InTime,
float InValue,
ERichCurveTangentMode TangentMode,
const FMovieSceneTangentData& Tangent
)

  
Public function void

AddKeys ( const TArray< FFrameNumber >& InTimes,
const TArray< FMovieSceneFloatValue >& InValues
)

 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 TMovieSceneChannelData< FMovieSceneFloatValue >

GetData ()

 Access a mutable interface for this channel's data
Public function Const TMovieSceneChannelData< const FMovieSceneFloatValue >

GetData ()

 Access a constant interface for this channel's data
Public function Const TOptional< float > Get this channel's default value that will be used when no keys are present
Public function Const UE::MovieScene::Interpolation::FCachedInterpolation Retrieve a cached interpolation from this channel for the specified time
Public function Const bool Get whether to show this curve in the UI
Public function Const FFrameRate Get the channel's frame resolution
Public function Const TArrayView< const FFrameNumber > Const access to this channel's times
Public function Const TArrayView< const FMovieSceneFloatValue > Const access to this channel's values
Public function Const bool Check whether this channel has any data
Public function Const void

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

 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 Remove this channel's default value causing the channel to have no effect where no keys are present
Public function bool  
Public function bool Serialize this float function from a mismatching property tag (FRichCurve)
Public function void

Set ( TArray< FFrameNumber > InTimes,
TArray< FMovieSceneFloatValue > InValues
)

 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 Set the channel's times and values to the requested values, but does not allocate key handles
Public function void

SetShowCurve ( bool bInShowCurve
)

 Set whether to show this curve in the UI
Public function void

SetTickResolution ( FFrameRate InTickSolution
)

 Set the channel's frame resolution

Overridden from FMovieSceneChannel

  Type 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 Clear all the default value on this channel
Public function Virtual Const TRange< FFrameNumber > Compute the effective range of this channel, for example, the extents of its key times
Public function Virtual void

DeleteKeys ( TArrayView< const FKeyHandle > InHandles
)

 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 > InHandles,
TArrayView< FKeyHandle > OutNewHandles
)

 Duplicate the keys for the specified key handles
Public function Virtual void

GetKeys ( const TRange< FFrameNumber >& WithinRange,
TArray< FFrameNumber >* OutKeyTimes,
TArray< FKeyHandle >* OutKeyHandles
)

 Get key information pertaining to all keys that exist within the specified range
Public function Virtual void

GetKeyTimes ( TArrayView< const FKeyHandle > InHandles,
TArrayView< FFrameNumber > OutKeyTimes
)

 Get all key times for the specified key handles
Public function Virtual Const int32 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& InParameters
)

 Optimize this channel by removing any redundant data according to the specified parameters
Public function Virtual void 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 > InHandles,
TArrayView< const FFrameNumber > InKeyTimes
)

 Set key times for the specified key handles

Typedefs

Name Description
ChannelValueType  
CurveValueType  
FMovieSceneFloatChannelImpl  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page