ModelComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
 
#pragma once
 
#include "CoreMinimal.h"
#include "Containers/IndirectArray.h"
#include "UObject/ObjectMacros.h"
#include "Model.h"
#include "Interfaces/Interface_CollisionDataProvider.h"
#include "Engine/TextureStreamingTypes.h"
#include "Components/PrimitiveComponent.h"
#include "ModelComponent.generated.h"
 
class FLightingBuildOptions;
class FPrimitiveSceneProxy;
class ULightComponent;
class UMaterialInterface;
struct FStaticLightingPrimitiveInfo;
 
//
// Forward declarations
//
class FModelElement;
 
UCLASS(MinimalAPI)
class UModelComponent : public UPrimitiveComponent, public IInterface_CollisionDataProvider
{
    GENERATED_UCLASS_BODY()
 
private:
    TObjectPtr<class UModel> Model;
 
    int32 ComponentIndex;
 
public:
 
    UPROPERTY()
    TObjectPtr<class UBodySetup> ModelBodySetup;
 
private:
    TArray<uint16> Nodes;
 
    TIndirectArray<FModelElement> Elements;
 
public:
 
#if WITH_EDITOR
    void InitializeModelComponent(UModel* InModel, uint16 InComponentIndex, uint32 MaskedSurfaceFlags, const TArray<uint16>& InNodes);
#endif // WITH_EDITOR
 
    void CommitSurfaces();
 
    void BuildRenderData();
 
    void ShrinkElements();
 
    ENGINE_API void GetSurfaceLightMapResolution( int32 SurfaceIndex, int32 QualityScale, int32& Width, int32& Height, FMatrix& WorldToMap, TArray<int32>* GatheredNodes=NULL ) const;
 
    ENGINE_API void CopyElementsFrom(UModelComponent* OtherModelComponent);
 
    //~ Begin UPrimitiveComponent Interface.
    virtual void CreateRenderState_Concurrent(FRegisterComponentContext* Context) override;
    virtual void DestroyRenderState_Concurrent() override;
    virtual bool GetLightMapResolution( int32& Width, int32& Height ) const override;
    virtual int32 GetStaticLightMapResolution() const override;
    virtual void GetLightAndShadowMapMemoryUsage( int32& LightMapMemoryUsage, int32& ShadowMapMemoryUsage ) const override;
    virtual FBoxSphereBounds CalcBounds(const FTransform& LocalToWorld) const override;
    virtual FPrimitiveSceneProxy* CreateSceneProxy() override;
    virtual bool ShouldRecreateProxyOnUpdateTransform() const override;
#if WITH_EDITOR
    virtual void GetStaticLightingInfo(FStaticLightingPrimitiveInfo& OutPrimitiveInfo,const TArray<ULightComponent*>& InRelevantLights,const FLightingBuildOptions& Options) override;
    virtual void AddMapBuildDataGUIDs(TSet<FGuid>& InGUIDs) const override;
#endif
    virtual ELightMapInteractionType GetStaticLightingType() const override { return LMIT_Texture;  }
    virtual void GetStreamingRenderAssetInfo(FStreamingTextureLevelContext& LevelContext, TArray<FStreamingRenderAssetPrimitiveInfo>& OutStreamingRenderAssets) const override;
    virtual void GetUsedMaterials(TArray<UMaterialInterface*>& OutMaterials, bool bGetDebugMaterials = false) const override;
    virtual class UBodySetup* GetBodySetup() override { return ModelBodySetup; };
    virtual int32 GetNumMaterials() const override;
    virtual UMaterialInterface* GetMaterial(int32 MaterialIndex) const override;
    virtual UMaterialInterface* GetMaterialFromCollisionFaceIndex(int32 FaceIndex, int32& SectionIndex) const override;
    virtual bool IsPrecomputedLightingValid() const override;
    //~ End UPrimitiveComponent Interface.
 
    //~ Begin UActorComponent Interface.
    virtual void InvalidateLightingCacheDetailed(bool bInvalidateBuildEnqueuedLighting, bool bTranslationOnly) override;
    virtual void PropagateLightingScenarioChange() override;
    //~ End UActorComponent Interface.
 
    //~ Begin UObject Interface.
    virtual void Serialize(FArchive& Ar) override;
    virtual void PostLoad() override;
#if WITH_EDITOR
    virtual void PostEditUndo() override;
#endif // WITH_EDITOR
    virtual bool IsNameStableForNetworking() const override;
    static void AddReferencedObjects(UObject* InThis, FReferenceCollector& Collector);
    //~ End UObject Interface.
 
    //~ Begin Interface_CollisionDataProvider Interface
    virtual bool GetPhysicsTriMeshData(struct FTriMeshCollisionData* CollisionData, bool InUseAllTriData) override;
    virtual bool GetTriMeshSizeEstimates(struct FTriMeshCollisionDataEstimates& OutTriMeshEstimates, bool bInUseAllTriData) const override;
    virtual bool ContainsPhysicsTriMeshData(bool InUseAllTriData) const override;
    virtual bool WantsNegXTriMesh() override { return false; }
    //~ End Interface_CollisionDataProvider Interface
 
 
    void CreateModelBodySetup();
 
#if WITH_EDITOR
    ENGINE_API void SelectAllSurfaces();
 
    void InvalidateCollisionData();
 
    virtual bool GenerateElements(bool bBuildRenderData);
#endif // WITH_EDITOR
 
    //
    // Accessors.
    //
 
    UModel* GetModel() const { return Model; }
    const TIndirectArray<FModelElement>& GetElements() const { return Elements; }
    TIndirectArray<FModelElement>& GetElements() { return Elements; }
 
    static FModelElement* CreateNewTempElement(UModelComponent* Component);
 
    ENGINE_API static void ApplyTempElements(bool bLightingWasSuccessful);
 
 
private:
    static TMap<UModelComponent*, TIndirectArray<FModelElement> > TempBSPElements;
 
    friend void SetDebugLightmapSample(TArray<UActorComponent*>* Components, UModel* Model, int32 iSurf, FVector ClickLocation);
    friend class UModel;
    friend class FStaticLightingSystem;
 
protected:
    virtual bool SupportsStaticLighting() const override
    {
        return true;
    }
};