com.mak.vrlj.math.Vector3f Class Reference

Represents a 3D vector using three floats. More...

Inheritance diagram for com.mak.vrlj.math.Vector3f:

Collaboration diagram for com.mak.vrlj.math.Vector3f:

Public Member Functions
	Vector3f ()
	No-arg constructor. More...
	Vector3f (ConstVector3d other)
	Copy constructor from Vector3d. More...
	Vector3f (ConstVector3f other)
	Copy constructor. More...
	Vector3f (float x, float y, float z)
	Initializing constructor. More...
void	add (ConstVector3f offset)
	Add another vector to this and store the result in this. More...
float	angle (ConstVector3f other)
	Compute the angle between 2 vectors. More...
void	assignFrom (ConstVector3d other)
	Assign new values to this vector from a Vector3d. More...
void	assignFrom (ConstVector3f other)
	Assign new values to this vector from another. More...
ConstMatrix3d	createFromAxisAngle (float angle)
	Build a rotation matrix from the axis specified by this vector, and an angle rotation. More...
ConstVector3f	cross (ConstVector3f other)
	Cross product of 2 vectors. More...
ConstVector3f	directedRotRateFromVec (double theta)
	Build a rotation rate vector. More...
float	distance (ConstVector3f p)
	Get the distance between 2 3d points. More...
float	dot (ConstVector3f other)
	Dot product of 2 vectors. More...
boolean	equals (Object obj)
float	get (int i)
	Get vector component by index number, where i=0 for x, i=1 for y and i=2 for z. More...
float	getLength ()
	Get the scalar length of this vector. More...
float	getX ()
	Get the x component. More...
float	getY ()
	Get the y component. More...
float	getZ ()
	Get the z component. More...
int	hashCode ()
void	multiply (float scalar)
	Multiply this vector by a scalar and store the result in this. More...
void	normalize ()
	Adjust this vector so that the length is 1, but the direction is unchanged. More...
void	set (int i, float v)
	Set a vector component by index number, where i=0 for x, i=1 for y and i=2 for z. More...
void	setX (float x)
void	setXYZ (float x, float y, float z)
	Set all vector components. More...
void	setY (float y)
void	setZ (float z)
void	subtract (ConstVector3f offset)
	Subtract another vector from this and store the result in this. More...
String	toString ()
ConstVector3d	toVector3d ()

Static Public Attributes
static final ConstVector3f	zero = new Vector3f(0.0f, 0.0f, 0.0f)
	A vector with all components 0. More...
static final ConstVector3f	unitX = new Vector3f(1.0f, 0.0f, 0.0f)
	A unit vector along the x axis. More...
static final ConstVector3f	unitY = new Vector3f(0.0f, 1.0f, 0.0f)
	A unit vector along the y axis. More...
static final ConstVector3f	unitZ = new Vector3f(0.0f, 0.0f, 1.0f)
	A unit vector along the z axis. More...

Private Attributes
float	myX
float	myY
float	myZ

Detailed Description

Represents a 3D vector using three floats.

Constructor & Destructor Documentation

com.mak.vrlj.math.Vector3f.Vector3f ( )

inline

No-arg constructor.

Referenced by com.mak.vrlj.math.Vector3f.cross(), com.mak.vrlj.math.Vector3f.directedRotRateFromVec(), and com.mak.vrlj.math.Vector3f.equals().

com.mak.vrlj.math.Vector3f.Vector3f ( ConstVector3d  other )

inline

Copy constructor from Vector3d.

Parameters

other

source for copy.

References com.mak.vrlj.math.ConstVector3d.getX(), com.mak.vrlj.math.ConstVector3d.getY(), com.mak.vrlj.math.ConstVector3d.getZ(), com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, and com.mak.vrlj.math.Vector3f.myZ.

com.mak.vrlj.math.Vector3f.Vector3f ( ConstVector3f  other )

inline

Copy constructor.

Parameters

other

source for copy.

References com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, and com.mak.vrlj.math.Vector3f.myZ.

com.mak.vrlj.math.Vector3f.Vector3f ( float  x, float  y, float  z  )

inline

Initializing constructor.

Parameters

x	component.
y	component.
z	component.

References com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, and com.mak.vrlj.math.Vector3f.myZ.

Member Function Documentation

void com.mak.vrlj.math.Vector3f.add ( ConstVector3f  offset )

inline

Add another vector to this and store the result in this.

Parameters

offset

the value to add to this vector.

References com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, and com.mak.vrlj.math.Vector3f.myZ.

float com.mak.vrlj.math.Vector3f.angle ( ConstVector3f  other )

inlinevirtual

Compute the angle between 2 vectors.

Parameters

other

vector.

Returns

the angle between the vectors, in radians.

Implements com.mak.vrlj.math.ConstVector3f.

References com.mak.vrlj.math.Vector3f.dot(), and com.mak.vrlj.math.Vector3f.getLength().

void com.mak.vrlj.math.Vector3f.assignFrom ( ConstVector3d  other )

inline

Assign new values to this vector from a Vector3d.

Parameters

other

source for assignment.

References com.mak.vrlj.math.ConstVector3d.getX(), com.mak.vrlj.math.ConstVector3d.getY(), com.mak.vrlj.math.ConstVector3d.getZ(), com.mak.vrlj.math.Vector3f.setX(), com.mak.vrlj.math.Vector3f.setY(), and com.mak.vrlj.math.Vector3f.setZ().

void com.mak.vrlj.math.Vector3f.assignFrom ( ConstVector3f  other )

inline

Assign new values to this vector from another.

Parameters

other

source for assignment.

References com.mak.vrlj.math.ConstVector3f.getX(), com.mak.vrlj.math.ConstVector3f.getY(), com.mak.vrlj.math.ConstVector3f.getZ(), com.mak.vrlj.math.Vector3f.setX(), com.mak.vrlj.math.Vector3f.setY(), and com.mak.vrlj.math.Vector3f.setZ().

ConstMatrix3d com.mak.vrlj.math.Vector3f.createFromAxisAngle ( float  angle )

inlinevirtual

Build a rotation matrix from the axis specified by this vector, and an angle rotation.

Parameters

angle

Angle in radians to rotate counter-clockwise (looking in the direction of the given axis).

Returns

a new matrix instance.

Implements com.mak.vrlj.math.ConstVector3f.

References com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, com.mak.vrlj.math.Vector3f.myZ, and com.mak.vrlj.math.Vector3f.normalize().

ConstVector3f com.mak.vrlj.math.Vector3f.cross ( ConstVector3f  other )

inlinevirtual

Cross product of 2 vectors.

Parameters

other

vector

Returns

cross product.

Implements com.mak.vrlj.math.ConstVector3f.

References com.mak.vrlj.math.ConstVector3f.getX(), com.mak.vrlj.math.ConstVector3f.getY(), com.mak.vrlj.math.ConstVector3f.getZ(), com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, com.mak.vrlj.math.Vector3f.myZ, and com.mak.vrlj.math.Vector3f.Vector3f().

ConstVector3f com.mak.vrlj.math.Vector3f.directedRotRateFromVec ( double  theta )

inlinevirtual

Build a rotation rate vector.

Parameters

theta

rotation rate

Returns

the rotation rate vector.

Implements com.mak.vrlj.math.ConstVector3f.

References com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, com.mak.vrlj.math.Vector3f.myZ, and com.mak.vrlj.math.Vector3f.Vector3f().

float com.mak.vrlj.math.Vector3f.distance ( ConstVector3f  other )

inlinevirtual

Get the distance between 2 3d points.

Parameters

other

the other position for the difference.

Returns

the scalar distance between 2 3d points.

Implements com.mak.vrlj.math.ConstVector3f.

References com.mak.vrlj.math.Vector3f.getX(), com.mak.vrlj.math.Vector3f.getY(), and com.mak.vrlj.math.Vector3f.getZ().

float com.mak.vrlj.math.Vector3f.dot ( ConstVector3f  other )

inlinevirtual

Dot product of 2 vectors.

Parameters

other

vector.

Returns

dot product.

Implements com.mak.vrlj.math.ConstVector3f.

References com.mak.vrlj.math.ConstVector3f.getY(), com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, and com.mak.vrlj.math.Vector3f.myZ.

Referenced by com.mak.vrlj.math.Vector3f.angle().

boolean com.mak.vrlj.math.Vector3f.equals ( Object  obj )

inline

References com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, com.mak.vrlj.math.Vector3f.myZ, and com.mak.vrlj.math.Vector3f.Vector3f().

Referenced by com.mak.vrlj.coord.DeadReckoner.equals(), com.mak.vrlj.coord.Smoother.equals(), com.mak.vrlj.object.EmbeddedSystem.equals(), com.mak.vrlj.object.Entity.equals(), and com.mak.vrlj.object.RadioTransmitter.equals().

float com.mak.vrlj.math.Vector3f.get ( int  i )

inlinevirtual

Get vector component by index number, where i=0 for x, i=1 for y and i=2 for z.

Parameters

i	index of which vector component to set.

Returns

the value of the indexed component.

Implements com.mak.vrlj.math.ConstVector3f.

References com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, and com.mak.vrlj.math.Vector3f.myZ.

Referenced by com.mak.vrlj.coord.Smoother.initSmootherParams().

float com.mak.vrlj.math.Vector3f.getLength ( )

inlinevirtual

Get the scalar length of this vector.

Returns

the scalar length of this vector.

Implements com.mak.vrlj.math.ConstVector3f.

References com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, and com.mak.vrlj.math.Vector3f.myZ.

Referenced by com.mak.vrlj.math.Vector3f.angle(), and com.mak.vrlj.math.Vector3f.normalize().

float com.mak.vrlj.math.Vector3f.getX ( )

inlinevirtual

Get the x component.

Returns

the x component.

Implements com.mak.vrlj.math.ConstVector3f.

References com.mak.vrlj.math.Vector3f.myX.

Referenced by com.mak.vrlj.math.Vector3f.distance(), and com.mak.vrlj.coord.Smoother.smoothPosition().

float com.mak.vrlj.math.Vector3f.getY ( )

inlinevirtual

Get the y component.

Returns

the y component.

Implements com.mak.vrlj.math.ConstVector3f.

References com.mak.vrlj.math.Vector3f.myY.

Referenced by com.mak.vrlj.math.Vector3f.distance(), and com.mak.vrlj.coord.Smoother.smoothPosition().

float com.mak.vrlj.math.Vector3f.getZ ( )

inlinevirtual

Get the z component.

Returns

the z component.

Implements com.mak.vrlj.math.ConstVector3f.

References com.mak.vrlj.math.Vector3f.myZ.

Referenced by com.mak.vrlj.math.Vector3f.distance(), and com.mak.vrlj.coord.Smoother.smoothPosition().

int com.mak.vrlj.math.Vector3f.hashCode ( )

inline

References com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, and com.mak.vrlj.math.Vector3f.myZ.

void com.mak.vrlj.math.Vector3f.multiply ( float  scalar )

inline

Multiply this vector by a scalar and store the result in this.

Parameters

scalar

the value to add to this vector.

References com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, and com.mak.vrlj.math.Vector3f.myZ.

void com.mak.vrlj.math.Vector3f.normalize ( )

inline

Adjust this vector so that the length is 1, but the direction is unchanged.

References com.mak.vrlj.math.Vector3f.getLength(), com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, and com.mak.vrlj.math.Vector3f.myZ.

Referenced by com.mak.vrlj.math.Vector3f.createFromAxisAngle().

void com.mak.vrlj.math.Vector3f.set ( int  i, float  v  )

inline

Set a vector component by index number, where i=0 for x, i=1 for y and i=2 for z.

Parameters

i	index of which vector component to set.
v	the new value for the indexed component.

References com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, and com.mak.vrlj.math.Vector3f.myZ.

void com.mak.vrlj.math.Vector3f.setX ( float  x )

inline

Parameters

x	new value for x component.

References com.mak.vrlj.math.Vector3f.myX.

Referenced by com.mak.vrlj.math.Vector3f.assignFrom().

void com.mak.vrlj.math.Vector3f.setXYZ ( float  x, float  y, float  z  )

inline

Set all vector components.

Parameters

x	new value for x component.
y	new value for y component.
z	new value for z component.

References com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, and com.mak.vrlj.math.Vector3f.myZ.

void com.mak.vrlj.math.Vector3f.setY ( float  y )

inline

Parameters

y	new value for y component.

References com.mak.vrlj.math.Vector3f.myY.

Referenced by com.mak.vrlj.math.Vector3f.assignFrom().

void com.mak.vrlj.math.Vector3f.setZ ( float  z )

inline

Parameters

z	new value for z component.

References com.mak.vrlj.math.Vector3f.myZ.

Referenced by com.mak.vrlj.math.Vector3f.assignFrom().

void com.mak.vrlj.math.Vector3f.subtract ( ConstVector3f  offset )

inline

Subtract another vector from this and store the result in this.

Parameters

offset

the value to subtract from this vector.

References com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, and com.mak.vrlj.math.Vector3f.myZ.

String com.mak.vrlj.math.Vector3f.toString ( )

inline

References com.mak.vrlj.math.Vector3f.myX, com.mak.vrlj.math.Vector3f.myY, and com.mak.vrlj.math.Vector3f.myZ.

ConstVector3d com.mak.vrlj.math.Vector3f.toVector3d ( )

inlinevirtual

Returns

a Vector3d equal to this vector.

Implements com.mak.vrlj.math.ConstVector3f.

Member Data Documentation

float com.mak.vrlj.math.Vector3f.myX

private

Referenced by com.mak.vrlj.math.Vector3f.add(), com.mak.vrlj.math.Vector3f.createFromAxisAngle(), com.mak.vrlj.math.Vector3f.cross(), com.mak.vrlj.math.Vector3f.directedRotRateFromVec(), com.mak.vrlj.math.Vector3f.dot(), com.mak.vrlj.math.Vector3f.equals(), com.mak.vrlj.math.Vector3f.get(), com.mak.vrlj.math.Vector3f.getLength(), com.mak.vrlj.math.Vector3f.getX(), com.mak.vrlj.math.Vector3f.hashCode(), com.mak.vrlj.math.Vector3f.multiply(), com.mak.vrlj.math.Vector3f.normalize(), com.mak.vrlj.math.Vector3f.set(), com.mak.vrlj.math.Vector3f.setX(), com.mak.vrlj.math.Vector3f.setXYZ(), com.mak.vrlj.math.Vector3f.subtract(), com.mak.vrlj.math.Vector3f.toString(), and com.mak.vrlj.math.Vector3f.Vector3f().

float com.mak.vrlj.math.Vector3f.myY

private

Referenced by com.mak.vrlj.math.Vector3f.add(), com.mak.vrlj.math.Vector3f.createFromAxisAngle(), com.mak.vrlj.math.Vector3f.cross(), com.mak.vrlj.math.Vector3f.directedRotRateFromVec(), com.mak.vrlj.math.Vector3f.dot(), com.mak.vrlj.math.Vector3f.equals(), com.mak.vrlj.math.Vector3f.get(), com.mak.vrlj.math.Vector3f.getLength(), com.mak.vrlj.math.Vector3f.getY(), com.mak.vrlj.math.Vector3f.hashCode(), com.mak.vrlj.math.Vector3f.multiply(), com.mak.vrlj.math.Vector3f.normalize(), com.mak.vrlj.math.Vector3f.set(), com.mak.vrlj.math.Vector3f.setXYZ(), com.mak.vrlj.math.Vector3f.setY(), com.mak.vrlj.math.Vector3f.subtract(), com.mak.vrlj.math.Vector3f.toString(), and com.mak.vrlj.math.Vector3f.Vector3f().

float com.mak.vrlj.math.Vector3f.myZ

private

Referenced by com.mak.vrlj.math.Vector3f.add(), com.mak.vrlj.math.Vector3f.createFromAxisAngle(), com.mak.vrlj.math.Vector3f.cross(), com.mak.vrlj.math.Vector3f.directedRotRateFromVec(), com.mak.vrlj.math.Vector3f.dot(), com.mak.vrlj.math.Vector3f.equals(), com.mak.vrlj.math.Vector3f.get(), com.mak.vrlj.math.Vector3f.getLength(), com.mak.vrlj.math.Vector3f.getZ(), com.mak.vrlj.math.Vector3f.hashCode(), com.mak.vrlj.math.Vector3f.multiply(), com.mak.vrlj.math.Vector3f.normalize(), com.mak.vrlj.math.Vector3f.set(), com.mak.vrlj.math.Vector3f.setXYZ(), com.mak.vrlj.math.Vector3f.setZ(), com.mak.vrlj.math.Vector3f.subtract(), com.mak.vrlj.math.Vector3f.toString(), and com.mak.vrlj.math.Vector3f.Vector3f().

final ConstVector3f com.mak.vrlj.math.Vector3f.unitX = new Vector3f(1.0f, 0.0f, 0.0f)

static

A unit vector along the x axis.

final ConstVector3f com.mak.vrlj.math.Vector3f.unitY = new Vector3f(0.0f, 1.0f, 0.0f)

static

A unit vector along the y axis.

final ConstVector3f com.mak.vrlj.math.Vector3f.unitZ = new Vector3f(0.0f, 0.0f, 1.0f)

static

A unit vector along the z axis.

final ConstVector3f com.mak.vrlj.math.Vector3f.zero = new Vector3f(0.0f, 0.0f, 0.0f)

static

A vector with all components 0.

Referenced by com.mak.vrlj.example.f18.VehicleSim.detonateMunition(), and com.mak.vrlj.example.f18.VehicleSim.reactToDamage().

---

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

• Vector3f.java