1. Epic GamesDeveloper
  3. Channels

Channels

API > API/Runtime > API/Runtime/MovieScene

Classes

  Type Name Description
Public struct FCachedInterpolation Variant structure that wraps an interpolation and the range within which it is valid. ~96 bytes  
Public struct FCachedInterpolationRange Simple 1 dimensional range based off a FFrameNumber to define the range within which a cached interpolation is valid  
Public struct FChannelOverrideEntityImportParams Entity import parameters for a channel override.  
Public struct FChannelOverrideNames Utility class to convert channel names to indices  
Public struct FChannelOverrideProviderTraits    
Public struct FCommonChannelData Commonly used channel display names and colors  
Public struct FConstantValue Structure representing a constant value.  
Public struct FCubicInterpolation A cubic bezier interpolation between 2 control points with tangents, represented as 4 control points on a Bezier curve  
Public struct FCycleParams    
Public struct FInvalidValue Sentinal type that represents an invalid interpolation value.  
Public struct FKeyAddOrDeleteEventItem Events that are fired when adding, deleting or moving keys Item that's sent when an event is fired when we delete or add a key  
Public struct FKeyDataOptimizationParams Parameter structure passed to UE::MovieScene::Optimize that defines optimization parameters  
Public struct FKeyMoveEventItem Item that's sent when an event is fired when we move a key in time  
Public struct FLinearInterpolation Structure representing a linear interpolation of the form f(t) = a(t-o) + b.  
Public struct FMoveSceneAudioTriggerState    
Public struct UStruct FMovieSceneAudioTriggerChannel    
Public struct UStruct FMovieSceneBoolChannel    
Public struct UStruct FMovieSceneByteChannel    
Public struct UStruct FMovieSceneChannel    
Public struct FMovieSceneChannelData Base class channel data utility that provides a consistent interface to a sorted array of times and handles.  
Public struct FMovieSceneChannelEditorDataEntry Base entry type for use in FMovieSceneChannelProxy that stores editor meta-data and extended editor data for each channel of a given type (one entry per type).  
Public struct FMovieSceneChannelEntry An entry within FMovieSceneChannelProxy that contains all channels (and editor data) for any given channel type  
Public struct FMovieSceneChannelHandle Handle to a specific channel in a UMovieSceneSection.  
Public struct FMovieSceneChannelMetaData Editor meta data for a channel of data within a movie scene section  
Public struct FMovieSceneChannelProxy Proxy type stored inside UMovieSceneSection for access to all its channels.  
Public struct FMovieSceneChannelProxyData Construction helper that is required to create a new FMovieSceneChannelProxy from multiple channels  
Public struct UStruct FMovieSceneDoubleChannel    
Public struct UStruct FMovieSceneDoubleValue    
Public struct UStruct FMovieSceneFloatChannel    
Public struct UStruct FMovieSceneFloatValue    
Public struct UStruct FMovieSceneIntegerChannel    
Public struct UStruct FMovieSceneKeyHandleMap A map of key handles that is copyable, but does not copy data on copy  
Public struct UStruct FMovieSceneObjectPathChannel    
Public struct UStruct FMovieSceneObjectPathChannelKeyValue Key value type for object path channels that stores references to objects as both a hard and soft reference, to ensure compatability with both sub objects and async loading  
Public struct UStruct FMovieSceneTangentData Tangents for curve channel control points.  
Public struct FWeightedCubicInterpolation A weighted cubic bezier interpolation between 2 control points with weighted tangents  
Public class IMovieSceneChannelOverrideProvider Interface to be added to UMovieSceneSection types when they contain entity data  
Public struct TIsPODType    
Public struct TMovieSceneChannelData Templated channel data utility class that provides a consistent interface for interacting with a channel's keys and values.  
Public struct TMovieSceneChannelHandle Forward declaration of a typed channel handle.  
Public struct TMovieSceneChannelTraits Traits structure to be specialized for any channel type passed to FMovieSceneChannelProxy  
Public struct TMovieSceneChannelTraitsBase Traits structure to be specialized for any channel type passed to FMovieSceneChannelProxy  
Public struct TMovieSceneExternalValue Typed external value that can be used to define how to access the current value on an object for any given channel of data.  
Public struct TNamedChannelOverrideProviderTraits    
Public struct TObjectPtr    
Public class TRange    
Public struct TSingleChannelOverrideProviderTraits    
Public class UClass Abstract, MinimalAPI UMovieSceneChannelOverrideContainer A wrapper to implement polymorphism for FMovieSceneChannel.  
Public class UMovieSceneChannelOverrideProvider    
Public class UClass MinimalAPI UMovieSceneSectionChannelOverrideRegistry This object contains a map of actual channel overrides, where each override is a channel identifier and a channel container.  

Typedefs

Name Description
FChannelOverrideProviderTraitsHandle  
FGetMovieSceneTooltipText  
FMovieSceneChannelDataKeyAddedEvent Note if any Channel uses these delegate's they need a custom serializer to make sure they stick around on undo/redo.
FMovieSceneChannelDataKeyDeletedEvent  
FMovieSceneChannelDataKeyMovedEvent  

Functions

  Type Name Description
Public function FKeyHandle

AddKeyToChannel ( FMovieSceneFloatChannel* Channel,
FFrameNumber InFrameNumber,
float InValue,
EMovieSceneKeyInterpolation Interpolation
)

 Overload for adding a new key to a float channel at a given time.
Public function FKeyHandle

AddKeyToChannel ( FMovieSceneDoubleChannel* Channel,
FFrameNumber InFrameNumber,
double InValue,
EMovieSceneKeyInterpolation Interpolation
)

 Overload for adding a new key to a double channel at a given time.
Public function void

AssignValue ( FMovieSceneFloatChannel* InChannel,
FKeyHandle InKeyHandle,
float InValue
)

  
Public function void

AssignValue ( FMovieSceneDoubleChannel* InChannel,
FKeyHandle InKeyHandle,
float InValue
)

  
Public function void

AssignValue ( FMovieSceneDoubleChannel* InChannel,
FKeyHandle InKeyHandle,
double InValue
)

  
Public function void

Dilate ( FMovieSceneDoubleChannel* InChannel,
FFrameNumber Origin,
double DilationFactor
)

 Overload for dilating double channel data. See UE::MovieScene::Dilate for default implementation.
Public function void

Dilate ( FMovieSceneFloatChannel* InChannel,
FFrameNumber Origin,
float DilationFactor
)

 Overload for dilating float channel data. See UE::MovieScene::Dilate for default implementation.
Public function bool

EvaluateChannel ( const FMovieSceneAudioTriggerChannel* InChannel,
FFrameTime InTime,
bool& OutValue
)

  
Public function EMovieSceneKeyInterpolation

GetInterpolationMode ( FMovieSceneDoubleChannel* InChannel,
const FFrameNumber& InTime,
EMovieSceneKeyInterpolation DefaultInterpolationMode
)

 Overload for getting the interpolation mode for a channel at a specified time, it could be the previous key's mode.See UE::MovieScene::GetInterpolationMode for default implementation.
Public function EMovieSceneKeyInterpolation

GetInterpolationMode ( FMovieSceneFloatChannel* InChannel,
const FFrameNumber& InTime,
EMovieSceneKeyInterpolation DefaultInterpolationMode
)

 Overload for getting the interpolation mode for a channel at a specified time, it could be the previous key's mode.See UE::MovieScene::GetInterpolationMode for default implementation.
Public function void

UE::MovieScene::AddChannelProxy ( FMovieSceneChannelProxyData& ProxyData,
const UMovieSceneSectionChannelOverrideRegistry* OverrideRegistry,
FName ChannelName,
ChannelType& DefaultChannel,
const FMovieSceneChannelMetaData& InMetaData,
ExtendedEditorDataType&& InExtendedEditorData
)

 Utility function for adding a possibly-overriden channel into a channel proxy, with some specific extended editor data.
Public function FKeyHandle

UE::MovieScene::AddKeyToChannel ( ChannelType* InChannel,
FFrameNumber InTime,
ValueType&& Value,
EMovieSceneKeyInterpolation Interpolation
)

 Add a key to a channel, or update an existing key if one already exists at this time
Public function bool

UE::MovieScene::AssignValue ( ChannelType* InChannel,
FKeyHandle InKeyHandle,
ValueType&& InValue
)

 Called to assign a specific value in a channel.
Public function bool

UE::MovieScene::EvaluateChannel ( const ChannelType* InChannel,
FFrameTime InTime,
ValueType& OutValue
)

 Called to evaluate a channel. Overload with specific channel types for custom behaviour.
Public function bool

UE::MovieScene::EvaluateChannel ( const UMovieSceneSection* InSection,
const ChannelType* InChannel,
FFrameTime InTime,
ValueType& OutValue
)

 Called to evaluate a channel. Overload with specific channel types for custom behaviour.
Public function TEnableIfTMovieSceneChannelTraits< ChannelType >::SupportsDefaults, bool >::Type

UE::MovieScene::GetChannelDefault ( ChannelType* Channel,
ValueType& OutDefaultValue
)

  
Public function TEnableIf< TMovieSceneChannelTraits< ChannelType >::SupportsDefaults, bool >::Type

UE::MovieScene::GetChannelDefault ( ChannelType* Channel,
ValueType& OutDefaultValue
)

 Gets the default value for the channel if set
Public function UMovieSceneChannelOverrideContainer *

UE::MovieScene::GetChannelOverride ( const UMovieSceneSectionChannelOverrideRegistry* OverrideRegistry,
FName ChannelName
)

 Utility function to return a channel override
Public function EMovieSceneKeyInterpolation

UE::MovieScene::GetInterpolationMode ( ChannelType* InChannel,
const FFrameNumber& InTime,
EMovieSceneKeyInterpolation DefaultInterpolationMode
)

  
Public function bool

UE::MovieScene::GetKeyValue ( ChannelType* InChannel,
FKeyHandle InKeyHandle,
ValueType& OutValue
)

  
Public function bool

UE::MovieScene::IsChannelOverriden ( const UMovieSceneSectionChannelOverrideRegistry* OverrideRegistry,
FName ChannelName
)

 Utility function to return whether a channel is overriden
Public function TSharedPtr< FMovieSceneChannelProxy >

UE::MovieScene::MakeChannelProxy ( const UMovieSceneSectionChannelOverrideRegistry* OverrideRegistry,
ChannelType& DefaultChannel,
const FMovieSceneChannelMetaData& InMetaData,
ExtendedEditorDataType&& InExtendedEditorData
)

 Utility function for making a channel proxy with one channel that is maybe overriden by another channel.
Public function void

UE::MovieScene::Optimize ( ChannelType* InChannel,
const FKeyDataOptimizationParams& Params
)

 Optimize the specified channel by removing any redundant keys
Public function TEnableIf< TMovieSceneChannelTraits< ChannelType >::SupportsDefaults >::Type

UE::MovieScene::RemoveChannelDefault ( ChannelType* Channel
)

 Removes a channel's default value
Public function TEnableIfTMovieSceneChannelTraits< ChannelType >::SupportsDefaults >::Type

UE::MovieScene::RemoveChannelDefault ( ChannelType* Channel
)

  
Public function TEnableIf< TMovieSceneChannelTraits< ChannelType >::SupportsDefaults >::Type

UE::MovieScene::SetChannelDefault ( ChannelType* Channel,
ValueType&& DefaultValue
)

 Set a channel's default value
Public function TEnableIfTMovieSceneChannelTraits< ChannelType >::SupportsDefaults >::Type

UE::MovieScene::SetChannelDefault ( ChannelType* Channel,
ValueType&& DefaultValue
)

  
Public function bool

UE::MovieScene::ValueExistsAtTime ( const ChannelType* InChannel,
FFrameNumber InTime,
const ValueType& InValue
)

 Check whether the specified value already exists at the specified time
Public function bool

ValueExistsAtTime ( const FMovieSceneDoubleChannel* InChannel,
FFrameNumber InFrameNumber,
const FMovieSceneDoubleValue& InValue
)

 Overloads for common utility functions.
Public function bool

ValueExistsAtTime ( const FMovieSceneDoubleChannel* InChannel,
FFrameNumber InFrameNumber,
double Value
)

  
Public function bool

ValueExistsAtTime ( const FMovieSceneDoubleChannel* InChannel,
FFrameNumber InFrameNumber,
float Value
)

  
Public function bool

ValueExistsAtTime ( const FMovieSceneFloatChannel* InChannel,
FFrameNumber InFrameNumber,
float InValue
)

 Overloads for common utility functions.
Public function bool

ValueExistsAtTime ( const FMovieSceneFloatChannel* InChannel,
FFrameNumber InFrameNumber,
const FMovieSceneFloatValue& InValue
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page