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