ShapeComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Templates/SubclassOf.h"
#include "Components/PrimitiveComponent.h"
#include "ShapeComponent.generated.h"
 
class FPrimitiveSceneProxy;
struct FNavigableGeometryExport;
struct FNavigationRelevantData;
 
namespace physx
{
    class PxShape;
}
 
UCLASS(abstract, hidecategories=(Object,LOD,Lighting,TextureStreaming,Activation,"Components|Activation"), editinlinenew, meta=(BlueprintSpawnableComponent), showcategories=(Mobility), MinimalAPI)
class UShapeComponent : public UPrimitiveComponent
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(transient, duplicatetransient)
    TObjectPtr<class UBodySetup> ShapeBodySetup;
 
#if WITH_EDITORONLY_DATA
    UE_DEPRECATED(5.0, "AreaClass is deprecated, use AreaClassOverride / bUseSystemDefaultObstacleAreaClass instead!.")
    UPROPERTY()
    TSubclassOf<class UNavAreaBase> AreaClass;
#endif // WITH_EDITORONLY_DATA
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, BlueprintReadWrite, Category=Shape)
    FColor ShapeColor;
 
    UPROPERTY()
    uint8 bDrawOnlyIfSelected:1;
 
    UPROPERTY()
    uint8 bShouldCollideWhenPlacing:1;
 
    UPROPERTY(EditAnywhere, Category = Navigation)
    uint8 bDynamicObstacle : 1;
 
protected:
    UPROPERTY(EditAnywhere, Category = Navigation, meta = (EditCondition = "bDynamicObstacle"))
    uint8 bUseSystemDefaultObstacleAreaClass : 1;
 
    uint8 bUseArchetypeBodySetup : 1;
 
    UPROPERTY(EditAnywhere, Category = Navigation, meta = (EditCondition = "bDynamicObstacle && !bUseSystemDefaultObstacleAreaClass"))
    TSubclassOf<class UNavAreaBase> AreaClassOverride;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Shape)
    float LineThickness;
    
    template<typename ComponentType>
    bool PrepareSharedBodySetup()
    {
        bool bSuccess = bUseArchetypeBodySetup;
        if (bUseArchetypeBodySetup && ShapeBodySetup == nullptr)
        {
            ShapeBodySetup = CastChecked<ComponentType>(GetArchetype())->GetBodySetup();
            bSuccess = ShapeBodySetup != nullptr;
        }
 
        return bSuccess;
    }
 
    template <typename ShapeElemType> void AddShapeToGeomArray();
    template <typename ShapeElemType> void SetShapeToNewGeom(const FPhysicsShapeHandle& Shape);
    template <typename ShapeElemType> void CreateShapeBodySetupIfNeeded();
 
public:
    // Set the LineThickness
    UFUNCTION(BlueprintCallable, Category=Shape)
    ENGINE_API void SetLineThickness(float Thickness);
 
    //~ Begin UPrimitiveComponent Interface.
    ENGINE_API virtual FPrimitiveSceneProxy* CreateSceneProxy() override;
    ENGINE_API virtual class UBodySetup* GetBodySetup() override;
    ENGINE_API virtual bool DoCustomNavigableGeometryExport(FNavigableGeometryExport& GeomExport) const override;
    ENGINE_API virtual void GetNavigationData(FNavigationRelevantData& Data) const override;
    //~ End UPrimitiveComponent Interface.
 
    //~ Begin INavRelevantInterface Interface
    ENGINE_API virtual bool IsNavigationRelevant() const override;
    //~ End INavRelevantInterface Interface
 
    //~ Begin USceneComponent Interface
    ENGINE_API virtual FBoxSphereBounds CalcBounds(const FTransform& LocalToWorld) const override;
    virtual bool ShouldCollideWhenPlacing() const override
    {
        return bShouldCollideWhenPlacing || IsCollisionEnabled();
    }
    //~ End USceneComponent Interface
 
    //~ Begin UObject Interface.
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
    virtual bool GetIgnoreBoundsForEditorFocus() const override { return true; }
#if WITH_EDITORONLY_DATA
    static ENGINE_API void DeclareConstructClasses(TArray<FTopLevelAssetPath>& OutConstructClasses, const UClass* SpecificSubclass);
#endif
 
#if WITH_EDITOR
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
    //~ End UObject Interface.
 
    ENGINE_API virtual void UpdateBodySetup();
 
    ENGINE_API TSubclassOf<class UNavAreaBase> GetDesiredAreaClass() const;
    ENGINE_API void SetAreaClassOverride(TSubclassOf<class UNavAreaBase> InAreaClassOverride);
    ENGINE_API void SetUseSystemDefaultObstacleAreaClass();
};
 
enum class EShapeBodySetupHelper
{
    InvalidateSharingIfStale,
    UpdateBodySetup
};