SpringArmComponent.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 "Engine/EngineTypes.h"
#include "Components/SceneComponent.h"
#include "SpringArmComponent.generated.h"
 
UCLASS(ClassGroup=Camera, meta=(BlueprintSpawnableComponent), hideCategories=(Mobility), MinimalAPI)
class USpringArmComponent : public USceneComponent
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Camera)
    float TargetArmLength;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Camera)
    FVector SocketOffset;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Camera)
    FVector TargetOffset;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=CameraCollision, meta=(editcondition="bDoCollisionTest"))
    float ProbeSize;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=CameraCollision, meta=(editcondition="bDoCollisionTest"))
    TEnumAsByte<ECollisionChannel> ProbeChannel;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=CameraCollision)
    uint32 bDoCollisionTest:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=CameraSettings)
    uint32 bUsePawnControlRotation:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=CameraSettings)
    uint32 bInheritPitch : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=CameraSettings)
    uint32 bInheritYaw : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=CameraSettings)
    uint32 bInheritRoll : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Lag)
    uint32 bEnableCameraLag : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Lag)
    uint32 bEnableCameraRotationLag : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Lag, AdvancedDisplay)
    uint32 bUseCameraLagSubstepping : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Lag)
    uint32 bDrawDebugLagMarkers : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Lag, meta=(editcondition="bEnableCameraLag", ClampMin="0.0", ClampMax="1000.0", UIMin = "0.0", UIMax = "1000.0"))
    float CameraLagSpeed;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Lag, meta=(editcondition = "bEnableCameraRotationLag", ClampMin="0.0", ClampMax="1000.0", UIMin = "0.0", UIMax = "1000.0"))
    float CameraRotationLagSpeed;
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Lag, AdvancedDisplay, meta=(editcondition = "bUseCameraLagSubstepping", ClampMin="0.005", ClampMax="0.5", UIMin = "0.005", UIMax = "0.5"))
    float CameraLagMaxTimeStep;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Lag, meta=(editcondition="bEnableCameraLag", ClampMin="0.0", UIMin = "0.0"))
    float CameraLagMaxDistance;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Lag)
    uint32 bClampToMaxPhysicsDeltaTime : 1;
 
    UFUNCTION(BlueprintCallable, Category=SpringArm)
    ENGINE_API FRotator GetTargetRotation() const;
 
    UFUNCTION(BlueprintCallable, Category=CameraCollision)
    ENGINE_API FVector GetUnfixedCameraPosition() const;
 
    UFUNCTION(BlueprintCallable, Category = CameraCollision)
    ENGINE_API bool IsCollisionFixApplied() const;
 
    bool bIsCameraFixed = false;
    FVector UnfixedCameraPosition;
 
    FVector PreviousDesiredLoc;
    FVector PreviousArmOrigin;
    FRotator PreviousDesiredRot;
 
    // UActorComponent interface
    ENGINE_API virtual void OnRegister() override;
    ENGINE_API virtual void TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
    ENGINE_API virtual void PostLoad() override;
    ENGINE_API virtual void ApplyWorldOffset(const FVector& InOffset, bool bWorldShift) override;
    // End of UActorComponent interface
 
    // USceneComponent interface
    ENGINE_API virtual bool HasAnySockets() const override;
    ENGINE_API virtual FTransform GetSocketTransform(FName InSocketName, ERelativeTransformSpace TransformSpace = RTS_World) const override;
    ENGINE_API virtual void QuerySupportedSockets(TArray<FComponentSocketDescription>& OutSockets) const override;
    // End of USceneComponent interface
 
    static ENGINE_API const FName SocketName;
 
    ENGINE_API virtual FRotator GetDesiredRotation() const;
 
protected:
    FVector RelativeSocketLocation;
    FQuat RelativeSocketRotation;
 
protected:
    ENGINE_API virtual void UpdateDesiredArmLocation(bool bDoTrace, bool bDoLocationLag, bool bDoRotationLag, float DeltaTime);
 
    ENGINE_API virtual FVector BlendLocations(const FVector& DesiredArmLocation, const FVector& TraceHitLocation, bool bHitSomething, float DeltaTime);
};