A Demo Project for the UnrealEngineSDK
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Private Member Functions | List of all members
UVRPathFollowingComponent Class Reference

UCLASS() More...

#include <VRPathFollowingComponent.h>

Inheritance diagram for UVRPathFollowingComponent:
[legend]

Public Member Functions

void DebugReachTest (float &CurrentDot, float &CurrentDistance, float &CurrentHeight, uint8 &bDotFailed, uint8 &bDistanceFailed, uint8 &bHeightFailed) const
 
int32 DetermineStartingPathPoint (const FNavigationPath *ConsideredPath) const override
 
void FollowPathSegment (float DeltaTime) override
 
virtual void GetDebugStringTokens (TArray< FString > &Tokens, TArray< EPathFollowingDebugTokens::Type > &Flags) const override
 
bool HasReached (const AActor &TestGoal, EPathFollowingReachMode ReachMode, float AcceptanceRadius=UPathFollowingComponent::DefaultAcceptanceRadius, bool bUseNavAgentGoalLocation=true) const
 
bool HasReached (const FVector &TestPoint, EPathFollowingReachMode ReachMode, float AcceptanceRadius=UPathFollowingComponent::DefaultAcceptanceRadius) const
 
bool HasReachedCurrentTarget (const FVector &CurrentLocation) const
 
void PauseMove (FAIRequestID RequestID=FAIRequestID::CurrentRequest, EPathFollowingVelocityMode VelocityMode=EPathFollowingVelocityMode::Reset) override
 
void SetMovementComponent (UNavMovementComponent *MoveComp) override
 
bool ShouldCheckPathOnResume () const override
 
bool UpdateBlockDetection () override
 
void UpdatePathSegment () override
 

Public Attributes

UVRBaseCharacterMovementComponent * VRMovementComp
 UPROPERTY(transient)
 

Private Member Functions

 GENERATED_BODY ()
 

Detailed Description

UCLASS()

Definition at line 18 of file VRPathFollowingComponent.h.

Member Function Documentation

◆ DebugReachTest()

void UVRPathFollowingComponent::DebugReachTest ( float & CurrentDot,
float & CurrentDistance,
float & CurrentHeight,
uint8 & bDotFailed,
uint8 & bDistanceFailed,
uint8 & bHeightFailed ) const

Definition at line 429 of file VRPathFollowingComponent.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ DetermineStartingPathPoint()

int32 UVRPathFollowingComponent::DetermineStartingPathPoint ( const FNavigationPath * ConsideredPath) const
override

Definition at line 174 of file VRPathFollowingComponent.cpp.

Here is the call graph for this function:

◆ FollowPathSegment()

void UVRPathFollowingComponent::FollowPathSegment ( float DeltaTime)
override

Definition at line 356 of file VRPathFollowingComponent.cpp.

Here is the call graph for this function:

◆ GENERATED_BODY()

UVRPathFollowingComponent::GENERATED_BODY ( )
private

◆ GetDebugStringTokens()

void UVRPathFollowingComponent::GetDebugStringTokens ( TArray< FString > & Tokens,
TArray< EPathFollowingDebugTokens::Type > & Flags ) const
overridevirtual

Definition at line 76 of file VRPathFollowingComponent.cpp.

Here is the call graph for this function:

◆ HasReached() [1/2]

bool UVRPathFollowingComponent::HasReached ( const AActor & TestGoal,
EPathFollowingReachMode ReachMode,
float AcceptanceRadius = UPathFollowingComponent::DefaultAcceptanceRadius,
bool bUseNavAgentGoalLocation = true ) const

simple test for stationary agent (used as early finish condition), check if reached given goal

Parameters
TestGoal- actor to test
AcceptanceRadius- allowed 2D distance
ReachMode- modifiers for AcceptanceRadius
bUseNavAgentGoalLocation- true: if the goal is a nav agent, we will use their nav agent location rather than their actual location

Definition at line 42 of file VRPathFollowingComponent.cpp.

Here is the call graph for this function:

◆ HasReached() [2/2]

bool UVRPathFollowingComponent::HasReached ( const FVector & TestPoint,
EPathFollowingReachMode ReachMode,
float AcceptanceRadius = UPathFollowingComponent::DefaultAcceptanceRadius ) const

simple test for stationary agent (used as early finish condition), check if reached given point

Parameters
TestPoint- point to test
AcceptanceRadius- allowed 2D distance
ReachMode- modifiers for AcceptanceRadius

Definition at line 27 of file VRPathFollowingComponent.cpp.

Here is the call graph for this function:

◆ HasReachedCurrentTarget()

bool UVRPathFollowingComponent::HasReachedCurrentTarget ( const FVector & CurrentLocation) const

Definition at line 403 of file VRPathFollowingComponent.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ PauseMove()

void UVRPathFollowingComponent::PauseMove ( FAIRequestID RequestID = FAIRequestID::CurrentRequest,
EPathFollowingVelocityMode VelocityMode = EPathFollowingVelocityMode::Reset )
override

notify about finished movement pause path following

Parameters
RequestID- request to pause, FAIRequestID::CurrentRequest means pause current request, regardless of its ID

Definition at line 129 of file VRPathFollowingComponent.cpp.

Here is the call graph for this function:

◆ SetMovementComponent()

void UVRPathFollowingComponent::SetMovementComponent ( UNavMovementComponent * MoveComp)
override

Definition at line 15 of file VRPathFollowingComponent.cpp.

Here is the call graph for this function:

◆ ShouldCheckPathOnResume()

bool UVRPathFollowingComponent::ShouldCheckPathOnResume ( ) const
override

Definition at line 154 of file VRPathFollowingComponent.cpp.

◆ UpdateBlockDetection()

bool UVRPathFollowingComponent::UpdateBlockDetection ( )
override

Definition at line 225 of file VRPathFollowingComponent.cpp.

Here is the caller graph for this function:

◆ UpdatePathSegment()

void UVRPathFollowingComponent::UpdatePathSegment ( )
override

Definition at line 248 of file VRPathFollowingComponent.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ VRMovementComp

UVRBaseCharacterMovementComponent* UVRPathFollowingComponent::VRMovementComp
transient

UPROPERTY(transient)

Definition at line 27 of file VRPathFollowingComponent.h.

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