com.io7m.jspatial.api.octtrees

Class OctTreeConfigurationL

java.lang.Object

com.io7m.jspatial.api.octtrees.OctTreeConfigurationL

All Implemented Interfaces:

OctTreeConfigurationLType

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

The type of long integer octtree configurations.

Since:

3.0.0

Nested Class Summary

Nested Classes

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

Method Summary

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

Specified by:

volume in interface OctTreeConfigurationLType

Returns:

The maximum bounding volume of the tree

minimumOctantWidth

public long minimumOctantWidth()

Specified by:

minimumOctantWidth in interface OctTreeConfigurationLType

Returns:

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

minimumOctantHeight

public long minimumOctantHeight()

Specified by:

minimumOctantHeight in interface OctTreeConfigurationLType

Returns:

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

minimumOctantDepth

public long minimumOctantDepth()

Specified by:

minimumOctantDepth in interface OctTreeConfigurationLType

Returns:

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

trimOnRemove

public boolean trimOnRemove()

Specified by:

trimOnRemove in interface OctTreeConfigurationLType

Returns:

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

withVolume

public final OctTreeConfigurationL withVolume(com.io7m.jregions.core.unparameterized.volumes.VolumeL 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 OctTreeConfigurationL withMinimumOctantWidth(long 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 OctTreeConfigurationL withMinimumOctantHeight(long 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 OctTreeConfigurationL withMinimumOctantDepth(long 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 OctTreeConfigurationL 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 OctTreeConfigurationL 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 OctTreeConfigurationL with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static OctTreeConfigurationL of(com.io7m.jregions.core.unparameterized.volumes.VolumeL volume,
                                       long minimumOctantWidth,
                                       long minimumOctantHeight,
                                       long minimumOctantDepth,
                                       boolean trimOnRemove)

Construct a new immutable OctTreeConfigurationL 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 OctTreeConfigurationL instance

copyOf

public static OctTreeConfigurationL copyOf(OctTreeConfigurationLType instance)

Creates an immutable copy of a OctTreeConfigurationLType 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 OctTreeConfigurationL instance

builder

public static OctTreeConfigurationL.Builder builder()

Creates a builder for OctTreeConfigurationL.

Returns:

A new OctTreeConfigurationL builder