Navigation
API > API/Plugins > API/Plugins/LevelSequenceEditor
Tool kit for film overlays
| Name | UFilmOverlayToolkit |
| Type | class |
| Header File | /Engine/Plugins/MovieScene/LevelSequenceEditor/Source/LevelSequenceEditor/Public/FilmOverlayToolkit.h |
| Include Path | #include "FilmOverlayToolkit.h" |
Syntax
UCLASS ()
class UFilmOverlayToolkit : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UFilmOverlayToolkit
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PrimaryFilmOverlays | TMap< FName, TSharedPtr< IFilmOverlay > > | The primary film overlays (only one can be active at a time) | FilmOverlayToolkit.h |
| ToggleableFilmOverlays | TMap< FName, TSharedPtr< IFilmOverlay > > | The toggleable film overlays (any number can be active at a time) | FilmOverlayToolkit.h |
Functions
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const TMap< FName, TSharedPtr< IFilmOverlay > > & GetPrimaryFilmOverlays() |
Get the primary film overlays | FilmOverlayToolkit.h | |
static const TMap< FName, TSharedPtr< IFilmOverlay > > & GetToggleableFilmOverlays() |
Get the toggleable film overlays | FilmOverlayToolkit.h | |
static void RegisterPrimaryFilmOverlay
(
const FName& FilmOverlayName, |
Register a primary film overlay | FilmOverlayToolkit.h | |
static void RegisterToggleableFilmOverlay
(
const FName& FilmOverlayName, |
Register a toggleable film overlay | FilmOverlayToolkit.h | |
static void UnregisterPrimaryFilmOverlay
(
const FName& FilmOverlayName |
Unregister a primary film overlay | FilmOverlayToolkit.h | |
static void UnregisterToggleableFilmOverlay
(
const FName& FilmOverlayName |
Unregister a toggleable film overlay | FilmOverlayToolkit.h |