nova.core.util.shape

Class Cuboid

java.lang.Object

nova.core.util.math.Operator<I,O>

nova.core.util.shape.Shape<Cuboid,Cuboid>

nova.core.util.shape.Cuboid

public class Cuboid
extends Shape<Cuboid,Cuboid>

A cuboid is a shape that represents a cube.

Field Summary

Fields

Modifier and Type	Field and Description
org.apache.commons.math3.geometry.euclidean.threed.Vector3D	max
org.apache.commons.math3.geometry.euclidean.threed.Vector3D	min
static Cuboid	ONE
static Cuboid	ZERO

Constructor Summary

Constructors

Constructor and Description
Cuboid(double minX, double minY, double minZ, double maxX, double maxY, double maxZ) New Cuboid with the specified coordinates as bounds
Cuboid(org.apache.commons.math3.geometry.euclidean.threed.Vector3D min, org.apache.commons.math3.geometry.euclidean.threed.Vector3D max) New cuboid defined by the specified vectors as bounds

Method Summary

Modifier and Type	Method and Description
Cuboid	$minus(org.apache.commons.math3.geometry.euclidean.threed.Vector3D other)
Cuboid	$plus(org.apache.commons.math3.geometry.euclidean.threed.Vector3D other)
Cuboid	add(Cuboid other)
Cuboid	add(double other)
Cuboid	add(org.apache.commons.math3.geometry.euclidean.threed.Vector3D other) Adds a vector to the cuboid
org.apache.commons.math3.geometry.euclidean.threed.Vector3D	center() The center of the cuboid
Cuboid	expand(double other) Expands the cuboid by a certain amount.
Cuboid	expand(org.apache.commons.math3.geometry.euclidean.threed.Vector3D other) Expands the cuboid by a certain vector.
void	forEach(java.util.function.Consumer<org.apache.commons.math3.geometry.euclidean.threed.Vector3D> consumer)
void	forEach(java.util.function.Consumer<org.apache.commons.math3.geometry.euclidean.threed.Vector3D> consumer, double step)
boolean	intersects(Cuboid other) Checks if another cuboid is within this cuboid
boolean	intersects(org.apache.commons.math3.geometry.euclidean.threed.Vector3D other) Checks if a vector is within this cuboid.
boolean	isCube() Returns if this cuboid is a cube.
Cuboid	multiply(double other)
Cuboid	reciprocal() Gets the reciprocal of this vector.
Direction	sideOf(org.apache.commons.math3.geometry.euclidean.threed.Vector3D position)
org.apache.commons.math3.geometry.euclidean.threed.Vector3D	size() How large the cuboid is
Cuboid	subtract(org.apache.commons.math3.geometry.euclidean.threed.Vector3D other)
double	surfaceArea() The surface area of the cuboid
java.lang.String	toString()
Cuboid	transform(org.apache.commons.math3.geometry.euclidean.threed.Rotation transform) Applies the given rotation to the Cuboid
Cuboid	transform(Transformer transform) Applies the given transformer to the cuboid
double	volume() The volume of the cuboid

Methods inherited from class nova.core.util.math.Operator

$div, $minus, $minus, $plus, $plus, $times, divide, negate, subtract, subtract, unary_$minus

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ZERO

public static final Cuboid ZERO

ONE

public static final Cuboid ONE

min

public final org.apache.commons.math3.geometry.euclidean.threed.Vector3D min

max

public final org.apache.commons.math3.geometry.euclidean.threed.Vector3D max

Constructor Detail

Cuboid

public Cuboid(org.apache.commons.math3.geometry.euclidean.threed.Vector3D min,
              org.apache.commons.math3.geometry.euclidean.threed.Vector3D max)

New cuboid defined by the specified vectors as bounds

Parameters:

min - min vector

max - max vextor

Cuboid

public Cuboid(double minX,
              double minY,
              double minZ,
              double maxX,
              double maxY,
              double maxZ)

New Cuboid with the specified coordinates as bounds

Parameters:

minX - min x coord

minY - min y coord

minZ - min z coord

maxX - max x coord

maxY - max y coord

maxZ - max z coord

Method Detail

add

public Cuboid add(Cuboid other)

Specified by:

add in class Operator<Cuboid,Cuboid>

add

public Cuboid add(org.apache.commons.math3.geometry.euclidean.threed.Vector3D other)

Adds a vector to the cuboid

Parameters:

other - The vector to add

Returns:

The new cuboid

add

public Cuboid add(double other)

Specified by:

add in class Operator<Cuboid,Cuboid>

$plus

public Cuboid $plus(org.apache.commons.math3.geometry.euclidean.threed.Vector3D other)

subtract

public Cuboid subtract(org.apache.commons.math3.geometry.euclidean.threed.Vector3D other)

$minus

public Cuboid $minus(org.apache.commons.math3.geometry.euclidean.threed.Vector3D other)

multiply

public Cuboid multiply(double other)

Specified by:

multiply in class Operator<Cuboid,Cuboid>

reciprocal

public Cuboid reciprocal()

Description copied from class: Operator

Gets the reciprocal of this vector. Any value of zero will cause a division by zero error.

Specified by:

reciprocal in class Operator<Cuboid,Cuboid>

Returns:

-describeme-

expand

public Cuboid expand(org.apache.commons.math3.geometry.euclidean.threed.Vector3D other)

Expands the cuboid by a certain vector.

Parameters:

other - Given vector

Returns:

New cuboid

expand

public Cuboid expand(double other)

Expands the cuboid by a certain amount.

Parameters:

other - The amount

Returns:

New cuboid

isCube

public boolean isCube()

Returns if this cuboid is a cube.

Returns:

If this cuboid is a cube.

size

public org.apache.commons.math3.geometry.euclidean.threed.Vector3D size()

How large the cuboid is

Returns:

The size of the cuboid

center

public org.apache.commons.math3.geometry.euclidean.threed.Vector3D center()

The center of the cuboid

Returns:

Vector representing the cuboid

volume

public double volume()

The volume of the cuboid

Returns:

The volume of the cuboid

surfaceArea

public double surfaceArea()

The surface area of the cuboid

Returns:

The surface area of the cuvoid

intersects

public boolean intersects(Cuboid other)

Checks if another cuboid is within this cuboid

Parameters:

other - Cuboid to check

Returns:

Result of the check

intersects

public boolean intersects(org.apache.commons.math3.geometry.euclidean.threed.Vector3D other)

Checks if a vector is within this cuboid.

Parameters:

other - Vector to check

Returns:

Result of the check

transform

public Cuboid transform(Transformer transform)

Applies the given transformer to the cuboid

Parameters:

transform - The transformer to apply

Returns:

The transformed cuboid

transform

public Cuboid transform(org.apache.commons.math3.geometry.euclidean.threed.Rotation transform)

Applies the given rotation to the Cuboid

Parameters:

transform - The rotation to apply

Returns:

The rotated cuboid

forEach

public void forEach(java.util.function.Consumer<org.apache.commons.math3.geometry.euclidean.threed.Vector3D> consumer)

forEach

public void forEach(java.util.function.Consumer<org.apache.commons.math3.geometry.euclidean.threed.Vector3D> consumer,
                    double step)

sideOf

public Direction sideOf(org.apache.commons.math3.geometry.euclidean.threed.Vector3D position)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object