Class FieldObject2d

java.lang.Object

org.wpilib.smartdashboard.FieldObject2d

public class FieldObject2d
extends Object

Game field object on a Field2d.

Method Summary

Modifier and Type	Method	Description
Pose2d	getPose()	Get the pose.
List<Pose2d>	getPoses()	Get multiple poses.
void	setPose(double x, double y, Rotation2d rotation)	Set the pose from x, y, and rotation.
void	setPose(Pose2d pose)	Set the pose from a Pose object.
void	setPose(Distance x, Distance y, Rotation2d rotation)	Set the pose from x, y, and rotation.
void	setPoses(List<Pose2d> poses)	Set multiple poses from a list of Pose objects.
void	setPoses(Pose2d... poses)	Set multiple poses from a list of Pose objects.
<SampleType extends HolonomicSample> void	setTrajectory(Trajectory<SampleType> trajectory)	Sets poses from a trajectory.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

setPose

public void setPose(Pose2d pose)

Set the pose from a Pose object.

Parameters:

pose - 2D pose

setPose

public void setPose(double x,
 double y,
 Rotation2d rotation)

Set the pose from x, y, and rotation.

Parameters:

x - X location, in meters

y - Y location, in meters

rotation - rotation

setPose

public void setPose(Distance x,
 Distance y,
 Rotation2d rotation)

Set the pose from x, y, and rotation.

Parameters:

x - X location

y - Y location

rotation - rotation

getPose

public Pose2d getPose()

Get the pose.

Returns:

2D pose

setPoses

public void setPoses(List<Pose2d> poses)

Set multiple poses from a list of Pose objects. The total number of poses is limited to 85.

Parameters:

poses - list of 2D poses

setPoses

public void setPoses(Pose2d... poses)

Set multiple poses from a list of Pose objects. The total number of poses is limited to 85.

Parameters:

poses - list of 2D poses

setTrajectory

public <SampleType extends HolonomicSample> void setTrajectory(Trajectory<SampleType> trajectory)

Sets poses from a trajectory.

Type Parameters:

SampleType - The type of the trajectory sample.

Parameters:

trajectory - The trajectory from which the poses should be added.

getPoses

public List<Pose2d> getPoses()

Get multiple poses.

Returns:

list of 2D poses