#include <Walker.h>

Inheritance diagram for AWalker:

[legend]

Collaboration diagram for AWalker:

[legend]

Public Member Functions
	AWalker ()

virtual void	PauseWalker ()

virtual void	ResumeWalker ()

virtual void	SetIgnoreInput (bool IgnoreInput)

void	SetWalkerParameters (const FWalkerParameters &InParameters)

FString	ExportToJsonFile (const FString &FileName)

void	ChangeWalkerParameters (const FWalkerParameters &newParameters)

void	DebugDrawLinesBetweenPoints (float LifeTime=10.0f)

virtual EWalkerType	GetWalkerType () const

FWalkerParameters	GetWalkerParameters () const

FTransform	GetStartTransform () const

FTransform	GetEndTransform () const

bool	IsWalkerPaused () const

virtual FText	GetInteractableName_Implementation () const override

virtual FTransform	GetInteractableWorldTransform_Implementation () const override

virtual FString	GetActorID_Implementation () const override

virtual FString	GetActorName_Implementation () const override

virtual FString	GetActorInformation_Implementation () const override

virtual void	SetActorName_Implementation (const FString &NewActorName) override

virtual void	SetActorIDAndName_Implementation (const FString &NewActorName, const FString &NewID) override

Public Member Functions inherited from IInteractable
FText	GetInteractableName () const

FTransform	GetInteractableWorldTransform () const

Public Member Functions inherited from IActorInformation
FString	GetActorID () const

FString	GetActorName () const

FString	GetActorInformation () const

void	SetActorName (const FString &NewActorName)

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

Public Attributes
FWalkerEventDelegate_ParametersChanged	OnWalkerParametersChanged

FText	InteractableName

ATransformSensor *	TransformSensor = nullptr

Protected Member Functions
virtual void	BeginPlay () override

virtual void	EndPlay (const EEndPlayReason::Type EndPlayReason) override

Protected Attributes
FString	ActorName

FString	ActorID

Private Attributes
bool	WalkerIsPaused = true

FWalkerParameters	WalkerParameters

FWalkerParameters	PreviousParameters

Additional Inherited Members
Static Public Member Functions inherited from IActorInformation
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 ()

Detailed Description

Definition at line 29 of file Walker.h.

Constructor & Destructor Documentation

◆ AWalker()

AWalker::AWalker ( )

Definition at line 20 of file Walker.cpp.

{
    PrimaryActorTick.bCanEverTick = false;
    InteractableName = NSLOCTEXT("Agrarsense", "WalkerInteractableName", "Walker");
}

References InteractableName.

Member Function Documentation

◆ BeginPlay()

void AWalker::BeginPlay ( )

overrideprotectedvirtual

Definition at line 26 of file Walker.cpp.

{
    Super::BeginPlay();
 
    if (WalkerParameters.CreateTransformTopic && !TransformSensor)
    {
        FString TransformSensorID = ActorID + "/transform";
 
        FSensorSpawnParameters SpawnParams;
        SpawnParams.Transform = GetActorTransform();
        SpawnParams.SensorIdentifier = TransformSensorID;
        SpawnParams.SensorName = "transform";
        SpawnParams.SimulateSensor = true;
        SpawnParams.Parent = this;
 
        FTransformSensorParameters Params;
        Params.SaveTransformDataToDisk = false;
        Params.OwningActor = this;
 
        TransformSensor = USensorFactory::SpawnTransformSensor(SpawnParams, Params);
    }
}

References ActorID, FWalkerParameters::CreateTransformTopic, FTransformSensorParameters::OwningActor, FSensorSpawnParameters::Parent, FTransformSensorParameters::SaveTransformDataToDisk, FSensorSpawnParameters::SensorIdentifier, FSensorSpawnParameters::SensorName, FSensorSpawnParameters::SimulateSensor, USensorFactory::SpawnTransformSensor(), FSensorSpawnParameters::Transform, TransformSensor, and WalkerParameters.

◆ ChangeWalkerParameters()

void AWalker::ChangeWalkerParameters ( const FWalkerParameters & newParameters )

inline

Definition at line 57 of file Walker.h.

    {
        SetWalkerParameters(newParameters);
        OnWalkerParametersChanged.Broadcast(WalkerParameters);
    }

Referenced by PauseWalker(), and ResumeWalker().

◆ DebugDrawLinesBetweenPoints()

void AWalker::DebugDrawLinesBetweenPoints ( float LifeTime = 10.0f )

Definition at line 98 of file Walker.cpp.

{
#ifdef WITH_EDITOR
    if (WalkerParameters.WalkerAction != EWalkerAction::FollowPath)
    {
        return;
    }
 
    TArray<FTransform>& Transforms = WalkerParameters.Points;
 
    // Draw lines between the points
    for (int32 i = 0; i < Transforms.Num() - 1; ++i)
    {
        const FVector Start = Transforms[i].GetLocation();
        const FVector End = Transforms[i + 1].GetLocation();
        DrawDebugLine(GetWorld(), Start, End, FColor::Green, false, LifeTime, 0, 5);
    }
#endif
}

References FollowPath, FWalkerParameters::Points, FWalkerParameters::WalkerAction, and WalkerParameters.

◆ EndPlay()

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

overrideprotectedvirtual

Definition at line 49 of file Walker.cpp.

{
    Super::EndPlay(EndPlayReason);
 
    if (TransformSensor) 
    {
        TransformSensor->Destroy();
    }
}

References TransformSensor.

◆ ExportToJsonFile()

FString AWalker::ExportToJsonFile ( const FString & FileName )

Export this Walker and parameters to a JSON file.

Parameters

FileName The name of the file without extension.

Returns: FString representing saved Json file path, or an empty string if the export fails.

Definition at line 93 of file Walker.cpp.

{
    return USimulatorJsonExporter::ExportWalkerToJSON(FileName, this);
}

References USimulatorJsonExporter::ExportWalkerToJSON().

◆ GetActorID_Implementation()

virtual FString AWalker::GetActorID_Implementation ( ) const

inlineoverridevirtual

Definition at line 116 of file Walker.h.

    {
        return ActorID;
    }

◆ GetActorInformation_Implementation()

virtual FString AWalker::GetActorInformation_Implementation ( ) const

inlineoverridevirtual

Definition at line 126 of file Walker.h.

    {
        const FString Walker = UEnumUtilities::ConvertWalkerTypeToString(WalkerParameters.WalkerType);
        const FString ID = IActorInformation::Execute_GetActorID(this);
        const FString Name = IActorInformation::Execute_GetActorName(this);
        const FTransform VehicleTransform = GetActorTransform();
        const FVector Location = VehicleTransform.GetLocation();
        const FRotator Rotation = VehicleTransform.Rotator();
        FString Information = FString::Printf(TEXT("Walker: %s, Name: %s, ID: %s, Location: %s, Rotation: %s"), *Walker, *Name, *ID, *Location.ToString(), *Rotation.ToString());
 
        return Information;
    }

References UEnumUtilities::ConvertWalkerTypeToString(), and Walker.

◆ GetActorName_Implementation()

virtual FString AWalker::GetActorName_Implementation ( ) const

inlineoverridevirtual

Definition at line 121 of file Walker.h.

    {
        return ActorName;
    }

◆ GetEndTransform()

FTransform AWalker::GetEndTransform ( ) const

inline

Definition at line 90 of file Walker.h.

    {
        if (!WalkerParameters.Points.IsEmpty())
        {
            return WalkerParameters.Points.Last();
        }
 
        return FTransform::Identity;
    }

◆ GetInteractableName_Implementation()

virtual FText AWalker::GetInteractableName_Implementation ( ) const

inlineoverridevirtual

Definition at line 106 of file Walker.h.

    {
        return InteractableName;
    }

◆ GetInteractableWorldTransform_Implementation()

virtual FTransform AWalker::GetInteractableWorldTransform_Implementation ( ) const

inlineoverridevirtual

Definition at line 111 of file Walker.h.

    {
        return GetActorTransform();
    }

◆ GetStartTransform()

FTransform AWalker::GetStartTransform ( ) const

inline

Definition at line 79 of file Walker.h.

    {
        if (!WalkerParameters.Points.IsEmpty())
        {
            return WalkerParameters.Points[0];
        }
 
        return FTransform::Identity;
    }

References FWalkerParameters::Points.

◆ GetWalkerParameters()

FWalkerParameters AWalker::GetWalkerParameters ( ) const

inline

Definition at line 73 of file Walker.h.

    {
        return WalkerParameters;
    }

◆ GetWalkerType()

virtual EWalkerType AWalker::GetWalkerType ( ) const

inlinevirtual

Definition at line 67 of file Walker.h.

    {
        return WalkerParameters.WalkerType;
    }

◆ IsWalkerPaused()

bool AWalker::IsWalkerPaused ( ) const

inline

Definition at line 101 of file Walker.h.

    {
        return WalkerIsPaused;
    }

◆ PauseWalker()

void AWalker::PauseWalker ( )

virtual

Definition at line 59 of file Walker.cpp.

{
    PreviousParameters = WalkerParameters;
    WalkerParameters.WalkerAction = EWalkerAction::Stationary;
    SetIgnoreInput(true);
    ChangeWalkerParameters(WalkerParameters);
}

References ChangeWalkerParameters(), PreviousParameters, SetIgnoreInput(), Stationary, FWalkerParameters::WalkerAction, and WalkerParameters.

◆ ResumeWalker()

void AWalker::ResumeWalker ( )

virtual

Definition at line 67 of file Walker.cpp.

{
    if (WalkerIsPaused)
    {
        WalkerParameters = PreviousParameters;
        SetIgnoreInput(false);
        ChangeWalkerParameters(WalkerParameters);
    }
}

References ChangeWalkerParameters(), PreviousParameters, SetIgnoreInput(), WalkerIsPaused, and WalkerParameters.

◆ SetActorIDAndName_Implementation()

virtual void AWalker::SetActorIDAndName_Implementation	(	const FString &	NewActorName,
		const FString &	NewID
	)

inlineoverridevirtual

Definition at line 144 of file Walker.h.

    {
        ActorName = NewActorName;
        ActorID = NewID;
        SetAndValidateActorIDAndName(ActorName, ActorID, TWeakObjectPtr<AActor>(this));
    }

References IActorInformation::SetAndValidateActorIDAndName().

◆ SetActorName_Implementation()

virtual void AWalker::SetActorName_Implementation ( const FString & NewActorName )

inlineoverridevirtual

Definition at line 139 of file Walker.h.

    {
        ActorName = NewActorName;
    }

◆ SetIgnoreInput()

void AWalker::SetIgnoreInput ( bool IgnoreInput )

virtual

Definition at line 77 of file Walker.cpp.

{
    WalkerIsPaused = IgnoreInput;
 
    AAIController* AIControllerPtr = Cast<AAIController>(GetController());
    if (AIControllerPtr)
    {
        AIControllerPtr->SetIgnoreMoveInput(WalkerIsPaused);
    }
}

References WalkerIsPaused.

Referenced by PauseWalker(), and ResumeWalker().

◆ SetWalkerParameters()

void AWalker::SetWalkerParameters ( const FWalkerParameters & InParameters )

Definition at line 88 of file Walker.cpp.

{
    WalkerParameters = InParameters;
}

References WalkerParameters.

Member Data Documentation

◆ ActorID

FString AWalker::ActorID

protected

Definition at line 170 of file Walker.h.

Referenced by BeginPlay().

◆ ActorName

FString AWalker::ActorName

protected

Definition at line 167 of file Walker.h.

◆ InteractableName

FText AWalker::InteractableName

Definition at line 155 of file Walker.h.

Referenced by AWalker().

◆ OnWalkerParametersChanged

FWalkerEventDelegate_ParametersChanged AWalker::OnWalkerParametersChanged

Definition at line 152 of file Walker.h.

◆ PreviousParameters

FWalkerParameters AWalker::PreviousParameters

private

Definition at line 180 of file Walker.h.

Referenced by PauseWalker(), and ResumeWalker().

◆ TransformSensor

ATransformSensor* AWalker::TransformSensor = nullptr

Definition at line 158 of file Walker.h.

Referenced by BeginPlay(), and EndPlay().

◆ WalkerIsPaused

bool AWalker::WalkerIsPaused = true

private

Definition at line 175 of file Walker.h.

Referenced by ResumeWalker(), and SetIgnoreInput().

◆ WalkerParameters

FWalkerParameters AWalker::WalkerParameters

private

Definition at line 178 of file Walker.h.

Referenced by BeginPlay(), DebugDrawLinesBetweenPoints(), PauseWalker(), ResumeWalker(), and SetWalkerParameters().

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

Unreal/Agrarsense/Source/Agrarsense/Walker/Walker.h
Unreal/Agrarsense/Source/Agrarsense/Walker/Walker.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AWalker()

Member Function Documentation

◆ BeginPlay()

◆ ChangeWalkerParameters()

◆ DebugDrawLinesBetweenPoints()

◆ EndPlay()

◆ ExportToJsonFile()

◆ GetActorID_Implementation()

◆ GetActorInformation_Implementation()

◆ GetActorName_Implementation()

◆ GetEndTransform()

◆ GetInteractableName_Implementation()

◆ GetInteractableWorldTransform_Implementation()

◆ GetStartTransform()

◆ GetWalkerParameters()

◆ GetWalkerType()

◆ IsWalkerPaused()

◆ PauseWalker()

◆ ResumeWalker()

◆ SetActorIDAndName_Implementation()

◆ SetActorName_Implementation()

◆ SetIgnoreInput()

◆ SetWalkerParameters()

Member Data Documentation

◆ ActorID

◆ ActorName

◆ InteractableName

◆ OnWalkerParametersChanged

◆ PreviousParameters

◆ TransformSensor

◆ WalkerIsPaused

◆ WalkerParameters