com.io7m.jspatial.api.octtrees

Class OctTreeRaycastResultI<T>

java.lang.Object

com.io7m.jspatial.api.octtrees.OctTreeRaycastResultI<T>

Type Parameters:

T - The precise type of objects

All Implemented Interfaces:

OctTreeRaycastResultIType<T>, Comparable<OctTreeRaycastResultIType<T>>

@Generated(value={"Immutables.generator","OctTreeRaycastResultIType<T>"})
public final class OctTreeRaycastResultI<T>
extends Object
implements OctTreeRaycastResultIType<T>

The type of octtree raycast results.

Since:

3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OctTreeRaycastResultI.Builder<T> Builds instances of type OctTreeRaycastResultI.

Method Summary

Modifier and Type	Method and Description
static <T> OctTreeRaycastResultI.Builder<T>	builder() Creates a builder for OctTreeRaycastResultI.
static <T> OctTreeRaycastResultI<T>	copyOf(OctTreeRaycastResultIType<T> instance) Creates an immutable copy of a OctTreeRaycastResultIType value.
double	distance()
boolean	equals(Object another) This instance is equal to all instances of OctTreeRaycastResultI that have equal attribute values.
int	hashCode() Computes a hash code from attributes: distance, volume, item.
T	item()
static <T> OctTreeRaycastResultI<T>	of(double distance, com.io7m.jregions.core.unparameterized.volumes.VolumeI volume, T item) Construct a new immutable OctTreeRaycastResultI instance.
String	toString() Prints the immutable value OctTreeRaycastResultI with attribute values.
com.io7m.jregions.core.unparameterized.volumes.VolumeI	volume()
OctTreeRaycastResultI<T>	withDistance(double value) Copy the current immutable object by setting a value for the distance attribute.
OctTreeRaycastResultI<T>	withItem(T value) Copy the current immutable object by setting a value for the item attribute.
OctTreeRaycastResultI<T>	withVolume(com.io7m.jregions.core.unparameterized.volumes.VolumeI value) Copy the current immutable object by setting a value for the volume attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.jspatial.api.octtrees.OctTreeRaycastResultIType

compareTo

Method Detail

distance

public double distance()

Specified by:

distance in interface OctTreeRaycastResultIType<T>

Returns:

The distance to the object

volume

public com.io7m.jregions.core.unparameterized.volumes.VolumeI volume()

Specified by:

volume in interface OctTreeRaycastResultIType<T>

Returns:

The object volume

item

public T item()

Specified by:

item in interface OctTreeRaycastResultIType<T>

Returns:

The object

withDistance

public final OctTreeRaycastResultI<T> withDistance(double value)

Copy the current immutable object by setting a value for the distance attribute. A value strict bits equality used to prevent copying of the same value by returning this.

Parameters:

value - A new value for distance

Returns:

A modified copy of the this object

withVolume

public final OctTreeRaycastResultI<T> withVolume(com.io7m.jregions.core.unparameterized.volumes.VolumeI value)

Copy the current immutable object by setting a value for the volume attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for volume

Returns:

A modified copy of the this object

withItem

public final OctTreeRaycastResultI<T> withItem(T value)

Copy the current immutable object by setting a value for the item attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for item

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of OctTreeRaycastResultI that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: distance, volume, item.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value OctTreeRaycastResultI with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <T> OctTreeRaycastResultI<T> of(double distance,
                                              com.io7m.jregions.core.unparameterized.volumes.VolumeI volume,
                                              T item)

Construct a new immutable OctTreeRaycastResultI instance.

Parameters:

distance - The value for the distance attribute

volume - The value for the volume attribute

item - The value for the item attribute

Returns:

An immutable OctTreeRaycastResultI instance

copyOf

public static <T> OctTreeRaycastResultI<T> copyOf(OctTreeRaycastResultIType<T> instance)

Creates an immutable copy of a OctTreeRaycastResultIType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Type Parameters:

T - generic parameter T

Parameters:

instance - The instance to copy

Returns:

A copied immutable OctTreeRaycastResultI instance

builder

public static <T> OctTreeRaycastResultI.Builder<T> builder()

Creates a builder for OctTreeRaycastResultI.

Type Parameters:

T - generic parameter T

Returns:

A new OctTreeRaycastResultI builder