Navigation
API > API/Runtime > API/Runtime/MovieScene
Holds meta data that is common for rating shots in cinematic workflows. The purpose is to share this data among related tools.
Stored in ULevelSequence as meta data.
| Name | UMovieSceneShotMetaData |
| Type | class |
| Header File | /Engine/Source/Runtime/MovieScene/Public/MetaData/MovieSceneShotMetaData.h |
| Include Path | #include "MetaData/MovieSceneShotMetaData.h" |
Syntax
UCLASS (MinimalAPI)
class UMovieSceneShotMetaData :
public UObject ,
public IMovieSceneMetaDataInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMovieSceneShotMetaData
Implements Interfaces
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AssetRegistryTag_bIsFlagged | const FName | The asset registry tag that contains whether this was flagged by a user | MetaData/MovieSceneShotMetaData.h |
| AssetRegistryTag_bIsNoGood | const FName | The asset registry tag that contains whether this shot is good or not | MetaData/MovieSceneShotMetaData.h |
| AssetRegistryTag_bIsRecorded | const FName | The asset registry tag that contains whether this was recorded. | MetaData/MovieSceneShotMetaData.h |
| AssetRegistryTag_bIsSubSequence | const FName | The asset registry tag that contains whether this is a subsequence. | MetaData/MovieSceneShotMetaData.h |
| AssetRegistryTag_FavoriteRating | const FName | The asset registry tag that contains its favorite status | MetaData/MovieSceneShotMetaData.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsFlagged | TOptional< bool > | The asset registry tag that contains whether this was flagged by a user | MetaData/MovieSceneShotMetaData.h | |
| bIsNoGood | TOptional< bool > | Whether this shot is marked as not good | MetaData/MovieSceneShotMetaData.h | |
| bIsRecorded | TOptional< bool > | If this sequence was recorded. | MetaData/MovieSceneShotMetaData.h | |
| bIsSubSequence | TOptional< bool > | If this is a subsequence. | MetaData/MovieSceneShotMetaData.h | |
| FavoriteRating | TOptional< int32 > | The favorite rating is like a star rating, usually 1-3 if it was rated. | MetaData/MovieSceneShotMetaData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearFavoriteRating() |
MetaData/MovieSceneShotMetaData.h | ||
void ClearIsFlagged() |
MetaData/MovieSceneShotMetaData.h | ||
void ClearIsNoGood() |
MetaData/MovieSceneShotMetaData.h | ||
void ClearIsRecorded() |
MetaData/MovieSceneShotMetaData.h | ||
void ClearIsSubSequence() |
MetaData/MovieSceneShotMetaData.h | ||
const TOptional< int32 > & GetFavoriteRating() |
MetaData/MovieSceneShotMetaData.h | ||
const TOptional< bool > & GetIsFlagged() |
MetaData/MovieSceneShotMetaData.h | ||
const TOptional< bool > & GetIsNoGood() |
MetaData/MovieSceneShotMetaData.h | ||
const TOptional< bool > & GetIsRecorded() |
MetaData/MovieSceneShotMetaData.h | ||
const TOptional< bool > & GetIsSubSequence() |
MetaData/MovieSceneShotMetaData.h | ||
void SetFavoriteRating
(
int32 InFavoriteRating |
MetaData/MovieSceneShotMetaData.h | ||
void SetIsFlagged
(
bool bInIsFlagged |
MetaData/MovieSceneShotMetaData.h | ||
void SetIsNoGood
(
bool bInIsNoGood |
MetaData/MovieSceneShotMetaData.h | ||
void SetIsRecorded
(
bool bInIsRecorded |
MetaData/MovieSceneShotMetaData.h | ||
void SetIsSubSequence
(
bool bInIsSubSequence |
MetaData/MovieSceneShotMetaData.h |
Overridden from IMovieSceneMetaDataInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ExtendAssetRegistryTagMetaData
(
TMap< FName, UObject::FAssetRegistryTagMetadata >& OutMetadata |
Called from ULevelSequence::GetAssetRegistryTagMetadata in order to extend its default set of tag meta-data to include any from this meta-data object. | MetaData/MovieSceneShotMetaData.h | |
virtual void ExtendAssetRegistryTags
(
FAssetRegistryTagsContext Context |
Called from ULevelSequence::GetAssetRegistryTags in order to extend its default set of tags to include any from this meta-data object. | MetaData/MovieSceneShotMetaData.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| MetaData/MovieSceneShotMetaData.h | |||
static bool GetFavoriteRatingByAssetData
(
const FAssetData& InAssetData, |
MetaData/MovieSceneShotMetaData.h | ||
static bool GetIsFlaggedByAssetData
(
const FAssetData& InAssetData, |
MetaData/MovieSceneShotMetaData.h | ||
static bool GetIsNoGoodByAssetData
(
const FAssetData& InAssetData, |
MetaData/MovieSceneShotMetaData.h | ||
static bool GetIsRecordedByAssetData
(
const FAssetData& InAssetData, |
MetaData/MovieSceneShotMetaData.h | ||
static bool GetIsSubSequenceByAssetData
(
const FAssetData& InAssetData, |
MetaData/MovieSceneShotMetaData.h |
See Also
- ULevelSequenceShotMetaDataLibrary for managing data.