ASpectator Class Reference

#include <Spectator.h>

Inheritance diagram for ASpectator:

Collaboration diagram for ASpectator:

Public Member Functions
void	TeleportSpectator (const FTransform &Transform)
void	TeleportToActorLocation (const AActor *Actor)
void	FollowActor (AActor *Actor, bool DisableInputs=true, const float DistanceToActor=150.0f, const float HeightOffset=10.0f)
void	TeleportToFollowLocation (FVector TargetLocation, const float DistanceToLocation, const float HeightOffset)
void	TeleportToActorFollowLocation (AActor *Actor, const float DistanceToActor=1500.0f, const float HeightOffset=500.0f)
void	StopFollowingAnyActor (bool EnableInputs=true)
void	SetNiagaraComponentVisibility (bool Visible)
void	SetMaxSpeed (float MaxSpeed=1500.0f)
float	GetMaxSpeed ()
AActor *	GetTargetActor ()
bool	IsNiagaraComponentVisible ()
bool	IsSpectatorFollowingAnyActor ()
AOverlapSensor *	GetOverlapSensor () const
UFloatingPawnMovement *	GetFloatingPawnMovement ()
void	TeleportToLevelTeleportLocation (FLevelTeleportLocation TeleportLocation)

Public Attributes
FFollowTargetChanged	OnFollowTargetChanged

Protected Member Functions
virtual void	BeginPlay () override
virtual void	EndPlay (const EEndPlayReason::Type EndPlayReason) override

Protected Attributes
UNiagaraComponent *	NiagaraComponent = nullptr
AOverlapSensor *	OverlapSensor = nullptr

Private Attributes
TWeakObjectPtr< AActor >	Target

Detailed Description

Spectator Actor class for flying (WASD) movement. BP_Spectator blueprint is based on this Actor.

Definition at line 25 of file Spectator.h.

Member Function Documentation

BeginPlay()

void ASpectator::BeginPlay ( )

overrideprotectedvirtual

Definition at line 17 of file Spectator.cpp.

{
    Super::BeginPlay();
 
    // Load and setup rain/snow fall niagara system for this spectator
    UNiagaraSystem* NiagaraSystem = LoadObject<UNiagaraSystem>(nullptr, TEXT("/Game/Agrarsense/Particles/WaterAndSnow/NS_Particles.NS_Particles"));
    if (NiagaraSystem)
    {
        NiagaraComponent = UNiagaraFunctionLibrary::SpawnSystemAttached(NiagaraSystem, this->GetRootComponent(),
            FName("NiagaraEmitterSocketName"),
            FVector(0.0, 0.0, 150.0f), FRotator::ZeroRotator, EAttachLocation::KeepRelativeOffset, true);
 
        ASensor::HideComponentForAllCameras(Cast<UPrimitiveComponent>(NiagaraComponent));
    }
 
    // Disable niagara component
    SetNiagaraComponentVisibility(false);
 
    FVector RelativePosition = FVector(0.0f, 0.0f, 0.0f);
    float OverlapBoundsSize = 15.0f;
 
    // Create OverlapSensor
    FOverlapSensorParameters Params;
    Params.OwningActor = this;
    Params.Size = FVector(OverlapBoundsSize, OverlapBoundsSize, OverlapBoundsSize);
    Params.RelativePosition = RelativePosition;
    Params.AllChannels = true;
    FString OverlapSensorID = "spectator/overlap";
    OverlapSensor = USensorFactory::SpawnOverlapSensor(GetActorTransform(), Params, OverlapSensorID, "overlap", this);
}

References FOverlapSensorParameters::AllChannels, ASensor::HideComponentForAllCameras(), NiagaraComponent, OverlapSensor, FOverlapSensorParameters::OwningActor, FOverlapSensorParameters::RelativePosition, SetNiagaraComponentVisibility(), FOverlapSensorParameters::Size, and USensorFactory::SpawnOverlapSensor().

EndPlay()

void ASpectator::EndPlay ( const EEndPlayReason::Type  EndPlayReason )

overrideprotectedvirtual

Definition at line 48 of file Spectator.cpp.

{
    Super::EndPlay(EndPlayReason);
 
    if (NiagaraComponent)
    {
        NiagaraComponent->UnregisterComponent();
        NiagaraComponent->DestroyComponent();
        NiagaraComponent = nullptr;
    }
 
    if (OverlapSensor) 
    {
        OverlapSensor->Destroy();
        OverlapSensor = nullptr;
    }
 
    Target.Reset();
}

References NiagaraComponent, OverlapSensor, and Target.

FollowActor()

void ASpectator::FollowActor	(	AActor *	Actor,
		bool	DisableInputs = true,
		const float	DistanceToActor = 150.0f,
		const float	HeightOffset = 10.0f
	)

Makes the spectator a child of the given actor and starts following it.

Definition at line 107 of file Spectator.cpp.

{
    Target = Actor;
 
    if (!Target.IsValid())
    {
        return;
    }
 
    // Detach from any previous target
    DetachFromActor(FDetachmentTransformRules::KeepRelativeTransform);
 
    // Set the offset to position the spectator slightly above and behind the actor
    FVector Offset = FVector(0.0f, 0.0f, HeightOffset);
 
    FVector TargetActorLocation = Actor->GetActorLocation();
 
    FVector DirectionToActor = TargetActorLocation - GetActorLocation();
    DirectionToActor.Normalize();
 
    // Face the camera slightly down toward the actor
    APlayerController* PlayerController = Cast<APlayerController>(GetController());
    if (PlayerController)
    {
        if (DisableInputs)
        {
            DisableInput(PlayerController);
        }
        FRotator NewRotation = DirectionToActor.ToOrientationRotator();
        PlayerController->SetControlRotation(NewRotation);
    }
 
    // Calculate the new location to be closer behind the actor
    FVector NewLocation = TargetActorLocation + DirectionToActor * -DistanceToActor + Offset;
 
    // Attach to the new target actor's root component with the offset
    USceneComponent* Root = Actor->GetRootComponent();
    if (Root)
    {
        AttachToComponent(Root, FAttachmentTransformRules::KeepRelativeTransform);
        SetActorLocation(NewLocation);
    }
 
    OnFollowTargetChanged.Broadcast(true, Target.Get());
}

References OnFollowTargetChanged, and Target.

GetFloatingPawnMovement()

UFloatingPawnMovement * ASpectator::GetFloatingPawnMovement

(

)

Get UFloatingPawnMovement from this pawn.

Returns

UFloatingPawnMovement* Pointer, or nullptr if not found.

Definition at line 236 of file Spectator.cpp.

{
    return Cast<UFloatingPawnMovement>(GetMovementComponent());
}

Referenced by GetMaxSpeed(), and SetMaxSpeed().

GetMaxSpeed()

float ASpectator::GetMaxSpeed

(

)

Get FloatingPawnMovement current max speed.

Definition at line 224 of file Spectator.cpp.

{
    UFloatingPawnMovement* FloatingMovement = GetFloatingPawnMovement();
    if (FloatingMovement)
    {
        return FloatingMovement->MaxSpeed;
    }
 
    // Else return default value of 1500.0f (set in BP_spectator blueprint)
    return 1500.0f;
}

References GetFloatingPawnMovement().

Referenced by UAgrarsenseSettings::SetSpectatorMaxSpeed().

GetOverlapSensor()

AOverlapSensor * ASpectator::GetOverlapSensor ( ) const

inline

Definition at line 123 of file Spectator.h.

    {
        return OverlapSensor;
    }

GetTargetActor()

AActor * ASpectator::GetTargetActor ( )

inline

Gets the actor that the spectator is currently following.

Returns

Pointer to the actor being followed, or nullptr if not following any.

Definition at line 93 of file Spectator.h.

    {
        return Target.Get();
    }

IsNiagaraComponentVisible()

bool ASpectator::IsNiagaraComponentVisible ( )

inline

Checks if spectator niagara component is currently visible.

Definition at line 102 of file Spectator.h.

    {
        if (NiagaraComponent)
        {
            return NiagaraComponent->IsVisible();
        }
 
        return false;
    }

Referenced by UAgrarsenseSettings::SetShowSpectatorRainAndSnowfall().

IsSpectatorFollowingAnyActor()

bool ASpectator::IsSpectatorFollowingAnyActor ( )

inline

Checks if the spectator is currently following any actor.

Returns

True if following an actor, false otherwise.

Definition at line 117 of file Spectator.h.

    {
        return GetTargetActor() != nullptr;
    }

SetMaxSpeed()

void ASpectator::SetMaxSpeed

(

float

MaxSpeed = 1500.0f

)

Set FloatingPawnMovement max speed.

Definition at line 215 of file Spectator.cpp.

{
    UFloatingPawnMovement* FloatingMovement = GetFloatingPawnMovement();
    if (FloatingMovement)
    {
        FloatingMovement->MaxSpeed = MaxSpeed;
    }
}

References GetFloatingPawnMovement().

Referenced by UAgrarsenseSettings::SetSpectatorMaxSpeed().

SetNiagaraComponentVisibility()

void ASpectator::SetNiagaraComponentVisibility

(

bool

Visible

)

Set Spectator niagara component visibility (rain/snow fall).

Parameters

Visible

If true, enables spectator Niagara component. Else disables it.

Definition at line 207 of file Spectator.cpp.

{
    if (NiagaraComponent)
    {
        NiagaraComponent->SetVisibility(Visible);
    }
}

References NiagaraComponent.

Referenced by BeginPlay(), and UAgrarsenseSettings::SetShowSpectatorRainAndSnowfall().

StopFollowingAnyActor()

void ASpectator::StopFollowingAnyActor

(

bool

EnableInputs = true

)

Stops the spectator from following any actor.

Parameters

EnableInputs

If true, enables spectator inputs after stopping.

Definition at line 187 of file Spectator.cpp.

{
    // Detach from any previous target
    DetachFromActor(FDetachmentTransformRules::KeepRelativeTransform);
 
    Target.Reset();
 
    if (EnableInputs)
    {
        APlayerController* PlayerController = Cast<APlayerController>(GetController());
 
        if (PlayerController)
        {
            EnableInput(PlayerController);
        }
    }
 
    OnFollowTargetChanged.Broadcast(false, Target.Get());
}

References OnFollowTargetChanged, and Target.

Referenced by TeleportSpectator(), and TeleportToLevelTeleportLocation().

TeleportSpectator()

void ASpectator::TeleportSpectator

(

const FTransform &

Transform

)

Teleports the spectator to the specified transform.

Definition at line 68 of file Spectator.cpp.

{
    if (!IsPlayerControlled())
    {
        return;
    }
 
    // Detach from any Actor and enable inputs.
    StopFollowingAnyActor(true);
 
    FVector TargetLocation = Transform.GetLocation();
    FVector Direction = GetActorLocation() - TargetLocation;
    Direction.Normalize();
 
    // 20 units away from the target so we are not top if it..
    FVector NewLocation = TargetLocation + Direction * 20.0f;
 
    FRotator NewRotation = (TargetLocation - NewLocation).ToOrientationRotator();
 
    SetActorLocationAndRotation(NewLocation, NewRotation);
 
    // Set the player controller rotation to match the incoming Transform angle,
    // This actually sets the camera angle.
    APlayerController* PlayerController = Cast<APlayerController>(GetController());
    if (PlayerController)
    {
        PlayerController->SetControlRotation(Transform.Rotator());
    }
}

References StopFollowingAnyActor(), and Transform.

Referenced by USimulatorJsonParser::HandleSpectatorMovement(), UROSCommands::HandleTeleportSpectator(), and TeleportToActorLocation().

TeleportToActorFollowLocation()

void ASpectator::TeleportToActorFollowLocation	(	AActor *	Actor,
		const float	DistanceToActor = 1500.0f,
		const float	HeightOffset = 500.0f
	)

Teleports the spectator to the follow location of a specific actor

Definition at line 175 of file Spectator.cpp.

{
    if (!IsValid(Actor))
    {
        return;
    }
 
    FVector TargetLocation = Actor->GetActorLocation();
 
    TeleportToFollowLocation(TargetLocation, DistanceToActor, HeightOffset);
}

References TeleportToFollowLocation().

TeleportToActorLocation()

void ASpectator::TeleportToActorLocation

(

const AActor *

Actor

)

Teleports the spectator to the location of a specific actor.

Definition at line 98 of file Spectator.cpp.

{
    if (Actor)
    {
        FTransform Transform = Actor->GetActorTransform();
        TeleportSpectator(Transform);
    }
}

References TeleportSpectator(), and Transform.

TeleportToFollowLocation()

void ASpectator::TeleportToFollowLocation	(	FVector	TargetLocation,
		const float	DistanceToLocation,
		const float	HeightOffset
	)

Teleports the spectator to the follow location of a specific location

Definition at line 153 of file Spectator.cpp.

{
    // Set the offset to position the spectator slightly above and behind the actor
    FVector Offset = FVector(0.0f, 0.0f, HeightOffset);
 
    FVector DirectionToActor = TargetLocation - GetActorLocation();
    DirectionToActor.Normalize();
 
    // Face the camera slightly down toward the actor
    APlayerController* PlayerController = Cast<APlayerController>(GetController());
    if (PlayerController)
    {
        FRotator NewRotation = DirectionToActor.ToOrientationRotator();
        PlayerController->SetControlRotation(NewRotation);
    }
 
    // Calculate the new location to be closer behind the actor
    FVector NewLocation = TargetLocation + DirectionToActor * -DistanceToLocation + Offset;
 
    SetActorLocation(NewLocation);
}

Referenced by TeleportToActorFollowLocation().

TeleportToLevelTeleportLocation()

void ASpectator::TeleportToLevelTeleportLocation

(

FLevelTeleportLocation

TeleportLocation

)

Teleport specator to level teleport location

Parameters

TeleportLocation

Definition at line 242 of file Spectator.cpp.

{
 
    if (!IsPlayerControlled())
    {
        return;
    }
 
    FTransform Transform = TeleportLocation.TeleportLocationTransform;
 
    // Detach from any Actor and enable inputs.
    StopFollowingAnyActor(true);
 
    SetActorLocationAndRotation(Transform.GetLocation(), Transform.GetRotation().Rotator());
 
    // Set the player controller rotation to match the incoming Transform angle,
    // This actually sets the camera angle.
    APlayerController* PlayerController = Cast<APlayerController>(GetController());
    if (PlayerController)
    {
        PlayerController->SetControlRotation(Transform.Rotator());
    }
}

References StopFollowingAnyActor(), FLevelTeleportLocation::TeleportLocationTransform, and Transform.

Member Data Documentation

NiagaraComponent

UNiagaraComponent* ASpectator::NiagaraComponent = nullptr

protected

Definition at line 155 of file Spectator.h.

Referenced by BeginPlay(), EndPlay(), and SetNiagaraComponentVisibility().

OnFollowTargetChanged

FFollowTargetChanged ASpectator::OnFollowTargetChanged

Event triggered when followed actor changed

Definition at line 146 of file Spectator.h.

Referenced by FollowActor(), and StopFollowingAnyActor().

OverlapSensor

AOverlapSensor* ASpectator::OverlapSensor = nullptr

protected

Definition at line 158 of file Spectator.h.

Referenced by BeginPlay(), and EndPlay().

Target

TWeakObjectPtr<AActor> ASpectator::Target

private

Definition at line 162 of file Spectator.h.

Referenced by EndPlay(), FollowActor(), and StopFollowingAnyActor().

---

The documentation for this class was generated from the following files:

• Unreal/Agrarsense/Source/Agrarsense/Spectator/Spectator.h
• Unreal/Agrarsense/Source/Agrarsense/Spectator/Spectator.cpp