ADeletionVolume Class Reference

#include <DeletionVolume.h>

Inheritance diagram for ADeletionVolume:

Collaboration diagram for ADeletionVolume:

Public Member Functions
	ADeletionVolume ()
void	ChangeOverlapBounds (FVector Bounds)
void	DestroyOverlappingActors (bool OnlyTrees)

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

Protected Attributes
UBoxComponent *	CollisionBox = nullptr
UBoundsVisualizerComponent *	VisualizerComponent = nullptr

Detailed Description

Definition at line 16 of file DeletionVolume.h.

Constructor & Destructor Documentation

ADeletionVolume()

ADeletionVolume::ADeletionVolume

(

)

Definition at line 13 of file DeletionVolume.cpp.

{
    PrimaryActorTick.bCanEverTick = false;
 
    CollisionBox = CreateDefaultSubobject<UBoxComponent>(TEXT("CollisionBox"));
    CollisionBox->InitBoxExtent(FVector(200.0f, 200.0f, 200.0f));
    RootComponent = CollisionBox;
 
    VisualizerComponent = CreateDefaultSubobject<UBoundsVisualizerComponent>(TEXT("BoundsVisualizerComponent"));
    VisualizerComponent->SetCollisionEnabled(ECollisionEnabled::NoCollision);
    VisualizerComponent->SetGenerateOverlapEvents(false);
    VisualizerComponent->SetupAttachment(RootComponent);
    VisualizerComponent->SetVisibility(true);
}

References CollisionBox, and VisualizerComponent.

Member Function Documentation

BeginPlay()

void ADeletionVolume::BeginPlay ( )

overrideprotectedvirtual

Definition at line 28 of file DeletionVolume.cpp.

{
    Super::BeginPlay();
 
    if (VisualizerComponent)
    {
        VisualizerComponent->SetCubeMesh();
        VisualizerComponent->SetVisibility(true);
    }
}

References VisualizerComponent.

ChangeOverlapBounds()

void ADeletionVolume::ChangeOverlapBounds

(

FVector

Bounds

)

Definition at line 56 of file DeletionVolume.cpp.

{
    if (IsValid(this))
    {
        if (CollisionBox) 
        {
            CollisionBox->SetBoxExtent(Bounds);
        }
        
        if (VisualizerComponent) 
        {
            VisualizerComponent->SetRelativeScale3D(Bounds);
        }
    }
}

References CollisionBox, and VisualizerComponent.

Referenced by UROSCommands::HandleDestroyActors(), and USimulatorJsonParser::ParseVolumeDeletion().

DestroyOverlappingActors()

void ADeletionVolume::DestroyOverlappingActors

(

bool

OnlyTrees

)

Destroys all actors overlapping with this actor's UBoxComponent. If OnlyTrees is true, only tree actors are destroyed; otherwise, all overlapping actors (InstancedActors) are destroyed.

Parameters

OnlyTrees

If true, only tree actors will be destroyed. If false, all overlapping actors will be destroyed.

Definition at line 72 of file DeletionVolume.cpp.

{
    if (!IsValid(this) || !CollisionBox)
    {
        return;
    }
 
    TArray<FString> Logs;
 
    TArray<AActor*> OverlappingActors;
    CollisionBox->GetOverlappingActors(OverlappingActors);
 
    for (AActor* Actor : OverlappingActors)
    {
        // Only delete InstancedActor types
        AInstancedActor* InstancedActor = Cast<AInstancedActor>(Actor);
 
        if (InstancedActor && (!OnlyTrees || InstancedActor->IsTreeActor()))
        {
            InstancedActor->Destroy();
 
            FVector ActorLocation = InstancedActor->GetActorLocation();
            FString Msg = FString::Printf(TEXT("Removed actor from position: X=%f, Y=%f, Z=%f"), ActorLocation.X, ActorLocation.Y, ActorLocation.Z);
            Logs.Add(Msg);
        }
    }
 
    for (const FString& Msg : Logs)
    {
        SimulatorLog::Log(Msg);
    }
 
    // Destroy this actor after deleting overlapping actors inside the bounds.
    this->Destroy();
}

References CollisionBox, Destroy, AInstancedActor::IsTreeActor(), and SimulatorLog::Log().

Referenced by UROSCommands::HandleDestroyActors(), and USimulatorJsonParser::ParseVolumeDeletion().

EndPlay()

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

overrideprotectedvirtual

Definition at line 39 of file DeletionVolume.cpp.

{
    Super::EndPlay(EndPlayReason);
 
    if (CollisionBox)
    {
        CollisionBox->DestroyComponent();
        CollisionBox = nullptr;
    }
 
    if (VisualizerComponent) 
    {
        VisualizerComponent->DestroyComponent();
        VisualizerComponent = nullptr;
    }
}

References CollisionBox, and VisualizerComponent.

Member Data Documentation

CollisionBox

UBoxComponent* ADeletionVolume::CollisionBox = nullptr

protected

Definition at line 45 of file DeletionVolume.h.

Referenced by ADeletionVolume(), ChangeOverlapBounds(), DestroyOverlappingActors(), and EndPlay().

VisualizerComponent

UBoundsVisualizerComponent* ADeletionVolume::VisualizerComponent = nullptr

protected

Definition at line 48 of file DeletionVolume.h.

Referenced by ADeletionVolume(), BeginPlay(), ChangeOverlapBounds(), and EndPlay().

---

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

• Unreal/Agrarsense/Source/Agrarsense/Volume/DeletionVolume.h
• Unreal/Agrarsense/Source/Agrarsense/Volume/DeletionVolume.cpp