core / com.acmerobotics.roadrunner.util / GuidingVectorField / GVFResult

GVFResult

data class GVFResult

Container for the direction of the GVF and intermediate values used in its computation.

Parameters

vector - normalized direction vector of the GVF

pathPoint - point on the path from the projection

displacement - displacement along the path of pathPoint

error - signed cross track error (distance between pathPoint and the query point)

Constructors

<init>

GVFResult(vector: Vector2d, pathPoint: Vector2d, displacement: Double, error: Double)

Container for the direction of the GVF and intermediate values used in its computation.

Properties

displacement

val displacement: Double

displacement along the path of pathPoint

error

val error: Double

signed cross track error (distance between pathPoint and the query point)

pathPoint

val pathPoint: Vector2d

point on the path from the projection

vector

val vector: Vector2d

normalized direction vector of the GVF