Navigation
API > API/Runtime > API/Runtime/MovieScene > API/Runtime/MovieScene/Channels
Inheritance Hierarchy
- TSharedFromThis< FMovieSceneChannelProxy >
- 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
| Type | Name | Description | |
|---|---|---|---|
| FSimpleMulticastDelegate | OnDestroy |
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Default construction - emtpy proxy | |||
FMovieSceneChannelProxy
(
FMovieSceneChannelProxyData&& InChannels |
Construction via multiple channels | ||
FMovieSceneChannelProxy
(
const FMovieSceneChannelProxy& |
Not copyable or moveable to ensure that previously retrieved pointers remain valid for the lifetime of this object. | ||
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. | ||
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. |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| const FMovieSceneChannelEntry * | FindEntry
(
FName ChannelTypeName |
Find an entry by its channel type name | |
| int32 | FindIndex
(
FName ChannelTypeName, |
Find the index of the specified channel ptr in this proxy | |
| TArrayView< const FMovieSceneChannelEntry > | Const access to all the entries in this proxy | ||
| TArrayView< const typename TMovieSceneChannelTraits< ChannelType >::ExtendedEditorDataType > | Access all the extended data for the templated channel type | ||
| ChannelType * | GetChannel
(
int32 ChannelIndex |
Get the channel for the specified index of a particular type. | |
| FMovieSceneChannel * | GetChannel
(
FName ChannelTypeName, |
Get the channel for the specified index of a particular type. | |
| TMovieSceneChannelHandle< ChannelType > | GetChannelByName
(
FName ChannelName |
Get the channel with the specified name, assuming it is of a given type | |
| FMovieSceneChannelHandle | GetChannelByName
(
FName ChannelName |
Get the channel with the specified name | |
| TArrayView< ChannelType * > | GetChannels () |
Get all channels of the specified type | |
| TArrayView< const FMovieSceneChannelMetaData > | GetMetaData () |
Access all the editor meta data for the templated channel type | |
| TMovieSceneChannelHandle< ChannelType > | MakeHandle
(
int32 Index |
Make a channel handle out for the specified index and templated channel type | |
| FMovieSceneChannelHandle | MakeHandle
(
FName ChannelTypeName, |
Make a channel handle out for the specified index and channel type name | |
| int32 | NumChannels () |
Returns the total number of channels |
Operators
| Type | Name | Description | |
|---|---|---|---|
| FMovieSceneChannelProxy & | operator=
(
const FMovieSceneChannelProxy& |
||
| FMovieSceneChannelProxy & |