LevelUtils.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
 
class AActor;
class ULevel;
class ULevelStreaming;
 
class FLevelUtils
{
public:
    // Given a ULevel, find the corresponding ULevelStreaming.
 
    static ENGINE_API ULevelStreaming* FindStreamingLevel(const ULevel* Level);
 
    static ENGINE_API ULevelStreaming* FindStreamingLevel(UWorld* InWorld, const FName PackageName);
 
    static ENGINE_API ULevelStreaming* FindStreamingLevel(UWorld* InWorld, const TCHAR* PackageName);
 
    static ENGINE_API bool IsValidStreamingLevel(UWorld* InWorld, const TCHAR* InPackageName);
 
    static ENGINE_API bool IsServerStreamingLevelVisible(UWorld* InWorld, const FName& InPackageName);
 
    static ENGINE_API ULevelStreaming* GetServerVisibleStreamingLevel(UWorld* InWorld, const FName& InPackageName);
 
    static ENGINE_API bool SupportsMakingVisibleTransactionRequests(UWorld* InWorld);
 
    static ENGINE_API bool SupportsMakingInvisibleTransactionRequests(UWorld* InWorld);
 
    // Locking/unlocking levels for edit.
 
#if WITH_EDITOR
    static ENGINE_API bool IsLevelLocked(ULevel* Level);
    static ENGINE_API bool IsLevelLocked(AActor* Actor);
 
    static ENGINE_API void ToggleLevelLock(ULevel* Level);
#endif
 
    // Controls whether the level is loaded in editor.
 
    static ENGINE_API bool IsLevelLoaded(ULevel* Level);
 
 
    // Level visibility.
 
#if WITH_EDITORONLY_DATA
    static ENGINE_API bool IsStreamingLevelVisibleInEditor(const ULevelStreaming* StreamingLevel);
#endif
 
    static ENGINE_API bool IsLevelVisible(const ULevel* Level);
 
 
    struct FApplyLevelTransformParams
    {
        FApplyLevelTransformParams(ULevel* InLevel, const FTransform& InLevelTransform)
            : Level(InLevel)
            , LevelTransform(InLevelTransform)
        {
        }
 
        // The level to Transform.
        ULevel* Level;
 
        // If the actor is non null, directly transform only this actor
        AActor* Actor = nullptr;
 
        // How to Transform the level.
        const FTransform& LevelTransform;
 
        // Whether to call SetRelativeTransform or update the Location and Rotation in place without any other updating
        bool bSetRelativeTransformDirectly = false;
 
#if WITH_EDITOR
        // Whether to call PostEditMove on actors after transforming
        bool bDoPostEditMove = true;
#endif
    };
 
    static ENGINE_API void ApplyLevelTransform(const FApplyLevelTransformParams& TransformParams);
 
#if WITH_EDITOR
    // Level - editor transforms.
 
    static ENGINE_API void ApplyPostEditMove( ULevel* Level );
 
    static ENGINE_API void SetEditorTransform(ULevelStreaming* StreamingLevel, const FTransform& Transform, bool bDoPostEditMove = true);
 
    static ENGINE_API void ApplyEditorTransform(const ULevelStreaming* StreamingLevel, bool bDoPostEditMove = true, AActor* Actor = nullptr);
 
    static ENGINE_API void RemoveEditorTransform(const ULevelStreaming* StreamingLevel, bool bDoPostEditMove = true, AActor* Actor = nullptr);
 
    static ENGINE_API bool IsMovingLevel();
    static ENGINE_API bool IsApplyingLevelTransform();
 
private:
 
    // Flag to mark if we are currently finalizing a level offset
    static ENGINE_API bool bMovingLevel;
    static ENGINE_API bool bApplyingLevelTransform;
 
#endif // WITH_EDITOR
};