com.io7m.jspatial.api.quadtrees

Class QuadTreeConfigurationD

java.lang.Object

com.io7m.jspatial.api.quadtrees.QuadTreeConfigurationD

All Implemented Interfaces:

QuadTreeConfigurationDType

@Generated(value={"Immutables.generator","QuadTreeConfigurationDType"})
public final class QuadTreeConfigurationD
extends Object
implements QuadTreeConfigurationDType

The type of double precision quadtree configurations.

Since:

3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QuadTreeConfigurationD.Builder Builds instances of type QuadTreeConfigurationD.

Method Summary

Modifier and Type	Method and Description
com.io7m.jregions.core.unparameterized.areas.AreaD	area()
static QuadTreeConfigurationD.Builder	builder() Creates a builder for QuadTreeConfigurationD.
static QuadTreeConfigurationD	copyOf(QuadTreeConfigurationDType instance) Creates an immutable copy of a QuadTreeConfigurationDType value.
boolean	equals(Object another) This instance is equal to all instances of QuadTreeConfigurationD that have equal attribute values.
int	hashCode() Computes a hash code from attributes: area, minimumQuadrantWidth, minimumQuadrantHeight, trimOnRemove.
double	minimumQuadrantHeight()
double	minimumQuadrantWidth()
static QuadTreeConfigurationD	of(com.io7m.jregions.core.unparameterized.areas.AreaD area, double minimumQuadrantWidth, double minimumQuadrantHeight, boolean trimOnRemove) Construct a new immutable QuadTreeConfigurationD instance.
String	toString() Prints the immutable value QuadTreeConfigurationD with attribute values.
boolean	trimOnRemove()
QuadTreeConfigurationD	withArea(com.io7m.jregions.core.unparameterized.areas.AreaD value) Copy the current immutable object by setting a value for the area attribute.
QuadTreeConfigurationD	withMinimumQuadrantHeight(double value) Copy the current immutable object by setting a value for the minimumQuadrantHeight attribute.
QuadTreeConfigurationD	withMinimumQuadrantWidth(double value) Copy the current immutable object by setting a value for the minimumQuadrantWidth attribute.
QuadTreeConfigurationD	withTrimOnRemove(boolean value) Copy the current immutable object by setting a value for the trimOnRemove attribute.

Methods inherited from class java.lang.Object

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

Method Detail

area

public com.io7m.jregions.core.unparameterized.areas.AreaD area()

Specified by:

area in interface QuadTreeConfigurationDType

Returns:

The maximum bounding area of the tree

minimumQuadrantWidth

public double minimumQuadrantWidth()

Specified by:

minimumQuadrantWidth in interface QuadTreeConfigurationDType

Returns:

The minimum width of quadrants (must be >= 0.0001)

minimumQuadrantHeight

public double minimumQuadrantHeight()

Specified by:

minimumQuadrantHeight in interface QuadTreeConfigurationDType

Returns:

The minimum height of quadrants (must be >= 0.0001)

trimOnRemove

public boolean trimOnRemove()

Specified by:

trimOnRemove in interface QuadTreeConfigurationDType

Returns:

true iff the implementation should attempt to trim empty leaf nodes when an item is removed

withArea

public final QuadTreeConfigurationD withArea(com.io7m.jregions.core.unparameterized.areas.AreaD value)

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

Parameters:

value - A new value for area

Returns:

A modified copy of the this object

withMinimumQuadrantWidth

public final QuadTreeConfigurationD withMinimumQuadrantWidth(double value)

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

Parameters:

value - A new value for minimumQuadrantWidth

Returns:

A modified copy of the this object

withMinimumQuadrantHeight

public final QuadTreeConfigurationD withMinimumQuadrantHeight(double value)

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

Parameters:

value - A new value for minimumQuadrantHeight

Returns:

A modified copy of the this object

withTrimOnRemove

public final QuadTreeConfigurationD withTrimOnRemove(boolean value)

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

Parameters:

value - A new value for trimOnRemove

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of QuadTreeConfigurationD 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: area, minimumQuadrantWidth, minimumQuadrantHeight, trimOnRemove.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value QuadTreeConfigurationD with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static QuadTreeConfigurationD of(com.io7m.jregions.core.unparameterized.areas.AreaD area,
                                        double minimumQuadrantWidth,
                                        double minimumQuadrantHeight,
                                        boolean trimOnRemove)

Construct a new immutable QuadTreeConfigurationD instance.

Parameters:

area - The value for the area attribute

minimumQuadrantWidth - The value for the minimumQuadrantWidth attribute

minimumQuadrantHeight - The value for the minimumQuadrantHeight attribute

trimOnRemove - The value for the trimOnRemove attribute

Returns:

An immutable QuadTreeConfigurationD instance

copyOf

public static QuadTreeConfigurationD copyOf(QuadTreeConfigurationDType instance)

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

Parameters:

instance - The instance to copy

Returns:

A copied immutable QuadTreeConfigurationD instance

builder

public static QuadTreeConfigurationD.Builder builder()

Creates a builder for QuadTreeConfigurationD.

Returns:

A new QuadTreeConfigurationD builder