OctTreeConfigurationD (com.io7m.jspatial.documentation 3.0.0-beta0002 API)

java.lang.Object
- com.io7m.jspatial.api.octtrees.OctTreeConfigurationD

All Implemented Interfaces:: OctTreeConfigurationDType

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

The type of double precision octtree configurations.

Since:: 3.0.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OctTreeConfigurationD.Builder
Builds instances of type OctTreeConfigurationD.

Nested Classes
Modifier and Type	Class and Description
`static class`	`OctTreeConfigurationD.Builder` Builds instances of type `OctTreeConfigurationD`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static OctTreeConfigurationD.Builder`	`builder()` Creates a builder for `OctTreeConfigurationD`.
`static OctTreeConfigurationD`	`copyOf(OctTreeConfigurationDType instance)` Creates an immutable copy of a `OctTreeConfigurationDType` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `OctTreeConfigurationD` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `volume`, `minimumOctantWidth`, `minimumOctantHeight`, `minimumOctantDepth`, `trimOnRemove`.
`double`	`minimumOctantDepth()`
`double`	`minimumOctantHeight()`
`double`	`minimumOctantWidth()`
`static OctTreeConfigurationD`	`of(com.io7m.jregions.core.unparameterized.volumes.VolumeD volume, double minimumOctantWidth, double minimumOctantHeight, double minimumOctantDepth, boolean trimOnRemove)` Construct a new immutable `OctTreeConfigurationD` instance.
`String`	`toString()` Prints the immutable value `OctTreeConfigurationD` with attribute values.
`boolean`	`trimOnRemove()`
`com.io7m.jregions.core.unparameterized.volumes.VolumeD`	`volume()`
`OctTreeConfigurationD`	`withMinimumOctantDepth(double value)` Copy the current immutable object by setting a value for the `minimumOctantDepth` attribute.
`OctTreeConfigurationD`	`withMinimumOctantHeight(double value)` Copy the current immutable object by setting a value for the `minimumOctantHeight` attribute.
`OctTreeConfigurationD`	`withMinimumOctantWidth(double value)` Copy the current immutable object by setting a value for the `minimumOctantWidth` attribute.
`OctTreeConfigurationD`	`withTrimOnRemove(boolean value)` Copy the current immutable object by setting a value for the `trimOnRemove` attribute.
`OctTreeConfigurationD`	`withVolume(com.io7m.jregions.core.unparameterized.volumes.VolumeD 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.VolumeD volume()
```
    Specified by:
    
    volume in interface OctTreeConfigurationDType
    
    Returns:
    
    The maximum bounding volume of the tree
  - minimumOctantWidth
```
public double minimumOctantWidth()
```
    Specified by:
    
    minimumOctantWidth in interface OctTreeConfigurationDType
    
    Returns:
    
    The minimum width of octants (must be >= 0.0001)
  - minimumOctantHeight
```
public double minimumOctantHeight()
```
    Specified by:
    
    minimumOctantHeight in interface OctTreeConfigurationDType
    
    Returns:
    
    The minimum height of octants (must be >= 0.0001)
  - minimumOctantDepth
```
public double minimumOctantDepth()
```
    Specified by:
    
    minimumOctantDepth in interface OctTreeConfigurationDType
    
    Returns:
    
    The minimum depth of octants (must be >= 0.0001)
  - trimOnRemove
```
public boolean trimOnRemove()
```
    Specified by:
    
    trimOnRemove in interface OctTreeConfigurationDType
    
    Returns:
    
    true iff the implementation should attempt to trim empty leaf nodes when an item is removed
  - withVolume
```
public final OctTreeConfigurationD withVolume(com.io7m.jregions.core.unparameterized.volumes.VolumeD 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 OctTreeConfigurationD withMinimumOctantWidth(double value)
```
    Copy the current immutable object by setting a value for the minimumOctantWidth attribute. A value strict bits equality 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 OctTreeConfigurationD withMinimumOctantHeight(double value)
```
    Copy the current immutable object by setting a value for the minimumOctantHeight attribute. A value strict bits equality 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 OctTreeConfigurationD withMinimumOctantDepth(double value)
```
    Copy the current immutable object by setting a value for the minimumOctantDepth attribute. A value strict bits equality 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 OctTreeConfigurationD 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 OctTreeConfigurationD 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 OctTreeConfigurationD with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - of
```
public static OctTreeConfigurationD of(com.io7m.jregions.core.unparameterized.volumes.VolumeD volume,
                                       double minimumOctantWidth,
                                       double minimumOctantHeight,
                                       double minimumOctantDepth,
                                       boolean trimOnRemove)
```
    Construct a new immutable OctTreeConfigurationD 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 OctTreeConfigurationD instance
  - copyOf
```
public static OctTreeConfigurationD copyOf(OctTreeConfigurationDType instance)
```
    Creates an immutable copy of a OctTreeConfigurationDType 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 OctTreeConfigurationD instance
  - builder
```
public static OctTreeConfigurationD.Builder builder()
```
    Creates a builder for OctTreeConfigurationD.
    
    Returns:
    
    A new OctTreeConfigurationD builder

Class OctTreeConfigurationD

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

volume

minimumOctantWidth

minimumOctantHeight

minimumOctantDepth

trimOnRemove

withVolume

withMinimumOctantWidth

withMinimumOctantHeight

withMinimumOctantDepth

withTrimOnRemove

equals

hashCode

toString

of

copyOf

builder