com.io7m.jspatial.api.octtrees

Class OctTreeConfigurationI

java.lang.Object

com.io7m.jspatial.api.octtrees.OctTreeConfigurationI

All Implemented Interfaces:

OctTreeConfigurationIType

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

The type of integer octtree configurations.

Since:

3.0.0

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static OctTreeConfigurationI.Builder	builder() Creates a builder for OctTreeConfigurationI.
static OctTreeConfigurationI	copyOf(OctTreeConfigurationIType instance) Creates an immutable copy of a OctTreeConfigurationIType value.
boolean	equals(Object another) This instance is equal to all instances of OctTreeConfigurationI that have equal attribute values.
int	hashCode() Computes a hash code from attributes: volume, minimumOctantWidth, minimumOctantHeight, minimumOctantDepth, trimOnRemove.
int	minimumOctantDepth()
int	minimumOctantHeight()
int	minimumOctantWidth()
static OctTreeConfigurationI	of(com.io7m.jregions.core.unparameterized.volumes.VolumeI volume, int minimumOctantWidth, int minimumOctantHeight, int minimumOctantDepth, boolean trimOnRemove) Construct a new immutable OctTreeConfigurationI instance.
String	toString() Prints the immutable value OctTreeConfigurationI with attribute values.
boolean	trimOnRemove()
com.io7m.jregions.core.unparameterized.volumes.VolumeI	volume()
OctTreeConfigurationI	withMinimumOctantDepth(int value) Copy the current immutable object by setting a value for the minimumOctantDepth attribute.
OctTreeConfigurationI	withMinimumOctantHeight(int value) Copy the current immutable object by setting a value for the minimumOctantHeight attribute.
OctTreeConfigurationI	withMinimumOctantWidth(int value) Copy the current immutable object by setting a value for the minimumOctantWidth attribute.
OctTreeConfigurationI	withTrimOnRemove(boolean value) Copy the current immutable object by setting a value for the trimOnRemove attribute.
OctTreeConfigurationI	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

Method Detail

volume

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

Specified by:

volume in interface OctTreeConfigurationIType

Returns:

The maximum bounding volume of the tree

minimumOctantWidth

public int minimumOctantWidth()

Specified by:

minimumOctantWidth in interface OctTreeConfigurationIType

Returns:

The minimum width of octants (must be >= 2)

minimumOctantHeight

public int minimumOctantHeight()

Specified by:

minimumOctantHeight in interface OctTreeConfigurationIType

Returns:

The minimum height of octants (must be >= 2)

minimumOctantDepth

public int minimumOctantDepth()

Specified by:

minimumOctantDepth in interface OctTreeConfigurationIType

Returns:

The minimum depth of octants (must be >= 2)

trimOnRemove

public boolean trimOnRemove()

Specified by:

trimOnRemove in interface OctTreeConfigurationIType

Returns:

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

withVolume

public final OctTreeConfigurationI 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

withMinimumOctantWidth

public final OctTreeConfigurationI withMinimumOctantWidth(int value)

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

Parameters:

value - A new value for minimumOctantWidth

Returns:

A modified copy of the this object

withMinimumOctantHeight

public final OctTreeConfigurationI withMinimumOctantHeight(int value)

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

Parameters:

value - A new value for minimumOctantHeight

Returns:

A modified copy of the this object

withMinimumOctantDepth

public final OctTreeConfigurationI withMinimumOctantDepth(int value)

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

Parameters:

value - A new value for minimumOctantDepth

Returns:

A modified copy of the this object

withTrimOnRemove

public final OctTreeConfigurationI 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 OctTreeConfigurationI 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: volume, minimumOctantWidth, minimumOctantHeight, minimumOctantDepth, trimOnRemove.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value OctTreeConfigurationI with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static OctTreeConfigurationI of(com.io7m.jregions.core.unparameterized.volumes.VolumeI volume,
                                       int minimumOctantWidth,
                                       int minimumOctantHeight,
                                       int minimumOctantDepth,
                                       boolean trimOnRemove)

Construct a new immutable OctTreeConfigurationI instance.

Parameters:

volume - The value for the volume attribute

minimumOctantWidth - The value for the minimumOctantWidth attribute

minimumOctantHeight - The value for the minimumOctantHeight attribute

minimumOctantDepth - The value for the minimumOctantDepth attribute

trimOnRemove - The value for the trimOnRemove attribute

Returns:

An immutable OctTreeConfigurationI instance

copyOf

public static OctTreeConfigurationI copyOf(OctTreeConfigurationIType instance)

Creates an immutable copy of a OctTreeConfigurationIType 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 OctTreeConfigurationI instance

builder

public static OctTreeConfigurationI.Builder builder()

Creates a builder for OctTreeConfigurationI.

Returns:

A new OctTreeConfigurationI builder