1. Epic GamesDeveloper
  3. FMovieSceneIntegerChannel

FMovieSceneIntegerChannel

API > API/Runtime > API/Runtime/MovieScene

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

Syntax

USTRUCT ()  
struct FMovieSceneIntegerChannel : public FMovieSceneChannel

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FMovieSceneIntegerChannel()

   Channels/MovieSceneIntegerChannel.h  

Typedefs

Name Type Remarks Include Path
CurveValueType int32   Channels/MovieSceneIntegerChannel.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bInterpolateLinearKeys bool Whether to evaluate linear keys as interpolated or not Channels/MovieSceneIntegerChannel.h  
PostInfinityExtrap TEnumAsByte< ERichCurveExtrapolation > Post-infinity extrapolation state, integer channel supports them all but linear since that requires a tangent Channels/MovieSceneIntegerChannel.h  
PreInfinityExtrap TEnumAsByte< ERichCurveExtrapolation > Pre-infinity extrapolation state, integer channel supports them all but linear since that requires a tangent Channels/MovieSceneIntegerChannel.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bHasDefaultValue bool   Channels/MovieSceneIntegerChannel.h  
DefaultValue int32   Channels/MovieSceneIntegerChannel.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/MovieSceneIntegerChannel.h
  • Transient
Times TArray< FFrameNumber >   Channels/MovieSceneIntegerChannel.h
  • Meta=(KeyTimes)
Values TArray< int32 >   Channels/MovieSceneIntegerChannel.h
  • Meta=(KeyValues)

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

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

bool Evaluate ( FFrameTime InTime,
int32& OutValue
) const

   Channels/MovieSceneIntegerChannel.h  

bool Evaluate ( FFrameTime InTime,
int64& OutValue
) const

 Evaluate this channel Channels/MovieSceneIntegerChannel.h  

bool EvaluateInterp ( FFrameTime InTime,
double& OutValue
) const

 Evaluate the interpolated value when bInterpolateLinearKeys is true Channels/MovieSceneIntegerChannel.h  
Access a mutable interface for this channel's data Channels/MovieSceneIntegerChannel.h  

TMovieSceneChannelData< const int32 > GetData ()

 Access a constant interface for this channel's data Channels/MovieSceneIntegerChannel.h  

TOptional< int32 > GetDefault()

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

TArrayView< const FFrameNumber > GetTimes()

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

TArrayView< const int32 > GetValues()

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

bool HasAnyData()

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

void RemoveDefault()

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

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

 Serialize this type from another Channels/MovieSceneIntegerChannel.h  

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

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

void SetDefault ( int32 InDefaultValue
)

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

Overridden from FMovieSceneChannel

Name Remarks Include Path Unreal Specifiers

virtual void ClearDefault()

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

virtual TRange< FFrameNumber > ComputeEffectiveRange()

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

virtual void DeleteKeys ( TArrayView< const FKeyHandle > InHandles
)

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

virtual void DeleteKeysFrom ( FFrameNumber InTime,
bool bDeleteKeysBefore
)

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

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

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

virtual FKeyHandle GetHandle ( int32 Index
)

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

virtual int32 GetIndex ( FKeyHandle Handle
)

 Attempt to retrieve the index of key from its handle Channels/MovieSceneIntegerChannel.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/MovieSceneIntegerChannel.h  

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

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

virtual int32 GetNumKeys()

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

virtual void Offset ( FFrameNumber DeltaPosition
)

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

virtual void Optimize ( const FKeyDataOptimizationParams& InParameters
)

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

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

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

virtual void Reset()

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

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

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page