Package org.joml

Class Rayf

java.lang.Object

org.joml.Rayf

All Implemented Interfaces:

Externalizable, Serializable

public class Rayf
extends Object
implements Externalizable

Represents a ray with a given origin and direction using single-precision floating-point numbers.

Author:

Kai Burjack

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
float	dX	The x coordinate of the ray's direction.
float	dY	The y coordinate of the ray's direction.
float	dZ	The z coordinate of the ray's direction.
float	oX	The x coordinate of the ray's origin.
float	oY	The y coordinate of the ray's origin.
float	oZ	The z coordinate of the ray's origin.

Constructor Summary

Constructors

Constructor	Description
Rayf()	Create a new Rayf with origin (0, 0, 0) and no direction.
Rayf(float oX, float oY, float oZ, float dX, float dY, float dZ)	Create a new Rayf with the given origin and direction.
Rayf(Rayf source)	Create a new Rayf as a copy of the given source.
Rayf(Vector3fc origin, Vector3fc direction)	Create a new Rayf with the given origin and direction.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()
void	readExternal(ObjectInput in)
String	toString()	Return a string representation of this ray.
String	toString(NumberFormat formatter)	Return a string representation of this ray by formatting the vector components with the given NumberFormat.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

oX

public float oX

The x coordinate of the ray's origin.

oY

public float oY

The y coordinate of the ray's origin.

oZ

public float oZ

The z coordinate of the ray's origin.

dX

public float dX

The x coordinate of the ray's direction.

dY

public float dY

The y coordinate of the ray's direction.

dZ

public float dZ

The z coordinate of the ray's direction.

Constructor Detail

Rayf

public Rayf()

Create a new Rayf with origin (0, 0, 0) and no direction.

Rayf

public Rayf(Rayf source)

Create a new Rayf as a copy of the given source.

Parameters:

source - the Rayf to copy from

Rayf

public Rayf(Vector3fc origin,
            Vector3fc direction)

Create a new Rayf with the given origin and direction.

Parameters:

origin - the origin of the ray

direction - the direction of the ray

Rayf

public Rayf(float oX,
            float oY,
            float oZ,
            float dX,
            float dY,
            float dZ)

Create a new Rayf with the given origin and direction.

Parameters:

oX - the x coordinate of the ray's origin

oY - the y coordinate of the ray's origin

oZ - the z coordinate of the ray's origin

dX - the x coordinate of the ray's direction

dY - the y coordinate of the ray's direction

dZ - the z coordinate of the ray's direction

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Return a string representation of this ray.

This method creates a new DecimalFormat on every invocation with the format string "0.000E0;-".

Overrides:

toString in class Object

Returns:

the string representation

toString

public String toString(NumberFormat formatter)

Return a string representation of this ray by formatting the vector components with the given NumberFormat.

Parameters:

formatter - the NumberFormat used to format the vector components with

Returns:

the string representation

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException