StaticMeshSourceData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "MeshDescriptionBaseBulkData.h"
#include "Engine/EngineTypes.h"
#include "MeshReductionSettings.h"
#include "UObject/ObjectMacros.h"
#include "UObject/PerPlatformProperties.h"
 
#include "StaticMeshSourceData.generated.h"
 
 
struct FMeshDescription;
class UStaticMeshDescription;
 
 
UCLASS(MinimalAPI)
class UStaticMeshDescriptionBulkData : public UMeshDescriptionBaseBulkData
{
    GENERATED_BODY()
 
public:
    ENGINE_API UStaticMeshDescriptionBulkData();
};
 
 
USTRUCT()
struct FStaticMeshSourceModel
{
    GENERATED_BODY()
 
    friend class UStaticMesh;
 
public:
#if WITH_EDITOR
    class FRawMeshBulkData* RawMeshBulkData;
    
    /*
     * Accessor to Load and save the raw mesh or the mesh description depending on the editor settings.
     * Temporary until we deprecate the RawMesh.
     */
    ENGINE_API bool IsRawMeshEmpty() const;
    ENGINE_API void LoadRawMesh(struct FRawMesh& OutRawMesh) const;
    ENGINE_API void SaveRawMesh(struct FRawMesh& InRawMesh, bool bConvertToMeshdescription = true);
    
    void FillMaterialName(TMap<int32, FName>& OutMaterialMap) const;
 
 
#endif // #if WITH_EDITOR
 
#if WITH_EDITORONLY_DATA
    /*
     * We used to maintain the UStaticMesh which owned the source model here.
     * Now this is not necessary as we can get it from the Outer of the StaticMeshDescriptionBulkData.
     * This means less to maintain
     */
    UE_DEPRECATED(5.0, "StaticMeshOwner is now deprecated.")
    class UStaticMesh* StaticMeshOwner;
 
    UPROPERTY()
    TObjectPtr<UStaticMeshDescriptionBulkData> StaticMeshDescriptionBulkData;
 
    // Only allow safe read of the mesh description from the game thread while a build is running (not sure about the rest. the UStaticMeshDescription stuff look particularly dangerous)
    mutable FCriticalSection StaticMeshDescriptionBulkDataCS;
#endif
 
#if WITH_EDITOR
    ENGINE_API UStaticMesh* GetStaticMeshOwner() const;
 
    ENGINE_API bool IsSourceModelInitialized() const;
 
    ENGINE_API FMeshDescription* CreateMeshDescription();
 
    ENGINE_API bool LoadMeshDescription(FMeshDescription& OutMeshDescription) const;
 
    ENGINE_API bool CloneMeshDescription(FMeshDescription& OutMeshDescription) const;
 
    ENGINE_API FMeshDescription* GetOrCacheMeshDescription();
 
    ENGINE_API FMeshDescription* GetCachedMeshDescription() const;
 
    ENGINE_API UStaticMeshDescription* GetCachedStaticMeshDescription() const;
 
    ENGINE_API FMeshDescriptionBulkData* GetMeshDescriptionBulkData() const;
 
    ENGINE_API bool IsMeshDescriptionValid() const;
 
    ENGINE_API void CommitMeshDescription(bool bUseHashAsGuid);
 
    ENGINE_API void ClearMeshDescription();
 
    ENGINE_API void ResetReductionSetting();
#endif
 
public:
    UPROPERTY(EditAnywhere, Category=BuildSettings)
    FMeshBuildSettings BuildSettings;
 
    UPROPERTY(EditAnywhere, Category=ReductionSettings)
    FMeshReductionSettings ReductionSettings; 
 
    UPROPERTY()
    uint32 CacheMeshDescriptionTrianglesCount = MAX_uint32;
    
    UPROPERTY()
    uint32 CacheMeshDescriptionVerticesCount = MAX_uint32;
 
    UPROPERTY()
    float LODDistance_DEPRECATED;
 
    UPROPERTY(EditAnywhere, Category=ReductionSettings)
    FPerPlatformFloat ScreenSize;
 
    UPROPERTY(VisibleAnywhere, Category = StaticMeshSourceModel, AdvancedDisplay)
    FString SourceImportFilename;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    bool bImportWithBaseMesh;
#endif
 
    ENGINE_API FStaticMeshSourceModel();
 
    ENGINE_API ~FStaticMeshSourceModel();
 
    FStaticMeshSourceModel(const FStaticMeshSourceModel&) = delete;
    FStaticMeshSourceModel& operator=(const FStaticMeshSourceModel&) = delete;
 
    ENGINE_API FStaticMeshSourceModel(FStaticMeshSourceModel&& Other);
    ENGINE_API FStaticMeshSourceModel& operator=(FStaticMeshSourceModel&& Other);
 
    ENGINE_API void CreateSubObjects(UStaticMesh* Owner);
 
#if WITH_EDITOR
    void SerializeBulkData(FArchive& Ar, UObject* Owner);
 
    void ConvertRawMesh(int32 LodIndex);
#endif
};
 
 
// Make FStaticMeshSourceModel non-assignable
template<> struct TStructOpsTypeTraits<FStaticMeshSourceModel> : public TStructOpsTypeTraitsBase2<FStaticMeshSourceModel>
{
    enum { WithCopy = false };
};