#include <MovieSceneChannelHandle.h>

Inheritance diagram for FMovieSceneChannelHandle:

Public Member Functions
MOVIESCENE_API	FMovieSceneChannelHandle ()

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

template<typename OtherChannelType >
TMovieSceneChannelHandle< OtherChannelType >	Cast () const

MOVIESCENE_API FName	GetChannelTypeName () const

MOVIESCENE_API int32	GetChannelIndex () const

MOVIESCENE_API FMovieSceneChannel *	Get () const

FMovieSceneChannelProxy *	GetChannelProxy () const

Static Public Member Functions
template<typename ChannelType >
static void	TrackChannelTypeName ()

Friends
bool	operator== (const FMovieSceneChannelHandle &A, const FMovieSceneChannelHandle &B)

bool	operator!= (const FMovieSceneChannelHandle &A, const FMovieSceneChannelHandle &B)

Detailed Description

Handle to a specific channel in a UMovieSceneSection. Will become nullptr when the FMovieSceneChannelProxy it was created with is reallocated.

Constructor & Destructor Documentation

◆ FMovieSceneChannelHandle() [1/2]

FMovieSceneChannelHandle::FMovieSceneChannelHandle ( )

Default constructor

◆ FMovieSceneChannelHandle() [2/2]

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

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

Member Function Documentation

◆ Cast()

template<typename OtherChannelType >

TMovieSceneChannelHandle< OtherChannelType > FMovieSceneChannelHandle::Cast ( ) const

Cast this handle to a handle of a related type. Callee is responsible for ensuring that the type's are compatible.

◆ Get()

FMovieSceneChannel * FMovieSceneChannelHandle::Get ( ) const

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.

◆ GetChannelIndex()

int32 FMovieSceneChannelHandle::GetChannelIndex ( ) const

Access this channel's index

◆ GetChannelProxy()

FMovieSceneChannelProxy * FMovieSceneChannelHandle::GetChannelProxy ( ) const

inline

Attempt to access the proxy for this channel. Will return nullptr if it is no longer valid.

◆ GetChannelTypeName()

FName FMovieSceneChannelHandle::GetChannelTypeName ( ) const

Access this channel's type identifier

◆ TrackChannelTypeName()

template<typename ChannelType >

static void FMovieSceneChannelHandle::TrackChannelTypeName ( )

inlinestatic

Friends And Related Symbol Documentation

◆ operator!=

bool operator!=	(	const FMovieSceneChannelHandle &	A,
		const FMovieSceneChannelHandle &	B
	)

friend

Compare this channel handle for inequality against another. Will return true for a handle that is to a different proxy even if it might have pointed to the same data (ie, one handle has expired)

◆ operator==

bool operator==	(	const FMovieSceneChannelHandle &	A,
		const FMovieSceneChannelHandle &	B
	)