org.dayflower.pathtracer.scene.shape

Class Sphere

java.lang.Object

org.dayflower.pathtracer.scene.shape.Sphere

All Implemented Interfaces:

Shape

public final class Sphere
extends java.lang.Object
implements Shape

A Shape implementation that implements a sphere.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields

Modifier and Type	Field and Description
static int	RELATIVE_OFFSET_POSITION_OFFSET The relative offset of the Position Offset parameter in the float array.
static int	RELATIVE_OFFSET_RADIUS The relative offset of the Radius parameter in the float array.
static int	SIZE The size of a Sphere in the float array.
static int	TYPE The type number associated with a Sphere.

Constructor Summary

Constructors

Constructor and Description
Sphere(Point3F position) Constructs a new Sphere instance.
Sphere(Point3F position, float radius) Constructs a new Sphere instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Compares object to this Sphere instance for equality.
Point3F	getPosition() Returns the center position of this Sphere.
float	getRadius() Returns the radius of this Sphere.
int	getSize() Returns the size of this Sphere instance.
int	getType() Returns the type of this Sphere instance.
int	hashCode() Returns a hash code for this Sphere instance.
boolean	isWithinRadius(float x, float y, float z) Returns true if, and only if, the point denoted by x, y and z is within radius to this Sphere instance, false otherwise.
boolean	isWithinRadius(float x, float y, float z, float threshold) Returns true if, and only if, the point denoted by x, y and z is within radius to this Sphere instance, false otherwise.
java.lang.String	toString() Returns a String representation of this Sphere instance.

Methods inherited from class java.lang.Object

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

Field Detail

RELATIVE_OFFSET_POSITION_OFFSET

public static final int RELATIVE_OFFSET_POSITION_OFFSET

The relative offset of the Position Offset parameter in the float array. The value is 0.

See Also:

Constant Field Values

RELATIVE_OFFSET_RADIUS

public static final int RELATIVE_OFFSET_RADIUS

The relative offset of the Radius parameter in the float array. The value is 1.

See Also:

Constant Field Values

SIZE

public static final int SIZE

The size of a Sphere in the float array. The size is 2.

See Also:

Constant Field Values

TYPE

public static final int TYPE

The type number associated with a Sphere. The number is 1.

See Also:

Constant Field Values

Constructor Detail

Sphere

public Sphere(Point3F position)

Constructs a new Sphere instance.

If position is null, a NullPointerException will be thrown.

Parameters:

position - the position of this Sphere

Throws:

java.lang.NullPointerException - thrown if, and only if, position is null

Sphere

public Sphere(Point3F position,
              float radius)

Constructs a new Sphere instance.

If position is null, a NullPointerException will be thrown.

Parameters:

position - the position of this Sphere

radius - the radius of this Sphere

Throws:

java.lang.NullPointerException - thrown if, and only if, position is null

Method Detail

getPosition

public Point3F getPosition()

Returns the center position of this Sphere.

Returns:

the center position of this Sphere

toString

public java.lang.String toString()

Returns a String representation of this Sphere instance.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this Sphere instance

equals

public boolean equals(java.lang.Object object)

Compares object to this Sphere instance for equality.

Returns true if, and only if, object is an instance of Sphere, and their respective values are equal, false otherwise.

Overrides:

equals in class java.lang.Object

Parameters:

object - the Object to compare to this Sphere instance for equality

Returns:

true if, and only if, object is an instance of Sphere, and their respective values are equal, false otherwise

isWithinRadius

public boolean isWithinRadius(float x,
                              float y,
                              float z)

Returns true if, and only if, the point denoted by x, y and z is within radius to this Sphere instance, false otherwise.

Calling this method is equivalent to calling isWithinRadius(x, y, z, 0.0F).

Parameters:

x - the X-coordinate

y - the Y-coordinate

z - the Z-coordinate

Returns:

true if, and only if, the point denoted by x, y and z is within radius to this Sphere instance, false otherwise

isWithinRadius

public boolean isWithinRadius(float x,
                              float y,
                              float z,
                              float threshold)

Returns true if, and only if, the point denoted by x, y and z is within radius to this Sphere instance, false otherwise.

The actual radius will be sphere.getRadius() + threshold.

Parameters:

x - the X-coordinate

y - the Y-coordinate

z - the Z-coordinate

threshold - the threshold value

Returns:

true if, and only if, the point denoted by x, y and z is within radius to this Sphere instance, false otherwise

getRadius

public float getRadius()

Returns the radius of this Sphere.

Returns:

the radius of this Sphere

getSize

public int getSize()

Returns the size of this Sphere instance.

Specified by:

getSize in interface Shape

Returns:

the size of this Sphere instance

getType

public int getType()

Returns the type of this Sphere instance.

Specified by:

getType in interface Shape

Returns:

the type of this Sphere instance

hashCode

public int hashCode()

Returns a hash code for this Sphere instance.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this Sphere instance