PhysicalMaterial.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Chaos/ChaosEngineInterface.h"
#include "Containers/EnumAsByte.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "PhysicsInterfaceDeclaresCore.h"
#include "PhysicsInterfaceTypesCore.h"
#include "PhysicsSettingsEnums.h"
#include "Templates/UniquePtr.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ObjectPtr.h"
#include "UObject/UObjectGlobals.h"
 
#include "PhysicalMaterial.generated.h"
 
struct FPropertyChangedEvent;
 
namespace PhysicalMaterialCVars
{
    extern bool bShowExperimentalProperties;
}
 
 
USTRUCT(BlueprintType)
struct FPhysicalMaterialStrength
{
    GENERATED_USTRUCT_BODY()
 
    FPhysicalMaterialStrength();
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "PhysicalMaterial|Strength", meta = (ClampMin = 0, ForceUnits = "MPa"))
    float TensileStrength;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "PhysicalMaterial|Strength", meta = (ClampMin = 0, ForceUnits = "MPa"))
    float CompressionStrength;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "PhysicalMaterial|Strength", meta = (ClampMin = 0, ForceUnits = "MPa"))
    float ShearStrength;
};
 
 
USTRUCT(BlueprintType)
struct FPhysicalMaterialDamageModifier
{
    GENERATED_USTRUCT_BODY()
 
    FPhysicalMaterialDamageModifier();
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "PhysicalMaterial|DamageModifier", meta = (ClampMin = 0))
    float DamageThresholdMultiplier;
};
 
UENUM()
enum class EPhysicalMaterialSoftCollisionMode : uint8
{
    // No soft collisionss
    None,
 
    // SoftCollisionThickess is a fraction of the bounds (minimum axis). Should be less than 0.5
    RelativeThickness,
 
    // SoftCollisionThickess is an absolute value in cm
    AbsoluteThickess,
};
 
 
UCLASS(BlueprintType, Blueprintable, CollapseCategories, HideCategories = Object, MinimalAPI)
class UPhysicalMaterial : public UObject
{
    GENERATED_UCLASS_BODY()
 
    PHYSICSCORE_API virtual ~UPhysicalMaterial();
    PHYSICSCORE_API UPhysicalMaterial(FVTableHelper& Helper);
    //
    // Surface properties.
    //
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=PhysicalMaterial, meta=(ClampMin=0))
    float Friction;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = PhysicalMaterial, meta = (ClampMin = 0))
    float StaticFriction;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = PhysicalMaterial, meta = (editcondition = "bOverrideFrictionCombineMode"))
    TEnumAsByte<EFrictionCombineMode::Type> FrictionCombineMode;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = PhysicalMaterial)
    bool bOverrideFrictionCombineMode;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = PhysicalMaterial,  meta=(ClampMin=0, ClampMax=1))
    float Restitution;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = PhysicalMaterial, meta = (editcondition = "bOverrideRestitutionCombineMode"))
    TEnumAsByte<EFrictionCombineMode::Type> RestitutionCombineMode;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = PhysicalMaterial)
    bool bOverrideRestitutionCombineMode;
 
    //
    // Object properties.
    //
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = PhysicalMaterial, meta = (ClampMin = 0, ForceUnits = "g/cm3"))
    float Density;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = PhysicalMaterial, meta = (ClampMin = 0))
    float SleepLinearVelocityThreshold;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = PhysicalMaterial, meta = (ClampMin = 0))
    float SleepAngularVelocityThreshold;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = PhysicalMaterial, meta = (ClampMin = 0))
    int32 SleepCounterThreshold;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Advanced, meta=(ClampMin=0.1, ClampMax=1))
    float RaiseMassToPower;
 
    UE_DEPRECATED(5.3, "This property is not used anywhere, use Geometry Collection damage threshold related features instead")
    UPROPERTY()
    float DestructibleDamageThresholdScale_DEPRECATED;
 
    UPROPERTY()
    TObjectPtr<class UDEPRECATED_PhysicalMaterialPropertyBase> PhysicalMaterialProperty_DEPRECATED;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = PhysicalProperties)
    TEnumAsByte<EPhysicalSurface> SurfaceType;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = PhysicalProperties)
    FPhysicalMaterialStrength Strength;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = PhysicalProperties)
    FPhysicalMaterialDamageModifier DamageModifier;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Debugging", AdvancedDisplay)
    FLinearColor DebugColor;
 
    //
    // Experimental properties
    //
 
    UPROPERTY(VisibleAnywhere, Transient, Category = "Experimental")
    bool bShowExperimentalProperties = PhysicalMaterialCVars::bShowExperimentalProperties;
 
    UPROPERTY(EditAnywhere, Category = "Experimental|Softness", meta = (EditCondition = "bShowExperimentalProperties"))
    EPhysicalMaterialSoftCollisionMode SoftCollisionMode;
 
    UPROPERTY(EditAnywhere, Category = "Experimental|Softness", meta = (ClampMin = 0, EditCondition = "bShowExperimentalProperties"))
    float SoftCollisionThickness;
 
    UPROPERTY(EditAnywhere, Category = "Experimental|Stickiness", meta = (ClampMin = 0, Units = kgcm, EditCondition = "bShowExperimentalProperties"))
    float BaseFrictionImpulse;
 
public:
 
    TUniquePtr<FPhysicsMaterialHandle> MaterialHandle;
 
    FChaosUserData UserData;
 
    //~ Begin UObject Interface
#if WITH_EDITOR
    PHYSICSCORE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    static PHYSICSCORE_API void RebuildPhysicalMaterials();
#endif // WITH_EDITOR
    PHYSICSCORE_API virtual void PostLoad() override;
    PHYSICSCORE_API virtual void FinishDestroy() override;
    //~ End UObject Interface
 
    PHYSICSCORE_API virtual void Serialize(FArchive& Ar) override;
 
    PHYSICSCORE_API FPhysicsMaterialHandle& GetPhysicsMaterial();
 
    static PHYSICSCORE_API void SetEngineDefaultPhysMaterial(UPhysicalMaterial* Material);
 
    static PHYSICSCORE_API void SetEngineDefaultDestructiblePhysMaterial(UPhysicalMaterial* Material);
 
    static PHYSICSCORE_API EPhysicalSurface DetermineSurfaceType(UPhysicalMaterial const* PhysicalMaterial);
};