AWalker Class Reference

#include <Walker.h>

Inheritance diagram for AWalker:

Collaboration diagram for AWalker:

Public Member Functions
	AWalker ()
virtual void	PauseWalker ()
virtual void	ResumeWalker ()
virtual void	SetIgnoreInput (bool IgnoreInput)
FString	ExportToJsonFile (const FString &FileName)
void	DebugDrawLinesBetweenPoints (float LifeTime=10.0f)
void	ChangeWalkerParameters (const FWalkerParameters &newParameters)
void	SetWalkerParameters (const FWalkerParameters &InParameters)
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

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 27 of file Walker.h.

Constructor & Destructor Documentation

AWalker()

AWalker::AWalker

(

)

Definition at line 18 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 24 of file Walker.cpp.

{
    Super::BeginPlay();
}

ChangeWalkerParameters()

void AWalker::ChangeWalkerParameters ( const FWalkerParameters &  newParameters )

inline

Definition at line 56 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 68 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 29 of file Walker.cpp.

{
    Super::EndPlay(EndPlayReason);
}

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 63 of file Walker.cpp.

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

References USimulatorJsonExporter::ExportWalkerToJSON().

GetActorID_Implementation()

virtual FString AWalker::GetActorID_Implementation ( ) const

inlineoverridevirtual

Definition at line 117 of file Walker.h.

    {
        return ActorID;
    }

GetActorInformation_Implementation()

virtual FString AWalker::GetActorInformation_Implementation ( ) const

inlineoverridevirtual

Definition at line 127 of file Walker.h.

    {
        const FString Walker = UEnumUtilities::ConvertWalkerTypeToString(WalkerParameters.WalkerType);
        const FString ID = GetActorID_Implementation();
        const FString Name = GetActorName_Implementation();
        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 122 of file Walker.h.

    {
        return ActorName;
    }

GetEndTransform()

FTransform AWalker::GetEndTransform ( ) const

inline

Definition at line 91 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 107 of file Walker.h.

    {
        return InteractableName;
    }

GetInteractableWorldTransform_Implementation()

virtual FTransform AWalker::GetInteractableWorldTransform_Implementation ( ) const

inlineoverridevirtual

Definition at line 112 of file Walker.h.

    {
        return GetActorTransform();
    }

GetStartTransform()

FTransform AWalker::GetStartTransform ( ) const

inline

Definition at line 80 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 74 of file Walker.h.

    {
        return WalkerParameters;
    }

GetWalkerType()

virtual EWalkerType AWalker::GetWalkerType ( ) const

inlinevirtual

Definition at line 68 of file Walker.h.

    {
        return WalkerParameters.WalkerType;
    }

References FWalkerParameters::WalkerType.

IsWalkerPaused()

bool AWalker::IsWalkerPaused ( ) const

inline

Definition at line 102 of file Walker.h.

    {
        return WalkerIsPaused;
    }

PauseWalker()

void AWalker::PauseWalker ( )

virtual

Definition at line 34 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 42 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 145 of file Walker.h.

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

SetActorName_Implementation()

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

inlineoverridevirtual

Definition at line 140 of file Walker.h.

    {
        ActorName = NewActorName;
    }

SetIgnoreInput()

void AWalker::SetIgnoreInput ( bool  IgnoreInput )

virtual

Definition at line 52 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 )

inline

Definition at line 62 of file Walker.h.

    {
        WalkerParameters = InParameters;
    }

Member Data Documentation

ActorID

FString AWalker::ActorID

protected

Definition at line 169 of file Walker.h.

ActorName

FString AWalker::ActorName

protected

Definition at line 166 of file Walker.h.

InteractableName

FText AWalker::InteractableName

Definition at line 157 of file Walker.h.

Referenced by AWalker().

OnWalkerParametersChanged

FWalkerEventDelegate_ParametersChanged AWalker::OnWalkerParametersChanged

Definition at line 154 of file Walker.h.

PreviousParameters

FWalkerParameters AWalker::PreviousParameters

private

Definition at line 179 of file Walker.h.

Referenced by PauseWalker(), and ResumeWalker().

WalkerIsPaused

bool AWalker::WalkerIsPaused = true

private

Definition at line 174 of file Walker.h.

Referenced by ResumeWalker(), and SetIgnoreInput().

WalkerParameters

FWalkerParameters AWalker::WalkerParameters

private

Definition at line 177 of file Walker.h.

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

---

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