Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineCore
Stores show flag enable/disable state, as well as per-flag override state.
Here, enable/disable state refers to the actual state of the show flag itself (ie, whether it is turned on or off). This is the value that will be applied to renders. "Override" state is whether the flag has been marked as overridden in the UI (ie, whether it is a value that graph traversal should respect). Flags must be marked as overridden in order for their values to deviate from the default.
| Name | UMovieGraphShowFlags |
| Type | class |
| Header File | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/Graph/Renderers/MovieGraphShowFlags.h |
| Include Path | #include "Graph/Renderers/MovieGraphShowFlags.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class UMovieGraphShowFlags :
public UObject ,
public IMovieGraphTraversableObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMovieGraphShowFlags
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMovieGraphShowFlags() |
Graph/Renderers/MovieGraphShowFlags.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OverriddenShowFlags | TSet< uint32 > | The show flags which have been marked as overridden in the UI (note this is NOT the enabled/disabled state of the flag itself). | Graph/Renderers/MovieGraphShowFlags.h | |
| ShowFlagEnableState | TMap< uint32, bool > | If the flag has been marked as overridden, this stores the enable/disable state of the flag. | Graph/Renderers/MovieGraphShowFlags.h | |
| ShowFlags | FEngineShowFlags | The default show flag state. | Graph/Renderers/MovieGraphShowFlags.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ApplyDefaultShowFlagValue
(
const uint32 ShowFlagIndex, |
Applies a default value to the show flags. | Graph/Renderers/MovieGraphShowFlags.h | |
const TSet< uint32 > & GetOverriddenShowFlags() |
Gets the indices of all show flags that have been overridden. | Graph/Renderers/MovieGraphShowFlags.h | |
FEngineShowFlags GetShowFlags() |
Gets a copy of the show flags. If they need to be modified, use one of the Set*() methods. | Graph/Renderers/MovieGraphShowFlags.h | |
bool IsShowFlagEnabled
(
const uint32 ShowFlagIndex |
Gets the enable/disable state for a specific show flag. | Graph/Renderers/MovieGraphShowFlags.h | |
bool IsShowFlagOverridden
(
const uint32 ShowFlagIndex |
Gets the override state for a specific show flag. | Graph/Renderers/MovieGraphShowFlags.h | |
bool IsShowFlagSetToDefaultValue
(
const uint32 ShowFlagIndex |
Determines if the provided show flag is set to a non-default value. | Graph/Renderers/MovieGraphShowFlags.h | |
void RevertShowFlagToDefaultValue
(
const uint32 ShowFlagIndex |
Reverts the provided show flag to its default value. | Graph/Renderers/MovieGraphShowFlags.h | |
void SetShowFlagEnabled
(
const uint32 ShowFlagIndex, |
Sets the enable/disable state for a specific show flag. | Graph/Renderers/MovieGraphShowFlags.h | |
void SetShowFlagOverridden
(
const uint32 ShowFlagIndex, |
Sets the override state for a specific show flag. | Graph/Renderers/MovieGraphShowFlags.h |
Overridden from IMovieGraphTraversableObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TArray< TPair< FString, FString > > GetMergedProperties () |
Gets properties, and their associated values, which have been modified by a merge. | Graph/Renderers/MovieGraphShowFlags.h | |
virtual void Merge
(
const IMovieGraphTraversableObject* InSourceObject |
Merges the contents of InSourceClass into this object. | Graph/Renderers/MovieGraphShowFlags.h |