1. Epic GamesDeveloper
  3. FMovieSceneChannelProxy

FMovieSceneChannelProxy

Proxy type stored inside [UMovieSceneSection](API\Runtime\MovieScene\UMovieSceneSection) for access to all its channels.

API > API/Runtime > API/Runtime/MovieScene

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

   
Name FMovieSceneChannelProxy
Type struct
Header File /Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneChannelProxy.h
Include Path #include "Channels/MovieSceneChannelProxy.h"

Syntax

struct FMovieSceneChannelProxy : public TSharedFromThis< FMovieSceneChannelProxy >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FMovieSceneChannelProxy ( ChannelType& InChannel,
const FMovieSceneChannelMetaData& InMetaData,
ExtendedEditorDataType&& InExtendedEditorData
)

 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. Channels/MovieSceneChannelProxy.h  

FMovieSceneChannelProxy ( ChannelType& InChannel,
const FMovieSceneChannelMetaData& InMetaData
)

 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. Channels/MovieSceneChannelProxy.h  
  Channels/MovieSceneChannelProxy.h  
Not copyable or moveable to ensure that previously retrieved pointers remain valid for the lifetime of this object. Channels/MovieSceneChannelProxy.h  
Construction via multiple channels Channels/MovieSceneChannelProxy.h  
Default construction - emtpy proxy Channels/MovieSceneChannelProxy.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FMovieSceneChannelProxy()

   Channels/MovieSceneChannelProxy.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnDestroy FSimpleMulticastDelegate   Channels/MovieSceneChannelProxy.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bHandlesByNamePopulated bool Whether the named channel table has been populated Channels/MovieSceneChannelProxy.h  
Entries TArray< FMovieSceneChannelEntry, TInlineAllocator< 1 > > Array of channel entries, one per channel type. Channels/MovieSceneChannelProxy.h  
HandlesByName TMap< FName, FMovieSceneChannelHandle > Lazy-created lookup table between a channel name and a channel handle Channels/MovieSceneChannelProxy.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Make a new channel handle for the same channel type name and index for this channel proxy Channels/MovieSceneChannelProxy.h  

const FMovieSceneChannelEntry * FindEntry ( FName ChannelTypeName
) const

 Find an entry by its channel type name Channels/MovieSceneChannelProxy.h  

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

 Find the index of the specified channel ptr in this proxy Channels/MovieSceneChannelProxy.h  

TArrayView< const FMovieSceneChannelEntry > GetAllEntries()

 Const access to all the entries in this proxy Channels/MovieSceneChannelProxy.h  

TArrayView< const typename TMovieSceneChannelTraits< ChannelType >::ExtendedEditorDataType > GetAllExtendedEditorData()

 Access all the extended data for the templated channel type Channels/MovieSceneChannelProxy.h  

ChannelType * GetChannel ( int32 ChannelIndex
) const

 Get the channel for the specified index of a particular type. Channels/MovieSceneChannelProxy.h  

FMovieSceneChannel * GetChannel ( FName ChannelTypeName,
int32 ChannelIndex
) const

 Get the channel for the specified index of a particular type. Channels/MovieSceneChannelProxy.h  

TMovieSceneChannelHandle< ChannelType > GetChannelByName ( FName ChannelName
) const

 Get the channel with the specified name, assuming it is of a given type Channels/MovieSceneChannelProxy.h  
Get the channel with the specified name Channels/MovieSceneChannelProxy.h  

TArrayView< ChannelType * > GetChannels()

 Get all channels of the specified type Channels/MovieSceneChannelProxy.h  

TArrayView< const FMovieSceneChannelMetaData > GetMetaData()

 Access all the editor meta data for the templated channel type Channels/MovieSceneChannelProxy.h  

TMovieSceneChannelHandle< ChannelType > MakeHandle ( int32 Index
)

 Make a channel handle out for the specified index and templated channel type Channels/MovieSceneChannelProxy.h  

FMovieSceneChannelHandle MakeHandle ( FName ChannelTypeName,
int32 Index
)

 Make a channel handle out for the specified index and channel type name Channels/MovieSceneChannelProxy.h  

int32 NumChannels()

 Returns the total number of channels Channels/MovieSceneChannelProxy.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Channels/MovieSceneChannelProxy.h  
  Channels/MovieSceneChannelProxy.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page