1. Epic GamesDeveloper
  3. FMovieSceneChannelProxy

FMovieSceneChannelProxy

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

Unreal Engine C++ API Reference > Runtime > MovieScene > Channels

Inheritance Hierarchy

References

   
Module MovieScene
Header /Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneChannelProxy.h
Include #include "Channels/MovieSceneChannelProxy.h"

Syntax

struct FMovieSceneChannelProxy : public TSharedFromThis< FMovieSceneChannelProxy >

Remarks

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

Variables

  Type Name Description
Public variable FSimpleMulticastDelegate OnDestroy  

Constructors

  Type Name Description
Public function   Default construction - emtpy proxy
Public function   Construction via multiple channels
Public function   Not copyable or moveable to ensure that previously retrieved pointers remain valid for the lifetime of this object.
Public function    
Public function  

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.
Public function  

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.

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const const FMovieSceneChannelEntry *

FindEntry ( FName ChannelTypeName
)

 Find an entry by its channel type name
Public function Const int32

FindIndex ( FName ChannelTypeName,
const FMovieSceneChannel* ChannelPtr
)

 Find the index of the specified channel ptr in this proxy
Public function Const TArrayView< const FMovieSceneChannelEntry > Const access to all the entries in this proxy
Public function Const TArrayView< const typename TMovieSceneChannelTraits< ChannelType >::ExtendedEditorDataType > Access all the extended data for the templated channel type
Public function Const ChannelType *

GetChannel ( int32 ChannelIndex
)

 Get the channel for the specified index of a particular type.
Public function Const FMovieSceneChannel *

GetChannel ( FName ChannelTypeName,
int32 ChannelIndex
)

 Get the channel for the specified index of a particular type.
Public function Const TMovieSceneChannelHandle< ChannelType >

GetChannelByName ( FName ChannelName
)

 Get the channel with the specified name, assuming it is of a given type
Public function Const FMovieSceneChannelHandle

GetChannelByName ( FName ChannelName
)

 Get the channel with the specified name
Public function Const TArrayView< ChannelType * > Get all channels of the specified type
Public function Const TArrayView< const FMovieSceneChannelMetaData > Access all the editor meta data for the templated channel type
Public function TMovieSceneChannelHandle< ChannelType >

MakeHandle ( int32 Index
)

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

MakeHandle ( FName ChannelTypeName,
int32 Index
)

 Make a channel handle out for the specified index and channel type name
Public function Const int32 Returns the total number of channels

Operators

  Type Name Description
Public function FMovieSceneChannelProxy &  
Public function FMovieSceneChannelProxy &  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page