1. Epic GamesDeveloper
  3. FMovieSceneFloatChannel

FMovieSceneFloatChannel

API > API/Runtime > API/Runtime/MovieScene

   
Name FMovieSceneFloatChannel
Type struct
Header File /Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneFloatChannel.h
Include Path #include "Channels/MovieSceneFloatChannel.h"

Syntax

USTRUCT ()  
struct FMovieSceneFloatChannel : public FMovieSceneChannel

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FMovieSceneFloatChannel()

   Channels/MovieSceneFloatChannel.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FMovieSceneFloatChannel()

   Channels/MovieSceneFloatChannel.h  

Typedefs

Name Type Remarks Include Path
ChannelValueType FMovieSceneFloatValue   Channels/MovieSceneFloatChannel.h
CurveValueType float   Channels/MovieSceneFloatChannel.h
FMovieSceneFloatChannelImpl TMovieSceneCurveChannelImpl< FMovieSceneFloatChannel >   Channels/MovieSceneFloatChannel.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
PostInfinityExtrap TEnumAsByte< ERichCurveExtrapolation > Post-infinity extrapolation state Channels/MovieSceneFloatChannel.h  
PreInfinityExtrap TEnumAsByte< ERichCurveExtrapolation > Pre-infinity extrapolation state Channels/MovieSceneFloatChannel.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bHasDefaultValue bool   Channels/MovieSceneFloatChannel.h  
bShowCurve bool   Channels/MovieSceneFloatChannel.h  
DefaultValue float   Channels/MovieSceneFloatChannel.h  
KeyHandles FMovieSceneKeyHandleMap This needs to be a UPROPERTY so it gets saved into editor transactions but transient so it doesn't get saved into assets. Channels/MovieSceneFloatChannel.h
  • Transient
TickResolution FFrameRate   Channels/MovieSceneFloatChannel.h  
Times TArray< FFrameNumber >   Channels/MovieSceneFloatChannel.h
  • Meta=(KeyTimes)
Values TArray< FMovieSceneFloatValue >   Channels/MovieSceneFloatChannel.h
  • Meta=(KeyValues)

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddConstantKey ( FFrameNumber InTime,
float InValue
)

   Channels/MovieSceneFloatChannel.h  

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

   Channels/MovieSceneFloatChannel.h  

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

 Add keys with these times to channel. Channels/MovieSceneFloatChannel.h  

int32 AddLinearKey ( FFrameNumber InTime,
float InValue
)

   Channels/MovieSceneFloatChannel.h  

UE::MovieScene::FPiecewiseCurve AsPiecewiseCurve ( bool bWithPreAndPostInfinityExtrap
) const

   Channels/MovieSceneFloatChannel.h  

void AutoSetTangents ( float Tension
)

   Channels/MovieSceneFloatChannel.h  

UE::MovieScene::Interpolation::FInterpolationExtents ComputeExtents ( FFrameTime StartTime,
FFrameTime EndTime
) const

 Compute the value extents of this curve within the specified limits Channels/MovieSceneFloatChannel.h  

bool Evaluate ( FFrameTime InTime,
float& OutValue
) const

 Evaluate this channel with the frame resolution Channels/MovieSceneFloatChannel.h  
Access a mutable interface for this channel's data Channels/MovieSceneFloatChannel.h  
Access a constant interface for this channel's data Channels/MovieSceneFloatChannel.h  

TOptional< float > GetDefault()

 Get this channel's default value that will be used when no keys are present Channels/MovieSceneFloatChannel.h  

UE::MovieScene::Interpolation::FCachedInterpolation GetInterpolationForTime ( FFrameTime InTime
) const

 Retrieve a cached interpolation from this channel for the specified time Channels/MovieSceneFloatChannel.h  

bool GetShowCurve()

 Get whether to show this curve in the UI Channels/MovieSceneFloatChannel.h  

FFrameRate GetTickResolution()

 Get the channel's frame resolution Channels/MovieSceneFloatChannel.h  

TArrayView< const FFrameNumber > GetTimes()

 Const access to this channel's times Channels/MovieSceneFloatChannel.h  

TArrayView< const FMovieSceneFloatValue > GetValues()

 Const access to this channel's values Channels/MovieSceneFloatChannel.h  

bool HasAnyData()

 Check whether this channel has any data Channels/MovieSceneFloatChannel.h  

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

 Populate the specified array with times and values that represent the smooth interpolation of this channel across the specified range Channels/MovieSceneFloatChannel.h  

void PostSerialize ( const FArchive& Ar
)

   Channels/MovieSceneFloatChannel.h  

void RemoveDefault()

 Remove this channel's default value causing the channel to have no effect where no keys are present Channels/MovieSceneFloatChannel.h  

bool Serialize ( FArchive& Ar
)

   Channels/MovieSceneFloatChannel.h  

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

 Serialize this float function from a mismatching property tag (FRichCurve) Channels/MovieSceneFloatChannel.h  

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

 Set the channel's times and values to the requested values Channels/MovieSceneFloatChannel.h  

void SetDefault ( float InDefaultValue
)

 Set this channel's default value that should be used when no keys are present Channels/MovieSceneFloatChannel.h  

void SetKeysOnly ( TArrayView< FFrameNumber > InTimes,
TArrayView< FMovieSceneFloatValue > InValues
)

 Set the channel's times and values to the requested values, but does not allocate key handles Channels/MovieSceneFloatChannel.h  

void SetShowCurve ( bool bInShowCurve
)

 Set whether to show this curve in the UI Channels/MovieSceneFloatChannel.h  

void SetTickResolution ( FFrameRate InTickSolution
)

 Set the channel's frame resolution Channels/MovieSceneFloatChannel.h  

void UpdateOrAddKeys ( const TArrayView< const FFrameNumber > InTimes,
const TArrayView< FMovieSceneFloatValue > InValues
)

   Channels/MovieSceneFloatChannel.h  

Overridden from FMovieSceneChannel

Name Remarks Include Path Unreal Specifiers

virtual void ClearDefault()

 Clear all the default value on this channel Channels/MovieSceneFloatChannel.h  

virtual TRange< FFrameNumber > ComputeEffectiveRange()

 Compute the effective range of this channel, for example, the extents of its key times Channels/MovieSceneFloatChannel.h  

virtual void DeleteKeys ( TArrayView< const FKeyHandle > InHandles
)

 Delete the keys for the specified key handles Channels/MovieSceneFloatChannel.h  

virtual void DeleteKeysFrom ( FFrameNumber InTime,
bool bDeleteKeysBefore
)

 Delete keys before or after a specified time Channels/MovieSceneFloatChannel.h  

virtual void DuplicateKeys ( TArrayView< const FKeyHandle > InHandles,
TArrayView< FKeyHandle > OutNewHandles
)

 Duplicate the keys for the specified key handles Channels/MovieSceneFloatChannel.h  

virtual FKeyHandle GetHandle ( int32 Index
)

 Retrieve a key handle for the specified key time index Channels/MovieSceneFloatChannel.h  

virtual int32 GetIndex ( FKeyHandle Handle
)

 Attempt to retrieve the index of key from its handle Channels/MovieSceneFloatChannel.h  

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 Channels/MovieSceneFloatChannel.h  

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

 Get all key times for the specified key handles Channels/MovieSceneFloatChannel.h  

virtual int32 GetNumKeys()

 Get the total number of keys on this channel Channels/MovieSceneFloatChannel.h  

virtual void Offset ( FFrameNumber DeltaPosition
)

 Offset the keys within this channel by a given delta position Channels/MovieSceneFloatChannel.h  

virtual void Optimize ( const FKeyDataOptimizationParams& InParameters
)

 Optimize this channel by removing any redundant data according to the specified parameters Channels/MovieSceneFloatChannel.h  

virtual void PostEditChange()

 Perform a possibly heavy operation after an edit change Channels/MovieSceneFloatChannel.h  

virtual void RemapTimes ( const UE::MovieScene::IRetimingInterface& Retimer
)

 Remap the times contained within this channel using a custom remapper Channels/MovieSceneFloatChannel.h  

virtual void Reset()

 Reset this channel back to its original state Channels/MovieSceneFloatChannel.h  

virtual void SetKeyTimes ( TArrayView< const FKeyHandle > InHandles,
TArrayView< const FFrameNumber > InKeyTimes
)

 Set key times for the specified key handles Channels/MovieSceneFloatChannel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page