org.dayflower.pathtracer.scene.bvh

Class BoundingVolumeHierarchy.Node

java.lang.Object

org.dayflower.pathtracer.scene.bvh.BoundingVolumeHierarchy.Node

Direct Known Subclasses:

BoundingVolumeHierarchy.LeafNode, BoundingVolumeHierarchy.TreeNode

Enclosing class:

BoundingVolumeHierarchy

public abstract static class BoundingVolumeHierarchy.Node
extends java.lang.Object

A Node is an abstract base type used to represent a node in a Bounding Volume Hierarchy (BVH).

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Node(int depth) Constructs a new Node instance.

Method Summary

Modifier and Type	Method and Description
abstract void	addBounds(java.util.Collection<Point3F> point3Fs) Adds the maximum and minimum bounds to point3Fs.
Point3F	getCenter() Returns a Point3F with the center of the bounds of this Node instance.
float	getCenterX() Returns the X-coordinate of the center of the bounds of this Node instance.
float	getCenterY() Returns the Y-coordinate of the center of the bounds of this Node instance.
float	getCenterZ() Returns the Z-coordinate of the center of the bounds of this Node instance.
int	getDepth() Returns the depth of this Node instance.
Point3F	getMaximum() Returns a Point3F with the maximum bound of this Node instance.
float	getMaximumX() Returns the X-coordinate of the maximum bound of this Node instance.
float	getMaximumY() Returns the Y-coordinate of the maximum bound of this Node instance.
float	getMaximumZ() Returns the Z-coordinate of the maximum bound of this Node instance.
Point3F	getMinimum() Returns a Point3F with the minimum bound of this Node instance.
float	getMinimumX() Returns the X-coordinate of the minimum bound of this Node instance.
float	getMinimumY() Returns the Y-coordinate of the minimum bound of this Node instance.
float	getMinimumZ() Returns the Z-coordinate of the minimum bound of this Node instance.
abstract int	getSize() Returns the size of this Node instance.
abstract boolean	isLeaf() Returns true if, and only if, this Node is a leaf node, false otherwise.
void	setMaximum(float maximumX, float maximumY, float maximumZ) Sets the maximum bound for this Node instance.
void	setMinimum(float minimumX, float minimumY, float minimumZ) Sets the minimum bound for this Node instance.
java.util.List<BoundingVolumeHierarchy.Node>	toList() Returns a List with all Nodes added in a depth-first order.
abstract java.util.List<BoundingVolumeHierarchy.Node>	toList(java.util.List<BoundingVolumeHierarchy.Node> nodes) Returns a List with all Nodes added in a depth-first order.
abstract java.lang.String	toString(int indentation) Returns a String representation of this Node instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Node

protected Node(int depth)

Constructs a new Node instance.

Parameters:

depth - the depth of this Node

Method Detail

toList

public final java.util.List<BoundingVolumeHierarchy.Node> toList()

Returns a List with all Nodes added in a depth-first order.

Calling this method is equivalent to toList(new ArrayList<>()).

Returns:

a List with all Nodes added in a depth-first order

toList

public abstract java.util.List<BoundingVolumeHierarchy.Node> toList(java.util.List<BoundingVolumeHierarchy.Node> nodes)

Returns a List with all Nodes added in a depth-first order.

If nodes is null, a NullPointerException will be thrown.

Parameters:

nodes - the List to add Nodes to and return

Returns:

a List with all Nodes added in a depth-first order

Throws:

java.lang.NullPointerException - thrown if, and only if, nodes is null

getCenter

public final Point3F getCenter()

Returns a Point3F with the center of the bounds of this Node instance.

Returns:

a Point3F with the center of the bounds of this Node instance

getMaximum

public final Point3F getMaximum()

Returns a Point3F with the maximum bound of this Node instance.

Returns:

a Point3F with the maximum bound of this Node instance

getMinimum

public final Point3F getMinimum()

Returns a Point3F with the minimum bound of this Node instance.

Returns:

a Point3F with the minimum bound of this Node instance

toString

public abstract java.lang.String toString(int indentation)

Returns a String representation of this Node instance.

Parameters:

indentation - the number of indentations to use

Returns:

a String representation of this Node instance

isLeaf

public abstract boolean isLeaf()

Returns true if, and only if, this Node is a leaf node, false otherwise.

Returns:

true if, and only if, this Node is a leaf node, false otherwise

getCenterX

public final float getCenterX()

Returns the X-coordinate of the center of the bounds of this Node instance.

Returns:

the X-coordinate of the center of the bounds of this Node instance

getCenterY

public final float getCenterY()

Returns the Y-coordinate of the center of the bounds of this Node instance.

Returns:

the Y-coordinate of the center of the bounds of this Node instance

getCenterZ

public final float getCenterZ()

Returns the Z-coordinate of the center of the bounds of this Node instance.

Returns:

the Z-coordinate of the center of the bounds of this Node instance

getMaximumX

public final float getMaximumX()

Returns the X-coordinate of the maximum bound of this Node instance.

Returns:

the X-coordinate of the maximum bound of this Node instance

getMaximumY

public final float getMaximumY()

Returns the Y-coordinate of the maximum bound of this Node instance.

Returns:

the Y-coordinate of the maximum bound of this Node instance

getMaximumZ

public final float getMaximumZ()

Returns the Z-coordinate of the maximum bound of this Node instance.

Returns:

the Z-coordinate of the maximum bound of this Node instance

getMinimumX

public final float getMinimumX()

Returns the X-coordinate of the minimum bound of this Node instance.

Returns:

the X-coordinate of the minimum bound of this Node instance

getMinimumY

public final float getMinimumY()

Returns the Y-coordinate of the minimum bound of this Node instance.

Returns:

the Y-coordinate of the minimum bound of this Node instance

getMinimumZ

public final float getMinimumZ()

Returns the Z-coordinate of the minimum bound of this Node instance.

Returns:

the Z-coordinate of the minimum bound of this Node instance

getDepth

public final int getDepth()

Returns the depth of this Node instance.

Returns:

the depth of this Node instance

getSize

public abstract int getSize()

Returns the size of this Node instance.

Returns:

the size of this Node instance

addBounds

public abstract void addBounds(java.util.Collection<Point3F> point3Fs)

Adds the maximum and minimum bounds to point3Fs.

If point3Fs is null, a NullPointerException will be thrown.

Parameters:

point3Fs - a Collection of Point3Fs

Throws:

java.lang.NullPointerException - thrown if, and only if, point3Fs is null

setMaximum

public final void setMaximum(float maximumX,
                             float maximumY,
                             float maximumZ)

Sets the maximum bound for this Node instance.

Parameters:

maximumX - the X-coordinate of the maximum bound

maximumY - the Y-coordinate of the maximum bound

maximumZ - the Z-coordinate of the maximum bound

setMinimum

public final void setMinimum(float minimumX,
                             float minimumY,
                             float minimumZ)

Sets the minimum bound for this Node instance.

Parameters:

minimumX - the X-coordinate of the minimum bound

minimumY - the Y-coordinate of the minimum bound

minimumZ - the Z-coordinate of the minimum bound