UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TMovieSceneChannelHandle< ChannelType > Struct Template Reference

#include <MovieSceneChannelHandle.h>

Public Member Functions

 TMovieSceneChannelHandle ()
 
 TMovieSceneChannelHandle (TWeakPtr< FMovieSceneChannelProxy > InWeakChannelProxy, int32 InChannelIndex)
 
ChannelType * Get () const
 

Protected Member Functions

 TMovieSceneChannelHandle (TWeakPtr< FMovieSceneChannelProxy > InWeakChannelProxy, FName InChannelTypeName, int32 InChannelIndex)
 

Protected Attributes

friend FMovieSceneChannelHandle
 

Detailed Description

template<typename ChannelType>
struct TMovieSceneChannelHandle< ChannelType >

Forward declaration of a typed channel handle. Typed channel handles replicate the inheritance hierarchy of their channels in order that overload resolution on them can happen without user-conversion or templating

Handle to a specific channel in a UMovieSceneSection. Will become nullptr when the FMovieSceneChannelProxy it was created with is reallocated. The handle class hierarchy matches that of the channel itself so that functions can be overloaded for any given base/derived handle type

Constructor & Destructor Documentation

◆ TMovieSceneChannelHandle() [1/3]

template<typename ChannelType >
TMovieSceneChannelHandle< ChannelType >::TMovieSceneChannelHandle ( )
inline

◆ TMovieSceneChannelHandle() [2/3]

template<typename ChannelType >
TMovieSceneChannelHandle< ChannelType >::TMovieSceneChannelHandle ( TWeakPtr< FMovieSceneChannelProxy InWeakChannelProxy,
int32  InChannelIndex 
)
inline

Construction from a weak channel proxy, and the channel's index

◆ TMovieSceneChannelHandle() [3/3]

template<typename ChannelType >
TMovieSceneChannelHandle< ChannelType >::TMovieSceneChannelHandle ( TWeakPtr< FMovieSceneChannelProxy InWeakChannelProxy,
FName  InChannelTypeName,
int32  InChannelIndex 
)
inlineprotected

Member Function Documentation

◆ Get()

template<typename ChannelType >
ChannelType * TMovieSceneChannelHandle< ChannelType >::Get ( ) const
inline

Get the channel pointer this handle represents.

Returns
the channel's pointer, or nullptr if the proxy it was created with is no longer alive.

Member Data Documentation

◆ FMovieSceneChannelHandle

template<typename ChannelType >
friend TMovieSceneChannelHandle< ChannelType >::FMovieSceneChannelHandle
protected

The documentation for this struct was generated from the following file: