IActorInformation Class Reference

#include <ActorInformation.h>

Inheritance diagram for IActorInformation:

Public Member Functions
FString	GetActorID () const
FString	GetActorName () const
FString	GetActorInformation () const
void	SetActorName (const FString &NewActorName)
void	SetActorIDAndName (const FString &NewActorName, const FString &NewID)

Static Public Member Functions
static void	SetAndValidateActorIDAndName (FString &ActorName, FString &ActorID, TWeakObjectPtr< AActor > Actor)
static bool	DestroyActorByID (const FString &ID)
static AActor *	GetActorByID (const FString &ID)
template<typename T >
static TArray< T * >	GetActorsWithInterface ()
static void	PrintAllIds ()

Static Private Member Functions
static FString	ValidateID (const FString &ActorID, TWeakObjectPtr< AActor > Actor)
static FString	GenerateUniqueID ()

Detailed Description

Interface for actors with an ID.

Definition at line 22 of file ActorInformation.h.

Member Function Documentation

DestroyActorByID()

bool IActorInformation::DestroyActorByID ( const FString &  ID )

static

Try to Destroy Actor by its ID.

Parameters

ID

Actor ID

Returns

boolean whether destroying was successfull

Definition at line 96 of file ActorInformation.cpp.

{
    if (!GEngine || !GEngine->GameViewport)
    {
        return false;
    }
 
    TArray<AActor*> ActorsWithInterface;
    UWorld* World = GEngine->GameViewport->GetWorld();
    UGameplayStatics::GetAllActorsWithInterface(World, UActorInformation::StaticClass(), ActorsWithInterface);
 
    // All ID's are in lowercase.
    FString IDLowered = ID.ToLower();
 
    for (AActor* Actor : ActorsWithInterface)
    {
        FString ActorID = IActorInformation::Execute_GetActorID(Actor);
        if (ActorID == IDLowered)
        {
            return Actor->Destroy();
        }
    }
 
    return false;
}

Referenced by UROSCommands::HandleTryDestroyObjectByID().

GenerateUniqueID()

FString IActorInformation::GenerateUniqueID ( )

staticprivate

Generate unique ID.

Definition at line 62 of file ActorInformation.cpp.

{
    return FGuid::NewGuid().ToString(EGuidFormats::DigitsWithHyphensLower);
}

Referenced by SetAndValidateActorIDAndName().

GetActorByID()

AActor * IActorInformation::GetActorByID ( const FString &  ID )

static

Try to find Actor by ID

Parameters

ID

Actor ID

Returns

Actor pointer or nullptr

Definition at line 122 of file ActorInformation.cpp.

{
    if (!GEngine || !GEngine->GameViewport)
    {
        return nullptr;
    }
 
    TArray<AActor*> ActorsWithInterface;
    UWorld* World = GEngine->GameViewport->GetWorld();
    UGameplayStatics::GetAllActorsWithInterface(World, UActorInformation::StaticClass(), ActorsWithInterface);
 
    // All ID's are in lowercase.
    FString IDLowered = ID.ToLower();
 
    for (AActor* Actor : ActorsWithInterface)
    {
        if (Actor)
        {
            FString ActorID = IActorInformation::Execute_GetActorID(Actor);
            if (ActorID == IDLowered)
            {
                return Actor;
            }
        }
    }
 
    return nullptr;
}

Referenced by UROSCommands::HandleChangeOverlapSensorBounds(), UROSCommands::HandleChangeOverlapSensorPosition(), UROSCommands::HandleMoveDroneTo(), UROSCommands::HandleMoveWalkerTo(), UROSCommands::HandleSetSensorEnabled(), UROSCommands::HandleSetWalkerMovement(), and UROSCommands::HandleTeleportActorByID().

GetActorID()

FString IActorInformation::GetActorID

(

)

const

Get Actor ID. This ID can be used to destroy or otherwise control actor through ROS.

GetActorInformation()

FString IActorInformation::GetActorInformation

(

)

const

Get Actor information.

GetActorName()

FString IActorInformation::GetActorName

(

)

const

Get Actor name. This is for UI related things.

GetActorsWithInterface()

template<typename T >

TArray< T * > IActorInformation::GetActorsWithInterface

static

Retrieves an array of actors with IActorID interface.

Template Parameters

T	The interface class type.

Returns

An array of actors with IActorID interface.

Definition at line 152 of file ActorInformation.cpp.

{
    if (!GEngine || !GEngine->GameViewport)
    {
        return TArray<T*>();
    }
 
    TArray<AActor*> ActorsWithInterface;
    UWorld* World = GEngine->GameViewport->GetWorld();
    UGameplayStatics::GetAllActorsWithInterface(World, UActorInformation::StaticClass(), ActorsWithInterface);
 
    // Convert the TArray<AActor*> to TArray<T*>
    TArray<T*> ConvertedActors;
    for (AActor* Actor : ActorsWithInterface)
    {
        T* TypedActor = Cast<T>(Actor);
        if (TypedActor)
        {
            ConvertedActors.Add(TypedActor);
        }
    }
 
    return ConvertedActors;
}

PrintAllIds()

void IActorInformation::PrintAllIds ( )

static

Print all ID's.

Definition at line 177 of file ActorInformation.cpp.

{
    FString Message = "IDs: ";
    int32 NumIds = ExistingIDs.Num();
 
    // Iterate through the ExistingIDs map
    int32 IdCounter = 0;
    for (auto It = ExistingIDs.CreateIterator(); It; ++It)
    {
        if (It.Value().Actor.IsValid())
        {
            // Append the ID to the Message string
            Message += FString::Printf(TEXT("%s"), *It.Key());
            if (++IdCounter < NumIds)
            {
                // Add a comma if it's not the last value
                Message += TEXT(", ");
            }
        }
        else
        {
            // Remove entries with nullptr actors
            It.RemoveCurrent();
        }
    }
 
    SimulatorLog::Log(Message);
}

References ExistingIDs, and SimulatorLog::Log().

Referenced by UROSCommands::HandlePrintIds().

SetActorIDAndName()

void IActorInformation::SetActorIDAndName	(	const FString &	NewActorName,
		const FString &	NewID
	)

Set Actor ID and name.

SetActorName()

void IActorInformation::SetActorName

(

const FString &

NewActorName

)

Set Actor name. This is for UI related things.

SetAndValidateActorIDAndName()

void IActorInformation::SetAndValidateActorIDAndName ( FString &  ActorName, FString &  ActorID, TWeakObjectPtr< AActor >  Actor  )

static

Sets and validates the Actor's name and ID. This function ensures the Actor's name is non-empty and generates a unique ID if needed.

Parameters

ActorName	[in, out] Reference to the Actor's name. Set to the label if empty.
ActorID	[in, out] Reference to the Actor's ID. Validated and set to a unique ID if empty.
Actor	[in] Pointer to the Actor. Must not be nullptr.

Definition at line 67 of file ActorInformation.cpp.

{
    if (!Actor.IsValid())
    {
#if WITH_EDITOR
        UE_LOG(LogTemp, Warning, TEXT("IActorID.cpp: Invalid Actor!"));
#endif
        return;
    }
 
    if (ActorName.IsEmpty())
    {
        // If the given Actor name is empty, use Actor actual name or label as name
        // this name is used for Unreal UI side only.
        ActorName = Actor->GetActorNameOrLabel();
    }
 
    if (!ActorID.IsEmpty())
    {
        // Validate the ID, If same ID exists, ValidateID adds available number at the end: Actor1..Actor2..ActorN
        ActorID = ValidateID(ActorID, Actor);
    }
    else
    {
        // If given Actor ID is empty, generate unique ID (long string)
        ActorID = GenerateUniqueID();
    }
}

References GenerateUniqueID(), and ValidateID().

Referenced by AVehicle::SetActorIDAndName_Implementation().

ValidateID()

FString IActorInformation::ValidateID ( const FString &  ActorID, TWeakObjectPtr< AActor >  Actor  )

staticprivate

Validate that the ID is unique.

Definition at line 28 of file ActorInformation.cpp.

{
    FString ActorIDLower = ActorID.ToLower();
    FString FinalID = ActorIDLower;
 
    // Check if the ID already exists
    if (ExistingIDs.Contains(FinalID))
    {
        IdentifierData& Data = ExistingIDs[FinalID];
 
        if (!Data.Actor.IsValid())
        {
            // Reuse the ID if the existing Actor no longer exists.
            Data.Actor = Actor;
            return FinalID;
        }
 
        // Append the count as a numerical suffix
        FinalID = ActorIDLower + FString::Printf(TEXT("%d"), Data.Count);
 
        while (ExistingIDs.Contains(FinalID))
        {
            // If the new ID exists, keep incrementing the count
            Data.Count++;
            FinalID = ActorIDLower + FString::Printf(TEXT("%d"), Data.Count);
        }
    }
 
    // Add the final ID to the map
    ExistingIDs.Add(FinalID, IdentifierData{ FinalID, Actor });
 
    return FinalID;
}

References IdentifierData::Actor, IdentifierData::Count, and ExistingIDs.

Referenced by SetAndValidateActorIDAndName().

---

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

• Unreal/Agrarsense/Source/Agrarsense/ActorInterfaces/ActorInformation.h
• Unreal/Agrarsense/Source/Agrarsense/ActorInterfaces/ActorInformation.cpp