Navigation
API > API/Plugins > API/Plugins/AvalancheTransition
A Transition Scene is a representation of what is transitioning in or out. It's validity is bound to the validity of the scene owner because it does not own the data passed to it (i.e. it holds a data view), and so cannot be used without ensuring (through the scene owner) that the scene data is still valid It can be used to represent a page or, more directly, a level streaming object. For example, an implementation could look something like this:
USTRUCT() struct FSceneData {
... };
USTRUCT() struct FMyTransitionScene : public FAvaTransitionScene {
FMyTransitionScene(FSceneData* InData) : FAvaTransitionScene(InData) { }
virtual EAvaTransitionComparisonResult Compare(const FAvaTransitionScene& InOther) override
{
const FSceneData& MySceneData = GetDataView.Get
| Name | FAvaTransitionScene |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheTransition/Public/AvaTransitionScene.h |
| Include Path | #include "AvaTransitionScene.h" |
Syntax
USTRUCT ()
struct FAvaTransitionScene
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| AvaTransitionScene.h | |||
FAvaTransitionScene
(
InStructType* InStruct |
AvaTransitionScene.h | ||
FAvaTransitionScene
(
FStateTreeDataView InDataView |
AvaTransitionScene.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FAvaTransitionScene() |
AvaTransitionScene.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DataView | FStateTreeDataView | AvaTransitionScene.h | ||
| Extensions | TMap< FName, TSharedRef< IAvaTransitionExtension > > | AvaTransitionScene.h | ||
| Flags | EAvaTransitionSceneFlags | AvaTransitionScene.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EAvaTransitionComparisonResult Compare
(
const FAvaTransitionScene& InOther |
Determines whether this Transition Scene is the same as another | AvaTransitionScene.h | |
InExtensionType * FindExtension() |
AvaTransitionScene.h | ||
const FStateTreeDataView & GetDataView() |
AvaTransitionScene.h | ||
virtual ULevel * GetLevel() |
Retrieves the underling Level of the Scene | AvaTransitionScene.h | |
virtual void GetOverrideTransitionLayer
(
FAvaTagHandle& OutTransitionLayer |
Optional override of Transition Layer | AvaTransitionScene.h | |
bool HasAllFlags
(
EAvaTransitionSceneFlags InFlags |
AvaTransitionScene.h | ||
bool HasAnyFlags
(
EAvaTransitionSceneFlags InFlags |
AvaTransitionScene.h | ||
virtual void OnFlagsChanged() |
Called when flags have been added / removed | AvaTransitionScene.h | |
void SetFlags
(
EAvaTransitionSceneFlags InFlags |
AvaTransitionScene.h | ||
virtual void UpdateSceneDescription
(
FString& InOutDescription |
Optional override for the passed in Scene Description | AvaTransitionScene.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
InExtensionType & AddExtension() |
AvaTransitionScene.h |