MotionProfile (ROOSTER API)

java.lang.Object
- org.team1540.rooster.motionprofiling.MotionProfile

```
public class MotionProfile
extends Object
```
A sequence of Points that can be used by motion profiling systems.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class MotionProfile.Point
A single instant within a MotionProfile.

Field Summary

Fields
Modifier and Type Field Description

@NotNull MotionProfile.Point[] points
The Points in the motion profile.

Constructor Summary

Constructors
Constructor Description

MotionProfile(@NotNull MotionProfile.Point[] points)
Create a new MotionProfile from an array of points.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MotionProfile.Point`	`get(int index)`	Gets the nth `MotionProfile.Point` (0-indexed) in the motion profile.
`int`	`size()`	Get the number of `points` in the profile.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - points
```
@NotNull
public final @NotNull MotionProfile.Point[] points
```
    The Points in the motion profile.
- Constructor Detail
  - MotionProfile
```
public MotionProfile(@NotNull
                     @NotNull MotionProfile.Point[] points)
```
    Create a new MotionProfile from an array of points.
    
    Parameters:
    
    points - The points to use.
- Method Detail
  - get
```
@Contract(pure=true)
public MotionProfile.Point get(int index)
```
    Gets the nth MotionProfile.Point (0-indexed) in the motion profile.
    
    Parameters:
    
    index - The index of the point to get.
    
    Returns:
    
    The point at the specified index.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if index ≥ size().
  - size
```
@Contract(pure=true)
public int size()
```
    Get the number of points in the profile.
    
    Returns:
    
    The number of points in the profile; specifically, points.length.