FMovieSceneChannelProxy

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

Windows
MacOS
Linux

Inheritance Hierarchy

TSharedFromThis

FMovieSceneChannelProxy

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

Name Description

Public variable

FSimpleMulticas...

 

OnDestroy

Constructors

Name Description

Public function

FMovieSceneChannelProxy()

Default construction - emtpy proxy

Public function

FMovieSceneChannelProxy

(
    FMovieSceneChannelProxyData&& InCh...
)

Construction via multiple channels

Public function

FMovieSceneChannelProxy

(
    const FMovieSceneChannelProxy&
)

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

Public function

FMovieSceneChannelProxy

Public function

FMovieSceneChannelProxy

(
    ChannelType& InChannel,
    const FMovieSceneChannelMetaData& ...
)

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& ...,
    ExtendedEditorDataType&& InExtende...
)

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

Name Description

Public function

~FMovieSceneChannelProxy()

Functions

Name Description

Public function Const

const FMovie...

 

FindEntry

(
    FName ChannelTypeName
)

Find an entry by its channel type name

Public function Const

int32

 

FindIndex

(
    FName ChannelTypeName,
    const FMovieSceneChannel* Chan...
)

Find the index of the specified channel ptr in this proxy

Public function Const

TArrayView< ...

 

GetAllEntries()

Const access to all the entries in this proxy

Public function Const

TArrayView< ...

 

GetAllExtendedEditorData()

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

FMovieSceneC...

 

GetChannel

(
    FName ChannelTypeName,
    int32 ChannelIndex
)

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

Public function Const

TArrayView< ...

 

GetChannels()

Get all channels of the specified type

Public function Const

TArrayView< ...

 

GetMetaData()

Access all the editor meta data for the templated channel type

Public function

TMovieSceneC...

 

MakeHandle

(
    int32 Index
)

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

Public function

FMovieSceneC...

 

MakeHandle

(
    FName ChannelTypeName,
    int32 Index
)

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

Operators

Name Description

Public function

FMovieSceneC...

 

operator=

(
    const FMovieSceneChannelProxy&
)

Public function

FMovieSceneC...

 

operator=

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss