Package com.pathplanner.lib.util

Enum Class FlippingUtil.FieldSymmetry

java.lang.Object

java.lang.Enum<FlippingUtil.FieldSymmetry>

com.pathplanner.lib.util.FlippingUtil.FieldSymmetry

All Implemented Interfaces:

Serializable, Comparable<FlippingUtil.FieldSymmetry>, java.lang.constant.Constable

Enclosing class:

FlippingUtil

public static enum FlippingUtil.FieldSymmetry
extends Enum<FlippingUtil.FieldSymmetry>

Enum representing the different types of field symmetry

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
kMirrored	Field is mirrored vertically over the center of the field
kRotational	Field is rotationally symmetric.

Method Summary

Modifier and Type	Method	Description
static FlippingUtil.FieldSymmetry	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FlippingUtil.FieldSymmetry[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

kRotational

public static final FlippingUtil.FieldSymmetry kRotational

Field is rotationally symmetric. i.e. the red alliance side is the blue alliance side rotated by 180 degrees

kMirrored

public static final FlippingUtil.FieldSymmetry kMirrored

Field is mirrored vertically over the center of the field

Method Details

values

public static FlippingUtil.FieldSymmetry[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FlippingUtil.FieldSymmetry valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null