ATagger Class Reference

#include <Tagger.h>

Inheritance diagram for ATagger:

Collaboration diagram for ATagger:

Public Member Functions
	ATagger ()

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

Private Member Functions
void	TagExistingActors ()
void	OnActorSpawned (AActor *Actor)
void	TagActor (AActor &Actor, bool TagForSemanticSegmentation)
void	SetStencilValue (UPrimitiveComponent &Component, const ELabels &Label, const bool SetRenderCustomDepth)
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)

Private Attributes
FDelegateHandle	ActorSpawnedDelegateHandle
TMap< FString, ELabels >	LabelMap

Detailed Description

Definition at line 28 of file Tagger.h.

Constructor & Destructor Documentation

ATagger()

ATagger::ATagger

(

)

Definition at line 21 of file Tagger.cpp.

{
    PrimaryActorTick.bCanEverTick = false;
}

Member Function Documentation

BeginPlay()

void ATagger::BeginPlay ( )

overrideprotectedvirtual

Definition at line 26 of file Tagger.cpp.

{
    Super::BeginPlay();
 
    if (UAgrarsenseSettings::IsPlayingInMainMenu()) 
    {
        return;
    }
 
    UWorld* World = GetWorld();
    if (!World)
    {
        return;
    }
 
    // Create TMap<FString, ELabels>
    LabelMap = UEnumUtilities::CreateStringEnumMap<ELabels>("/Script/Agrarsense.ELabels");
 
    ActorSpawnedDelegateHandle = World->AddOnActorSpawnedHandler(FOnActorSpawned::FDelegate::CreateUObject(this, &ATagger::OnActorSpawned));
 
    // Tag all existing Actors in the World after small delay
    FTimerHandle Handle;
    World->GetTimerManager().SetTimer(Handle, FTimerDelegate::CreateLambda([this]
    {
        TagExistingActors();
    }), 0.500f, false);
}

References ActorSpawnedDelegateHandle, UAgrarsenseSettings::IsPlayingInMainMenu(), LabelMap, OnActorSpawned(), and TagExistingActors().

EndPlay()

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

overrideprotectedvirtual

Definition at line 54 of file Tagger.cpp.

{
    Super::EndPlay(EndPlayReason);
 
    ActorSpawnedDelegateHandle.Reset();
}

References ActorSpawnedDelegateHandle.

GetLabelFromPath()

ELabels ATagger::GetLabelFromPath ( const FString &  Path, FString &  FolderName  )

private

Definition at line 210 of file Tagger.cpp.

{
    ELabels Label = ELabels::None;
 
    // If the Path doesn't contain Models, 
    // it means the Asset is not under /Content/Agrarsense/Models
    // and we ignore it.
    if (!Path.Contains("Models"))
    {
        return Label;
    }
 
    TArray<FString> StringArray;
    Path.ParseIntoArray(StringArray, TEXT("/"), false);
 
    FolderName = StringArray[StringArray.Num() - 2];
 
    Label = GetLabelFromString(FolderName);
 
    //UE_LOG(LogTemp, Warning, TEXT("FolderName %s"), *FolderName);
    //UE_LOG(LogTemp, Warning, TEXT("AssetPath %s"), *Path);
 
    return Label;
}

References GetLabelFromString(), and None.

Referenced by GetLabelFromSkeletalMeshComponent(), and GetLabelFromStaticComponent().

GetLabelFromSkeletalMeshComponent()

ELabels ATagger::GetLabelFromSkeletalMeshComponent ( USkeletalMeshComponent *  USkeletalMeshComponentPtr )

private

Definition at line 180 of file Tagger.cpp.

{
    ELabels Label = ELabels::None;
 
    if (!USkeletalMeshComponentPtr)
    {
        return Label;
    }
 
    Label = GetLabelFromTag(USkeletalMeshComponentPtr);
    if (Label != ELabels::None)
    {
        return Label;
    }
 
    USkeletalMesh* PhysicsAsset = USkeletalMeshComponentPtr->GetSkeletalMeshAsset();
    if (PhysicsAsset)
    {
        FString Name;
        Label = GetLabelFromPath(PhysicsAsset->GetPathName(), Name);
 
        if (Label != ELabels::None)
        {
            USkeletalMeshComponentPtr->ComponentTags.Insert(FName(Name), 0);
        }
    }
 
    return Label;
}

References GetLabelFromPath(), GetLabelFromTag(), and None.

Referenced by TagActor().

GetLabelFromStaticComponent()

ELabels ATagger::GetLabelFromStaticComponent ( UStaticMeshComponent *  StaticMeshComponentPtr )

private

Definition at line 150 of file Tagger.cpp.

{
    ELabels Label = ELabels::None;
 
    if (!StaticMeshComponentPtr)
    {
        return Label;
    }
 
    Label = GetLabelFromTag(StaticMeshComponentPtr);
    if (Label != ELabels::None)
    {
        return Label;
    }
 
    UStaticMesh* MeshPtr = StaticMeshComponentPtr->GetStaticMesh();
    if (MeshPtr)
    {
        FString Name;
        Label = GetLabelFromPath(MeshPtr->GetPathName(), Name);
 
        if (Label != ELabels::None)
        {
            StaticMeshComponentPtr->ComponentTags.Insert(FName(Name), 0);
        }
    }
 
    return Label;
}

References GetLabelFromPath(), GetLabelFromTag(), and None.

Referenced by TagActor().

GetLabelFromString()

ELabels ATagger::GetLabelFromString ( const FString &  String )

private

Definition at line 134 of file Tagger.cpp.

{
    const ELabels* FoundLabel = LabelMap.Find(String);
    if (FoundLabel)
    {
        return *FoundLabel;
    }
    else
    {
#if WITH_EDITOR
        UE_LOG(LogTemp, Warning, TEXT("Tagger.cpp: Missing Label: %s"), *String);
#endif
        return ELabels::None;
    }
}

References LabelMap, and None.

Referenced by GetLabelFromPath().

GetLabelFromTag()

template<typename T >

ELabels ATagger::GetLabelFromTag ( const T *  Object )

inlineprivate

Definition at line 61 of file Tagger.h.

    {
        if (!Object->ComponentTags.IsEmpty())
        {
            return GetLabelFromString(Object->ComponentTags[0].ToString());
        }
 
        return ELabels::None;
    }

References None.

Referenced by GetLabelFromSkeletalMeshComponent(), and GetLabelFromStaticComponent().

OnActorSpawned()

void ATagger::OnActorSpawned ( AActor *  Actor )

private

Definition at line 75 of file Tagger.cpp.

{
    if (Actor)
    {
        TagActor(*Actor, true);
    }
}

References TagActor().

Referenced by BeginPlay().

SetStencilValue()

void ATagger::SetStencilValue ( UPrimitiveComponent &  Component, const ELabels &  Label, const bool  SetRenderCustomDepth  )

private

Definition at line 127 of file Tagger.cpp.

{
    // Only set Custom Depth enabled if Label is not None.
    Component.SetRenderCustomDepth(SetRenderCustomDepth && (Label != ELabels::None));
    Component.SetCustomDepthStencilValue(static_cast<int>(Label) + 1);
}

References None.

Referenced by TagActor().

TagActor()

void ATagger::TagActor ( AActor &  Actor, bool  TagForSemanticSegmentation  )

private

Definition at line 83 of file Tagger.cpp.

{
    AInstancedActor* InstancedActor = Cast<AInstancedActor>(&Actor);
    if (InstancedActor)
    {
        if (InstancedActor->IsCustomDepthSetup())
        {
            // Custom depth has been setup beforehand. Return
            return;
        }
    }
 
    AWalker* Walker = Cast<AWalker>(&Actor);
    if (Walker) 
    {
        // If the actor is AWalker, return. These are tagged in editor.
        return;
    }
 
    // Iterate all static meshes
    TArray<UStaticMeshComponent*> StaticMeshComponents;
    Actor.GetComponents<UStaticMeshComponent>(StaticMeshComponents);
    for (UStaticMeshComponent* Component : StaticMeshComponents)
    {
        if (Component)
        {
            auto Label = GetLabelFromStaticComponent(Component);
            SetStencilValue(*Component, Label, TagForSemanticSegmentation);
        }
    }
 
    // Iterate all skeletal meshes
    TArray<USkeletalMeshComponent*> SkeletalMeshComponents;
    Actor.GetComponents<USkeletalMeshComponent>(SkeletalMeshComponents);
    for (USkeletalMeshComponent* Component : SkeletalMeshComponents)
    {
        if (Component)
        {
            ELabels Label = GetLabelFromSkeletalMeshComponent(Component);
            SetStencilValue(*Component, Label, TagForSemanticSegmentation);
        }
    }
}

References GetLabelFromSkeletalMeshComponent(), GetLabelFromStaticComponent(), AInstancedActor::IsCustomDepthSetup(), SetStencilValue(), and Walker.

Referenced by OnActorSpawned(), and TagExistingActors().

TagExistingActors()

void ATagger::TagExistingActors ( )

private

Definition at line 61 of file Tagger.cpp.

{
    TArray<AActor*> Actors;
    UGameplayStatics::GetAllActorsOfClass(GetWorld(), AActor::StaticClass(), Actors);
 
    for (AActor* Actor : Actors)
    {
        if (Actor)
        {
            TagActor(*Actor, true);
        }
    }
}

References TagActor().

Referenced by BeginPlay().

Member Data Documentation

ActorSpawnedDelegateHandle

FDelegateHandle ATagger::ActorSpawnedDelegateHandle

private

Definition at line 71 of file Tagger.h.

Referenced by BeginPlay(), and EndPlay().

LabelMap

TMap<FString, ELabels> ATagger::LabelMap

private

Definition at line 73 of file Tagger.h.

Referenced by BeginPlay(), and GetLabelFromString().

---

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

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