jsim.api.GamePieceState Class Reference

Inheritance diagram for jsim.api.GamePieceState:

Public Member Functions
	GamePieceState (GamePieceType type)
GamePieceType	getType ()
void	setVelocity (LinearVelocity3d velocity)
void	setRotation (Rotation3d rotation)
LinearVelocity3d	getVelocity ()
Rotation3d	getRotation ()
void	setRobotOffsetStart (Translation2d offset)
Translation2d	getRobotOffsetStart ()
void	setExitVelocity (LinearVelocity3d velocity)
LinearVelocity3d	getExitVelocity ()
void	setExitAngle (Rotation3d angle)
Rotation3d	getExitAngle ()
void	intakeZone (Translation3d[] intakeArea)
Translation3d[]	getIntakeArea ()

Public Attributes
GamePieceType	type
LinearVelocity3d	velocity
Rotation3d	rotation
Translation2d	robotOffsetStart
LinearVelocity3d	exitVelocity
Rotation3d	exitAngle
Translation3d[]	intakeArea

Detailed Description

Represents the state of a game piece in the simulation. Includes type, velocity, rotation, and other physical properties.

Constructor & Destructor Documentation

GamePieceState()

jsim.api.GamePieceState.GamePieceState ( GamePieceType type )

inline

Creates a game piece state for the given type.

Parameters

type	game piece type

Member Function Documentation

getExitAngle()

Rotation3d jsim.api.GamePieceState.getExitAngle ( )

inline

Returns the exit angle.

Returns

the exit angle

getExitVelocity()

LinearVelocity3d jsim.api.GamePieceState.getExitVelocity ( )

inline

Returns the exit velocity vector.

Returns

the exit velocity vector

getIntakeArea()

Translation3d[] jsim.api.GamePieceState.getIntakeArea ( )

inline

Returns the intake polygon area.

Returns

the intake polygon area

getRobotOffsetStart()

Translation2d jsim.api.GamePieceState.getRobotOffsetStart ( )

inline

Returns the robot offset start.

Returns

the starting offset in robot coordinates

getRotation()

Rotation3d jsim.api.GamePieceState.getRotation ( )

inline

Returns the rotation.

Returns

the piece rotation

getType()

GamePieceType jsim.api.GamePieceState.getType ( )

inline

Returns the piece type.

Returns

the game piece type

getVelocity()

LinearVelocity3d jsim.api.GamePieceState.getVelocity ( )

inline

Returns the linear velocity.

Returns

the linear velocity

intakeZone()

void jsim.api.GamePieceState.intakeZone ( Translation3d[] intakeArea )

inline

Sets the intake polygon area.

Parameters

intakeArea

intake polygon area

setExitAngle()

void jsim.api.GamePieceState.setExitAngle ( Rotation3d angle )

inline

Sets the exit angle.

Parameters

angle

exit angle

setExitVelocity()

void jsim.api.GamePieceState.setExitVelocity ( LinearVelocity3d velocity )

inline

Sets the exit velocity vector.

Parameters

velocity

exit velocity vector

setRobotOffsetStart()

void jsim.api.GamePieceState.setRobotOffsetStart ( Translation2d offset )

inline

Sets the robot offset start.

Parameters

offset

starting offset in robot coordinates

setRotation()

void jsim.api.GamePieceState.setRotation ( Rotation3d rotation )

inline

Sets the rotation.

Parameters

rotation

piece rotation

setVelocity()

void jsim.api.GamePieceState.setVelocity ( LinearVelocity3d velocity )

inline

Sets the linear velocity.

Parameters

velocity

linear exit velocity

Member Data Documentation

exitAngle

Rotation3d jsim.api.GamePieceState.exitAngle

Exit orientation.

exitVelocity

LinearVelocity3d jsim.api.GamePieceState.exitVelocity

Exit velocity vector.

intakeArea

Translation3d [] jsim.api.GamePieceState.intakeArea

Intake polygon in robot space.

robotOffsetStart

Translation2d jsim.api.GamePieceState.robotOffsetStart

Start offset in the robot frame.

rotation

Rotation3d jsim.api.GamePieceState.rotation

Orientation of the piece.

type

GamePieceType jsim.api.GamePieceState.type

Type of this game piece.

velocity

LinearVelocity3d jsim.api.GamePieceState.velocity

Linear exit velocity used by the current simulation API.

---

The documentation for this class was generated from the following file:

• src/main/java/jsim/api/GamePieceState.java