Navigation
API > API/Runtime > API/Runtime/MovieScene
Editor meta data for a channel of data within a movie scene section
| Name | FMovieSceneChannelMetaData |
| Type | struct |
| Header File | /Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneChannelEditorData.h |
| Include Path | #include "Channels/MovieSceneChannelEditorData.h" |
Syntax
struct FMovieSceneChannelMetaData
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default Constructor | Channels/MovieSceneChannelEditorData.h | ||
FMovieSceneChannelMetaData
(
FName InName, |
Construction from a name and display text. Necessary when there is more than one channel. | Channels/MovieSceneChannelEditorData.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCanCollapseToTrack | uint8 | True if this channel can be collapsed onto the top level track node | Channels/MovieSceneChannelEditorData.h | |
| bCanPreserveRatio | bool | Whether this channel can preserve the ratio to its grouped channels when editing | Channels/MovieSceneChannelEditorData.h | |
| bEnabled | uint8 | Whether this channel is enabled or not | Channels/MovieSceneChannelEditorData.h | |
| bInvertValue | bool | Invert the value for display purposes | Channels/MovieSceneChannelEditorData.h | |
| bPreserveRatio | bool | Determines whether preserve ratio is enabled or not, not saved | Channels/MovieSceneChannelEditorData.h | |
| bRelativeToSection | uint8 | True if this channel's times are defined relative to the section start time | Channels/MovieSceneChannelEditorData.h | |
| bSortEmptyGroupsLast | bool | By default if a channel has no FText::Group specified, we put it last, by setting this to false we use SortIndex instead | Channels/MovieSceneChannelEditorData.h | |
| Color | TOptional< FLinearColor > | Optional color to draw underneath the keys on this channel | Channels/MovieSceneChannelEditorData.h | |
| DisplayText | FText | Text to display on this channel's key area node | Channels/MovieSceneChannelEditorData.h | |
| GetGroupTooltipTextDelegate | FGetMovieSceneTooltipText | Delegate to get a dynamic tooltip for the group | Channels/MovieSceneChannelEditorData.h | |
| GetTooltipTextDelegate | FGetMovieSceneTooltipText | Delegate to get a dynamic tooltip for the key area node | Channels/MovieSceneChannelEditorData.h | |
| Group | FText | Name to group this channel with others of the same group name | Channels/MovieSceneChannelEditorData.h | |
| IntentName | FText | Intent name | Channels/MovieSceneChannelEditorData.h | |
| KeyOffset | TAttribute< FFrameNumber > | Key offset | Channels/MovieSceneChannelEditorData.h | |
| LongIntentNameFormat | FText | Optional. If unspecified IKeyArea::CreateCurveEditorModel will create a fallback. | Channels/MovieSceneChannelEditorData.h | |
| Name | FName | This channel's unique name | Channels/MovieSceneChannelEditorData.h | |
| PropertyMetaData | TMap< FName, FString > | Property meta data | Channels/MovieSceneChannelEditorData.h | |
| SortOrder | uint32 | A sort order for this channel. | Channels/MovieSceneChannelEditorData.h | |
| SubPropertyPath | FName | Path representation of a sub property relative to the class property (i.e. topmost property) but NOT including the topmost property itself. | Channels/MovieSceneChannelEditorData.h | |
| SubPropertyPathMap | TMap< FName, FName > | Path representation of a sub-property relative to a class property (i.e. topmost property) but NOT including the topmost property itself. | Channels/MovieSceneChannelEditorData.h | |
| WeakOwningObject | TWeakObjectPtr | Optional object that owns this channel. | Channels/MovieSceneChannelEditorData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FFrameNumber GetOffsetTime
(
const UMovieSceneSection* InSection |
Get the amount that all of this channel's keys are offset by | Channels/MovieSceneChannelEditorData.h | |
| Get property metadata that corresponds to the given key. | Channels/MovieSceneChannelEditorData.h | ||
| Set the identifiers for this editor data | Channels/MovieSceneChannelEditorData.h |