FMovieSceneChannelProxy Struct Reference

#include <MovieSceneChannelProxy.h>

Inheritance diagram for FMovieSceneChannelProxy:

Public Member Functions
	FMovieSceneChannelProxy ()
	~FMovieSceneChannelProxy ()
	FMovieSceneChannelProxy (FMovieSceneChannelProxyData &&InChannels)
	FMovieSceneChannelProxy (const FMovieSceneChannelProxy &)=delete
FMovieSceneChannelProxy &	operator= (const FMovieSceneChannelProxy &)=delete
	FMovieSceneChannelProxy (FMovieSceneChannelProxy &&)=delete
FMovieSceneChannelProxy &	operator= (FMovieSceneChannelProxy &&)=delete
TArrayView< const FMovieSceneChannelEntry >	GetAllEntries () const
MOVIESCENE_API const FMovieSceneChannelEntry *	FindEntry (FName ChannelTypeName) const
MOVIESCENE_API int32	FindIndex (FName ChannelTypeName, const FMovieSceneChannel *ChannelPtr) const
template<typename ChannelType >
TArrayView< ChannelType * >	GetChannels () const
template<typename ChannelType >
ChannelType *	GetChannel (int32 ChannelIndex) const
MOVIESCENE_API FMovieSceneChannel *	GetChannel (FName ChannelTypeName, int32 ChannelIndex) const
MOVIESCENE_API int32	NumChannels () const
MOVIESCENE_API FMovieSceneChannelHandle	MakeHandle (FName ChannelTypeName, int32 Index)
template<typename ChannelType >
TMovieSceneChannelHandle< ChannelType >	MakeHandle (int32 Index)
template<typename ChannelType >
TMovieSceneChannelHandle< ChannelType >	CopyHandle (TMovieSceneChannelHandle< ChannelType > InOtherHandle)
template<typename ChannelType >
	FMovieSceneChannelProxy (ChannelType &InChannel)
Public Member Functions inherited from TSharedFromThis< FMovieSceneChannelProxy >
TSharedRef< FMovieSceneChannelProxy, Mode >	AsShared ()
TSharedRef< FMovieSceneChannelProxy const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FMovieSceneChannelProxy, Mode >	AsWeak ()
TWeakPtr< FMovieSceneChannelProxy const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Public Attributes
FSimpleMulticastDelegate	OnDestroy

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FMovieSceneChannelProxy >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FMovieSceneChannelProxy >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

Proxy type stored inside UMovieSceneSection for access to all its channels. Construction via either a single channel, or a FMovieSceneChannelProxyData structure This proxy exists as a generic accessor to any channel data existing in derived types

Constructor & Destructor Documentation

FMovieSceneChannelProxy() [1/5]

FMovieSceneChannelProxy::FMovieSceneChannelProxy ( )

inline

Default construction - emtpy proxy

~FMovieSceneChannelProxy()

FMovieSceneChannelProxy::~FMovieSceneChannelProxy ( )

inline

FMovieSceneChannelProxy() [2/5]

FMovieSceneChannelProxy::FMovieSceneChannelProxy ( FMovieSceneChannelProxyData &&  InChannels )

inline

Construction via multiple channels

FMovieSceneChannelProxy() [3/5]

FMovieSceneChannelProxy::FMovieSceneChannelProxy ( const FMovieSceneChannelProxy &  )

delete

Not copyable or moveable to ensure that previously retrieved pointers remain valid for the lifetime of this object.

FMovieSceneChannelProxy() [4/5]

FMovieSceneChannelProxy::FMovieSceneChannelProxy ( FMovieSceneChannelProxy &&  )

delete

FMovieSceneChannelProxy() [5/5]

template<typename ChannelType >

FMovieSceneChannelProxy::FMovieSceneChannelProxy

(

ChannelType &

InChannel

)

Construction via a single channel, and its editor data Channel's address is stored internally as a voic* and should exist as long as this channel proxy does.

Member Function Documentation

CopyHandle()

template<typename ChannelType >

TMovieSceneChannelHandle< ChannelType > FMovieSceneChannelProxy::CopyHandle ( TMovieSceneChannelHandle< ChannelType >  InOtherHandle )

inline

Make a new channel handle for the same channel type name and index for this channel proxy

Returns

A handle to the supplied channel that will become nullptr when the proxy is reallocated, or nullptr if the index or channel type name are invalid.

FindEntry()

const FMovieSceneChannelEntry * FMovieSceneChannelProxy::FindEntry

(

FName

ChannelTypeName

)

const

Find an entry by its channel type name

Returns

A pointer to the channel, or nullptr

FindIndex()

int32 FMovieSceneChannelProxy::FindIndex	(	FName	ChannelTypeName,
		const FMovieSceneChannel *	ChannelPtr
	)		const

Find the index of the specified channel ptr in this proxy

Parameters

ChannelTypeName	The type name of the channel
ChannelPtr	The channel pointer to find

Returns

The index of the channel if found, else INDEX_NONE

GetAllEntries()

TArrayView< const FMovieSceneChannelEntry > FMovieSceneChannelProxy::GetAllEntries ( ) const

inline

Const access to all the entries in this proxy

Returns

Array view of all this proxy's entries (channels grouped by type)

GetChannel() [1/2]

FMovieSceneChannel * FMovieSceneChannelProxy::GetChannel	(	FName	ChannelTypeName,
		int32	ChannelIndex
	)		const

Get the channel for the specified index of a particular type.

Returns

A pointer to the channel, or nullptr if the index was invalid, or the type was not present

GetChannel() [2/2]

template<typename ChannelType >

ChannelType * FMovieSceneChannelProxy::GetChannel

(

int32

ChannelIndex

)

const

Get the channel for the specified index of a particular type.

Returns

A pointer to the channel, or nullptr if the index was invalid, or the type was not present

GetChannels()

template<typename ChannelType >

TArrayView< ChannelType * > FMovieSceneChannelProxy::GetChannels

(

)

const

Get all channels of the specified type

Returns

A possibly empty array view of all the channels in this proxy that match the template type

MakeHandle() [1/2]

FMovieSceneChannelHandle FMovieSceneChannelProxy::MakeHandle	(	FName	ChannelTypeName,
		int32	Index
	)

Make a channel handle out for the specified index and channel type name

Returns

A handle to the supplied channel that will become nullptr when the proxy is reallocated, or nullptr if the index or channel type name are invalid.

MakeHandle() [2/2]

template<typename ChannelType >

TMovieSceneChannelHandle< ChannelType > FMovieSceneChannelProxy::MakeHandle ( int32  Index )

inline

Make a channel handle out for the specified index and templated channel type

Returns

A handle to the supplied channel that will become nullptr when the proxy is reallocated, or nullptr if the index or channel type name are invalid.

NumChannels()

int32 FMovieSceneChannelProxy::NumChannels

(

)

const

Returns the total number of channels

Returns

The total number of channels

operator=() [1/2]

FMovieSceneChannelProxy & FMovieSceneChannelProxy::operator= ( const FMovieSceneChannelProxy &  )

delete

operator=() [2/2]

FMovieSceneChannelProxy & FMovieSceneChannelProxy::operator= ( FMovieSceneChannelProxy &&  )

delete

Member Data Documentation

OnDestroy

FSimpleMulticastDelegate FMovieSceneChannelProxy::OnDestroy

---

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

• Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneChannelProxy.h
• Engine/Source/Runtime/MovieScene/Private/Channels/MovieSceneChannelProxy.cpp