CapsuleComponent.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 "Components/ShapeComponent.h"
#include "CapsuleComponent.generated.h"
 
class FPrimitiveSceneProxy;
 
UCLASS(ClassGroup="Collision", editinlinenew, hidecategories=(Object,LOD,Lighting,TextureStreaming), meta=(DisplayName="Capsule Collision", BlueprintSpawnableComponent), MinimalAPI)
class UCapsuleComponent : public UShapeComponent
{
    GENERATED_UCLASS_BODY()
 
protected:
    UPROPERTY(EditAnywhere, BlueprintReadOnly, export, Category=Shape, meta=(ClampMin="0", UIMin="0"))
    float CapsuleHalfHeight;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, export, Category=Shape, meta=(ClampMin="0", UIMin="0"))
    float CapsuleRadius;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    float CapsuleHeight_DEPRECATED;
#endif
 
public:
    UFUNCTION(BlueprintCallable, Category="Components|Capsule")
    ENGINE_API void SetCapsuleSize(float InRadius, float InHalfHeight, bool bUpdateOverlaps=true);
 
    UFUNCTION(BlueprintCallable, Category="Components|Capsule")
    void SetCapsuleRadius(float Radius, bool bUpdateOverlaps=true);
    
    UFUNCTION(BlueprintCallable, Category="Components|Capsule")
    void SetCapsuleHalfHeight(float HalfHeight, bool bUpdateOverlaps=true);
 
    //~ Begin UObject Interface
    ENGINE_API virtual void PostLoad() override;
#if WITH_EDITORONLY_DATA
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
#endif
#if WITH_EDITOR
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
    //~ End UObject Interface
 
    //~ Begin USceneComponent Interface
    ENGINE_API virtual FBoxSphereBounds CalcBounds(const FTransform& LocalToWorld) const override;
    ENGINE_API virtual void CalcBoundingCylinder(float& CylinderRadius, float& CylinderHalfHeight) const override;
    //~ End USceneComponent Interface
 
    //~ Begin UPrimitiveComponent Interface.
    ENGINE_API virtual FPrimitiveSceneProxy* CreateSceneProxy() override;
    ENGINE_API virtual bool IsZeroExtent() const override;
    ENGINE_API virtual struct FCollisionShape GetCollisionShape(float Inflation = 0.0f) const override;
    ENGINE_API virtual bool AreSymmetricRotations(const FQuat& A, const FQuat& B, const FVector& Scale3D) const override;
    //~ End UPrimitiveComponent Interface.
 
    //~ Begin UShapeComponent Interface
    ENGINE_API virtual void UpdateBodySetup() override;
    //~ End UShapeComponent Interface
 
    UFUNCTION(BlueprintCallable, Category="Components|Capsule")
    float GetScaledCapsuleRadius() const;
 
    UFUNCTION(BlueprintCallable, Category="Components|Capsule")
    float GetScaledCapsuleHalfHeight() const;
 
    UFUNCTION(BlueprintCallable, Category="Components|Capsule")
    float GetScaledCapsuleHalfHeight_WithoutHemisphere() const;
    
    UFUNCTION(BlueprintCallable, Category="Components|Capsule")
    void GetScaledCapsuleSize(float& OutRadius, float& OutHalfHeight) const;
 
    UFUNCTION(BlueprintCallable, Category="Components|Capsule")
    void GetScaledCapsuleSize_WithoutHemisphere(float& OutRadius, float& OutHalfHeightWithoutHemisphere) const;
 
    UFUNCTION(BlueprintCallable, Category="Components|Capsule")
    float GetUnscaledCapsuleRadius() const;
 
    UFUNCTION(BlueprintCallable, Category="Components|Capsule")
    float GetUnscaledCapsuleHalfHeight() const;
    
    UFUNCTION(BlueprintCallable, Category="Components|Capsule")
    float GetUnscaledCapsuleHalfHeight_WithoutHemisphere() const;
    
    UFUNCTION(BlueprintCallable, Category="Components|Capsule")
    void GetUnscaledCapsuleSize(float& OutRadius, float& OutHalfHeight) const;
 
    UFUNCTION(BlueprintCallable, Category="Components|Capsule")
    void GetUnscaledCapsuleSize_WithoutHemisphere(float& OutRadius, float& OutHalfHeightWithoutHemisphere) const;
 
    UFUNCTION(BlueprintCallable, Category="Components|Capsule")
    float GetShapeScale() const;
 
    // Sets the capsule size without triggering a render or physics update. This is the preferred method when initializing a component in a class constructor.
    inline void InitCapsuleSize(float InRadius, float InHalfHeight)
    {
        CapsuleRadius = FMath::Max(0.f, InRadius);
        CapsuleHalfHeight = FMath::Max3(0.f, InHalfHeight, InRadius);
    }
};
 
 
// ----------------- INLINES ---------------
 
inline void UCapsuleComponent::SetCapsuleRadius(float Radius, bool bUpdateOverlaps)
{
    SetCapsuleSize(Radius, GetUnscaledCapsuleHalfHeight(), bUpdateOverlaps);
}
 
inline void UCapsuleComponent::SetCapsuleHalfHeight(float HalfHeight, bool bUpdateOverlaps)
{
    SetCapsuleSize(GetUnscaledCapsuleRadius(), HalfHeight, bUpdateOverlaps);
}
 
inline float UCapsuleComponent::GetScaledCapsuleRadius() const
{
    const FVector& ComponentScale = GetComponentTransform().GetScale3D();
    return CapsuleRadius * UE_REAL_TO_FLOAT(ComponentScale.X < ComponentScale.Y ? ComponentScale.X : ComponentScale.Y);
}
 
inline float UCapsuleComponent::GetScaledCapsuleHalfHeight() const
{
    return CapsuleHalfHeight * UE_REAL_TO_FLOAT(GetComponentTransform().GetScale3D().Z);
}
 
inline float UCapsuleComponent::GetScaledCapsuleHalfHeight_WithoutHemisphere() const
{
    return GetScaledCapsuleHalfHeight() - GetScaledCapsuleRadius();
}
 
inline void UCapsuleComponent::GetScaledCapsuleSize(float& OutRadius, float& OutHalfHeight) const
{
    OutRadius = GetScaledCapsuleRadius();
    OutHalfHeight = GetScaledCapsuleHalfHeight();
}
 
inline void UCapsuleComponent::GetScaledCapsuleSize_WithoutHemisphere(float& OutRadius, float& OutHalfHeightWithoutHemisphere) const
{
    OutRadius = GetScaledCapsuleRadius();
    OutHalfHeightWithoutHemisphere = GetScaledCapsuleHalfHeight_WithoutHemisphere();
}
 
 
inline float UCapsuleComponent::GetUnscaledCapsuleRadius() const
{
    return CapsuleRadius;
}
 
inline float UCapsuleComponent::GetUnscaledCapsuleHalfHeight() const
{
    return CapsuleHalfHeight;
}
 
inline float UCapsuleComponent::GetUnscaledCapsuleHalfHeight_WithoutHemisphere() const
{
    return CapsuleHalfHeight - CapsuleRadius;
}
 
inline void UCapsuleComponent::GetUnscaledCapsuleSize(float& OutRadius, float& OutHalfHeight) const
{
    OutRadius = CapsuleRadius;
    OutHalfHeight = CapsuleHalfHeight;
}
 
inline void UCapsuleComponent::GetUnscaledCapsuleSize_WithoutHemisphere(float& OutRadius, float& OutHalfHeightWithoutHemisphere) const
{
    OutRadius = CapsuleRadius;
    OutHalfHeightWithoutHemisphere = CapsuleHalfHeight - CapsuleRadius;
}
 
inline float UCapsuleComponent::GetShapeScale() const
{
    return GetComponentTransform().GetMinimumAxisScale();
}