JSim 2026.06.01-p(1)
Loading...
Searching...
No Matches
jsim.LinearVelocity3d Class Reference

Public Member Functions

 LinearVelocity3d (LinearVelocity vx, LinearVelocity vy, LinearVelocity vz)
 LinearVelocity3d (double vxMetersPerSecond, double vyMetersPerSecond, double vzMetersPerSecond)
LinearVelocity getVx ()
LinearVelocity getX ()
LinearVelocity getVy ()
LinearVelocity getY ()
LinearVelocity getVz ()
LinearVelocity getZ ()
double getVxMetersPerSecond ()
double getVyMetersPerSecond ()
double getVzMetersPerSecond ()
double getMagnitude ()
boolean equals (Object obj)
int hashCode ()
String toString ()

Detailed Description

Represents a 3D linear velocity vector with components in meters per second.

This class provides a semantic wrapper around velocity components to clearly distinguish velocity vectors from position/translation vectors.

Constructor & Destructor Documentation

◆ LinearVelocity3d() [1/2]

jsim.LinearVelocity3d.LinearVelocity3d ( LinearVelocity vx,
LinearVelocity vy,
LinearVelocity vz )
inline

Creates a new LinearVelocity3d with WPILib velocity measures.

Parameters
vxx velocity component
vyy velocity component
vzz velocity component

◆ LinearVelocity3d() [2/2]

jsim.LinearVelocity3d.LinearVelocity3d ( double vxMetersPerSecond,
double vyMetersPerSecond,
double vzMetersPerSecond )
inline

Creates a new LinearVelocity3d with the given components.

Parameters
vxMetersPerSecondx velocity component in meters per second
vyMetersPerSecondy velocity component in meters per second
vzMetersPerSecondz velocity component in meters per second

Member Function Documentation

◆ equals()

boolean jsim.LinearVelocity3d.equals ( Object obj)
inline

◆ getMagnitude()

double jsim.LinearVelocity3d.getMagnitude ( )
inline

Gets the magnitude (speed) of this velocity vector.

Returns
speed in meters per second

◆ getVx()

LinearVelocity jsim.LinearVelocity3d.getVx ( )
inline

Gets the x velocity component.

Returns
x velocity

◆ getVxMetersPerSecond()

double jsim.LinearVelocity3d.getVxMetersPerSecond ( )
inline

Gets the x velocity component.

Returns
x velocity in meters per second

◆ getVy()

LinearVelocity jsim.LinearVelocity3d.getVy ( )
inline

Gets the y velocity component.

Returns
y velocity

◆ getVyMetersPerSecond()

double jsim.LinearVelocity3d.getVyMetersPerSecond ( )
inline

Gets the y velocity component.

Returns
y velocity in meters per second

◆ getVz()

LinearVelocity jsim.LinearVelocity3d.getVz ( )
inline

Gets the z velocity component.

Returns
z velocity

◆ getVzMetersPerSecond()

double jsim.LinearVelocity3d.getVzMetersPerSecond ( )
inline

Gets the z velocity component.

Returns
z velocity in meters per second

◆ getX()

LinearVelocity jsim.LinearVelocity3d.getX ( )
inline

Gets the x velocity component.

Returns
x velocity

◆ getY()

LinearVelocity jsim.LinearVelocity3d.getY ( )
inline

Gets the y velocity component.

Returns
y velocity

◆ getZ()

LinearVelocity jsim.LinearVelocity3d.getZ ( )
inline

Gets the z velocity component.

Returns
z velocity

◆ hashCode()

int jsim.LinearVelocity3d.hashCode ( )
inline

◆ toString()

String jsim.LinearVelocity3d.toString ( )
inline
The documentation for this class was generated from the following file: