org.dayflower.pathtracer.scene.bvh

Class BoundingVolumeHierarchy.TreeNode

java.lang.Object

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

org.dayflower.pathtracer.scene.bvh.BoundingVolumeHierarchy.TreeNode

Enclosing class:

BoundingVolumeHierarchy

public static final class BoundingVolumeHierarchy.TreeNode
extends BoundingVolumeHierarchy.Node

A TreeNode is a BoundingVolumeHierarchy.Node implementation that represents a tree node in a Bounding Volume Hierarchy (BVH).

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors

Constructor and Description
TreeNode(int depth) Constructs a new TreeNode instance.

Method Summary

Modifier and Type	Method and Description
void	addBounds(java.util.Collection<Point3F> point3Fs) Adds the maximum and minimum bounds to point3Fs.
boolean	equals(java.lang.Object object) Compares object to this TreeNode instance for equality.
java.util.Optional<BoundingVolumeHierarchy.Node>	getLeft() Returns an Optional with the optional left BoundingVolumeHierarchy.Node.
java.util.Optional<BoundingVolumeHierarchy.Node>	getRight() Returns an Optional with the optional right BoundingVolumeHierarchy.Node.
int	getSize() Returns the size of this TreeNode instance.
int	hashCode() Returns a hash code for this TreeNode instance.
boolean	isLeaf() Returns false.
void	setLeft(BoundingVolumeHierarchy.Node left) Sets the left BoundingVolumeHierarchy.Node.
void	setRight(BoundingVolumeHierarchy.Node right) Sets the right BoundingVolumeHierarchy.Node.
java.util.List<BoundingVolumeHierarchy.Node>	toList(java.util.List<BoundingVolumeHierarchy.Node> nodes) Returns a List with all Nodes added in a depth-first order.
java.lang.String	toString() Returns a String representation of this TreeNode instance.
java.lang.String	toString(int indentation) Returns a String representation of this TreeNode instance.

Methods inherited from class org.dayflower.pathtracer.scene.bvh.BoundingVolumeHierarchy.Node

getCenter, getCenterX, getCenterY, getCenterZ, getDepth, getMaximum, getMaximumX, getMaximumY, getMaximumZ, getMinimum, getMinimumX, getMinimumY, getMinimumZ, setMaximum, setMinimum, toList

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TreeNode

public TreeNode(int depth)

Constructs a new TreeNode instance.

Parameters:

depth - the depth of this TreeNode

Method Detail

toList

public 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.

Specified by:

toList in class BoundingVolumeHierarchy.Node

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

getLeft

public java.util.Optional<BoundingVolumeHierarchy.Node> getLeft()

Returns an Optional with the optional left BoundingVolumeHierarchy.Node.

Returns:

an Optional with the optional left Node

getRight

public java.util.Optional<BoundingVolumeHierarchy.Node> getRight()

Returns an Optional with the optional right BoundingVolumeHierarchy.Node.

Returns:

an Optional with the optional right Node

toString

public java.lang.String toString()

Returns a String representation of this TreeNode instance.

Calling this method is equivalent to toString(0).

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this TreeNode instance

toString

public java.lang.String toString(int indentation)

Returns a String representation of this TreeNode instance.

Specified by:

toString in class BoundingVolumeHierarchy.Node

Parameters:

indentation - the number of indentations to use

Returns:

a String representation of this TreeNode instance

equals

public boolean equals(java.lang.Object object)

Compares object to this TreeNode instance for equality.

Returns true if, and only if, object is an instance of TreeNode, and their respective values are equal, false otherwise.

Overrides:

equals in class java.lang.Object

Parameters:

object - the Object to compare to this TreeNode instance for equality

Returns:

true if, and only if, object is an instance of TreeNode, and their respective values are equal, false otherwise

isLeaf

public boolean isLeaf()

Returns false.

Specified by:

isLeaf in class BoundingVolumeHierarchy.Node

Returns:

false

getSize

public int getSize()

Returns the size of this TreeNode instance.

Specified by:

getSize in class BoundingVolumeHierarchy.Node

Returns:

the size of this TreeNode instance

hashCode

public int hashCode()

Returns a hash code for this TreeNode instance.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this TreeNode instance

addBounds

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

Adds the maximum and minimum bounds to point3Fs.

If point3Fs is null, a NullPointerException will be thrown.

Specified by:

addBounds in class BoundingVolumeHierarchy.Node

Parameters:

point3Fs - a Collection of Point3Fs

Throws:

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

setLeft

public void setLeft(BoundingVolumeHierarchy.Node left)

Sets the left BoundingVolumeHierarchy.Node.

Parameters:

left - the left Node, which may be null

setRight

public void setRight(BoundingVolumeHierarchy.Node right)

Sets the right BoundingVolumeHierarchy.Node.

Parameters:

right - the right Node, which may be null