com.acmerobotics.roadrunner.path

Class Path.ProjectionResult

com.acmerobotics.roadrunner.path.Path.ProjectionResult

Enclosing class:

Path

public static class Path.ProjectionResult

Simple container for the result of a projection (i.e., a project call).

See Also:

project

Constructor Summary

Constructors

Constructor and Description
ProjectionResult(double displacement, double distance) Simple container for the result of a projection (i.e., a project call).

Method Summary

Modifier and Type	Method and Description
double	component1() displacement along the path
double	component2() Euclidean distance between the path and query points
Path.ProjectionResult	copy(double displacement, double distance) Simple container for the result of a projection (i.e., a project call).
boolean	equals(java.lang.Object p)
double	getDisplacement() displacement along the path
double	getDistance() Euclidean distance between the path and query points
int	hashCode()
java.lang.String	toString()

Constructor Detail

ProjectionResult

public ProjectionResult(double displacement,
                        double distance)

Simple container for the result of a projection (i.e., a project call).

Parameters:

displacement - displacement along the path

distance - Euclidean distance between the path and query points

See Also:

project

Method Detail

getDisplacement

public double getDisplacement()

displacement along the path

getDistance

public double getDistance()

Euclidean distance between the path and query points

component1

public double component1()

displacement along the path

component2

public double component2()

Euclidean distance between the path and query points

copy

@NotNull
public Path.ProjectionResult copy(double displacement,
                                           double distance)

Simple container for the result of a projection (i.e., a project call).

Parameters:

displacement - displacement along the path

distance - Euclidean distance between the path and query points

See Also:

project

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(@Nullable
                      java.lang.Object p)