Package edu.wpi.first.apriltag
Enum Class AprilTagFields
- All Implemented Interfaces:
Serializable
,Comparable<AprilTagFields>
,Constable
Loadable AprilTag field layouts.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescription2022 Rapid React.2023 Charged Up.2024 Crescendo. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Base resource directory.static final AprilTagFields
Alias to the current game.final String
Resource filename. -
Method Summary
Modifier and TypeMethodDescriptionDeprecated, for removal: This API element is subject to removal in a future version.static AprilTagFields
Returns the enum constant of this class with the specified name.static AprilTagFields[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
k2022RapidReact
2022 Rapid React. -
k2023ChargedUp
2023 Charged Up. -
k2024Crescendo
2024 Crescendo.
-
-
Field Details
-
kBaseResourceDir
Base resource directory.- See Also:
-
kDefaultField
Alias to the current game. -
m_resourceFile
Resource filename.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
loadAprilTagLayoutField
Deprecated, for removal: This API element is subject to removal in a future version.UseAprilTagFieldLayout.loadField(AprilTagFields)
instead.Get aAprilTagFieldLayout
from the resource JSON.- Returns:
- AprilTagFieldLayout of the field
- Throws:
UncheckedIOException
- If the layout does not exist
-
AprilTagFieldLayout.loadField(AprilTagFields)
instead.