1. Epic GamesDeveloper
  3. FMovieSceneChannel

FMovieSceneChannel

API > API/Runtime > API/Runtime/MovieScene > API/Runtime/MovieScene/Channels

Inheritance Hierarchy

References

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

Syntax

struct FMovieSceneChannel

Variables

  Type Name Description
Protected variable FMovieSceneChannelDataKeyAddedEvent KeyAddedEvent Broadcasts a notification whenever key is added
Protected variable FMovieSceneChannelDataKeyDeletedEvent KeyDeletedEvent Broadcasts a notification whenever key is deleted
Protected variable FMovieSceneChannelDataKeyMovedEvent KeyMovedEvent Broadcasts a notification whenever key is moved

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  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 void

GetKeyTime ( const FKeyHandle InHandle,
FFrameNumber& OutKeyTime
)

 Get the time for the specified key handle
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 FMovieSceneChannelDataKeyAddedEvent & Get delegate that's called when a key is added
Public function FMovieSceneChannelDataKeyDeletedEvent & Get delegate that's called when a key is deleted
Public function FMovieSceneChannelDataKeyMovedEvent & Get delegate that's called when a key is moved
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 void

SetKeyTime ( const FKeyHandle InHandle,
const FFrameNumber InKeyTime
)

 Set the time for the specified key handle
Public function Virtual void

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

 Set key times for the specified key handles

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page