All Classes

Class	Description
AbsMax	Additional math utilities for getting the absolute maximum of a set of data.
AbsMin	Additional math utilities for getting the absolute minimum of a set of data.
Angle	A representation of an angle.
AngleTracker	Track an angle based on an encoder.
AngleUtils	Utility class for dealing with angles in both radians and degrees.
AnnotationProcessor
Arc	An Arc is an abstraction of the Spline class designed to simplify the process of creating arcs that behave in a reliable way.
Async	Marker interface used for annotating methods that operate asynchronously.
Average	Math utility to get the average of a set of numbers.
BcThread	Utility class designed to deal with bad API versions - 1.8 vs 9, for example.
ChassisConverter	Convert between drivetrains and trackers.
Circle	Circles, much like rectangles, and literally any other shape, are...
Distance	Utility class for measuring distance.
Drive	An interface used to make sure different types of drive systems are fully integrated and working.
DriveWrapper	Wrapper surrounding user-inputted drivetrains that's designed to allow users to invert the X or Y transform values that are fed to their drivetrains.
DynamicPathProvider	Dynamically provide paths.
EmptyField	Example empty field.
EmptyFRC	An empty map with the dimensions of an FRC field.
EmptyFTC	An empty map with the dimensions of an FTC field.
Encoder	Simple interface used for communicating with encoders.
Extra	Random utilities that don't have a specific classification.
FieldShapeFRC	Shapes used for FRC fields.
FieldShapeFTC	Shapes used for FTC fields.
FieldZoneFRC	A generic zone representing an FRC field.
FieldZoneFTC	A generic zone representing an FTC field.
Follower	Interface used for different types of followers.
FollowerExecutor	Execute a given follower among several different threads.
FollowerFactory
Followers	A collection of different types of path followers.
GearRatio	A virtual representation of an input/output gear ratio.
Generator	Interface used for connecting different types of path generation.
GeneratorManager	Manager class used for controlling and manipulating different generators.
GigaArc	The core component behind a circle.
Gyroscope	Interface used for interacting with gyroscopes.
GyroSwerveTracker	A combination of a gyroscopic tracker and a swerve chassis tracker!
HeadingPoint	An extension of the default Point class - this time with z.
InvalidPathException	A type of exception used to signify when a path that was provided by a user is in some way invalid.
JsonIO	Input/output class for use in loading and saving JSON information to the host device's local file system.
LightningFinder	The fastest pathfinder available.
Line	A combination of two points, forming a line.
Linear	An extension of the very lovely Spline class that seeks to make splines even more simple by reducing the amount of input points to 2.
LinearFollower	The most incredibly simple trajectory follower you could possible imagine.
MainThread
Map	A representation of all of the physical elements on a playing field.
MapTools	A wide variety of different tools for playing around with maps.
MapTools.Area	Class used for representing the area of a zone.
MeccanumKinematics	Forwards and inverse meccanum kinematics.
MeccanumState	MeccanumState represents the state of a meccanum drivetrain, where each of the four wheels (colloquially internally referred to as "modules") contains a power value that should be applied to a physical drivetrain.
MiddleBlock	Example blocked field.
ModuleState	Represent the state of a single drive motor module.
MotionSnapshot	A picture - a "snapshot," if you will, of the robot's projected motion.
Motor	Interface used for making different types of motors compatible with the Pathfinder system.
NoFindersException	An exception to be used in cases where the user hasn't enabled any of the finders available.
ObstacleCourse	Example obstacle course.
Odometry	Interface used for standardizing odometry.
OdometryWrapper	Wrapper that surrounds user-provided odometry systems in case the user wants to swap their X and Y values or invert either their X or Y values.
Path
Pathfinder	The highest-level Pathfinder available.
PathfinderConfig	The lowest-level and least-abstract configuration available for the Pathfinder library.
PathfinderConfigurationBuilder	Simple interface for creating Pathfinder configurations.
PathfinderManager	A manager, designed for interacting with the whole of Pathfinder.
PathfinderOptions	Abstraction of the PathfinderConfig class designed to make life a little bit easier and those parameters a little bit less grouped together.
PathfinderThread	Thread used in updating pathfinder values and controlling motors.
PathfinderThreadManager	Wrapper class used to manage threads.
PathGenerator	Convert a trajectory into a path.
PathGroup
Point	The most simple geometry of all - a singular point.
PointTracker	Track a single point in a two-dimensional environment.
PromisedFinder	A partially uncompleted (or partially completed) pathfinder state.
Reciprocal	Math functionality for finding the reciprocal of a number.
Rectangle	The most basic of the geometric shapes used in the field mapping portion of this code.
Rectangle.Corners	A list of different positions on a rectangle.
Reflect
Reflection	Reflect a value across a specific value.
RobotProfile	A robot's movement profile.
RotationalVelocity	A representation of a rotational velocity force.
RotationalVelocity.Type	Different types of rotational velocity measurement.
RTransform	A representation of a robot's transformation.
Season2021	2021 season FRC field.
Season2021	2021 Season FTC field.
Segment	Trajectory segments are the core components behind trajectories, which are best represented as a combination of segments.
SegmentInterpolator	Instantiable class used in interpreting a segment based on percentage X or percentage Y values.
Shape	Shapes - the very first thing you learn in pre-school, and virtualized field mapping.
SimpleConfig	A simple pathfinder configuration that relies on a lot less input parameters.
SpeedConverter	Convert between wheel speed (-1 to 1) and velocity (in inches per second, most often).
SpeedFinder	A relatively quick path generator - think of it as an extended version of the LightningFinder.
Spline	Ahh...
SplineInterpolator	Interpolate splines by using the Fritsch-Carlson computational method for determining control points for a spline.
SwerveChassisTracker	Track the position of a swerve chassis with four swerve modules.
SwerveKinematics	A variety of mathematical functionality related to kinematics for a swerve chassis.
SwerveModuleTracker	Track the position of a swerve module.
SwerveOdometry	Helper class for determining the position of a robot that uses a swerve drive.
SwerveState
Sync	Marker interface used for annotating methods that operate synchronously.
ThreeWheelChassisTracker	Three-wheel odometry chassis tracking, provided as an alternative to more direct methods, such as Swerve or Tank tracking.
Time	Static time measurement utility designed to reduce the length of time values by scaling them all down at start.
Tracker	Interface used for standardizing different types of positional trackers.
Trajectory	Resource class for storing trajectory segments in a single compact form.
TrajectoryFollower	A lovely follower designed for trajectories.
UnimplementedException	Exception to be thrown when a portion of code isn't fully implemented yet and, as a result, isn't yet ready for use.
Wait	Indicate methods that block the current thread's execution until a certain condition has been met.
WheelSize
Xygum	An implementation of the path generation library originally witten by Xavier Guzman.
Xygum.FinderConfiguration	The pathfinder's configuration class.
Xygum.Finders	The available finders.
Zone	A zone is any two-dimensional area in which another two-dimensional entity can be within.