Tagger.h

Go to the documentation of this file.

// Copyright (c) 2023 FrostBit Software Lab at the Lapland University of Applied Sciences
//
// This work is licensed under the terms of the MIT license.
// For a copy, see <https://opensource.org/licenses/MIT>.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GameFramework/Actor.h"
#include "Kismet/GameplayStatics.h"
#include "ObjectLabel.h"
#include "PhysicsEngine/PhysicsAsset.h"
 
#include "Tagger.generated.h"
 
class USkeletalMeshComponent;
class AGeoReferencingSystem;
class UStaticMeshComponent;
class ALandscape;
class UCSVFile;
 
USTRUCT(Blueprintable)
struct AGRARSENSE_API FTaggedActorData
{
    GENERATED_BODY()
 
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
    AActor* Actor;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
    UStaticMeshComponent* StaticMeshComponent;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
    USkeletalMeshComponent* SkeletalMeshComponent;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
    float InstanceID;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
    ELabels Label;
};
 
/*
* This Actor is responsible for tagging all Actors in the level.
* During BeginPlay, this iterates through all Actors in the level, setting stencil value for object if it's not set.
* This stencil value is used by SemanicSegmentationCamera in its post processing material.
* Additionally, each time a new Actor is spawned, this Actor will automatically check it as well.
*/
UCLASS()
class AGRARSENSE_API ATagger : public AActor
{
    GENERATED_BODY()
 
public:
 
    ATagger();
 
    UFUNCTION(BlueprintCallable)
    void ExportObjectLocationsToCSV();
 
    UFUNCTION(BlueprintCallable)
    AActor* GetActorByInstanceID(float InstanceID);
 
protected:
 
    virtual void BeginPlay() override;
 
    virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override;
 
protected:
 
    void CreateCSVFile();
 
    void TagExistingActors();
 
    void OnActorSpawned(AActor* Actor);
 
    void TagActor(AActor& Actor);
 
    void WriteComponentToCSV(const FTaggedActorData Data);
 
    float SetStencilValue(UPrimitiveComponent& Component, AActor& Actor, const ELabels& Label);
 
    void TagLandscape(ALandscape* Landscape, AActor& Actor);
 
    ELabels GetLabelFromString(const FString& String);
 
    ELabels GetLabelFromStaticComponent(UStaticMeshComponent* StaticMeshComponentPtr);
 
    ELabels GetLabelFromSkeletalMeshComponent(USkeletalMeshComponent* USkeletalMeshComponentPtr);
 
    ELabels GetLabelFromPath(const FString& Path, FString& FolderName);
 
    template <typename T>
    ELabels GetLabelFromTag(const T* Object)
    {
        if (!Object->ComponentTags.IsEmpty())
        {
            return GetLabelFromString(Object->ComponentTags[0].ToString());
        }
 
        return ELabels::None;
    }
 
private:
 
    AGeoReferencingSystem* GeoReferencingSystem = nullptr;
 
    UCSVFile* CSVFile = nullptr;
 
    TArray<FTaggedActorData> TaggedActors;
 
    FDelegateHandle ActorSpawnedDelegateHandle;
 
    TMap<FString, ELabels> LabelMap;
 
    bool TerrainIDCached = false;
 
    uint32 CachedTerrainID = 0;
 
    // ID Counter for instance segmentation.
    // 0.0f reserved for Landscape
    float ID = 1.0f;
 
};