org.dayflower.pathtracer.scene.bvh

Class BoundingVolumeHierarchy

java.lang.Object

org.dayflower.pathtracer.scene.bvh.BoundingVolumeHierarchy

public final class BoundingVolumeHierarchy
extends java.lang.Object

A BoundingVolumeHierarchy is an implementation of an acceleration structure called a Bounding Volume Hierarchy (BVH).

Since:

1.0.0

Author:

Jörgen Lundgren

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoundingVolumeHierarchy.LeafNode A LeafNode is a BoundingVolumeHierarchy.Node implementation that represents a leaf node in a Bounding Volume Hierarchy (BVH).
static class	BoundingVolumeHierarchy.Node A Node is an abstract base type used to represent a node in a Bounding Volume Hierarchy (BVH).
static class	BoundingVolumeHierarchy.TreeNode A TreeNode is a BoundingVolumeHierarchy.Node implementation that represents a tree node in a Bounding Volume Hierarchy (BVH).

Field Summary

Fields

Modifier and Type	Field and Description
static int	NODE_TYPE_LEAF The type number associated with a BoundingVolumeHierarchy.LeafNode.
static int	NODE_TYPE_TREE The type number associated with a BoundingVolumeHierarchy.TreeNode.

Method Summary

Modifier and Type	Method and Description
static BoundingVolumeHierarchy	createBoundingVolumeHierarchy(java.util.List<Triangle> triangles) Creates a BoundingVolumeHierarchy based on a List of Triangles.
boolean	equals(java.lang.Object object) Compares object to this BoundingVolumeHierarchy instance for equality.
BoundingVolumeHierarchy.Node	getRoot() Returns the root BoundingVolumeHierarchy.Node of this BoundingVolumeHierarchy instance.
int	hashCode() Returns a hash code for this BoundingVolumeHierarchy instance.

Methods inherited from class java.lang.Object

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

Field Detail

NODE_TYPE_LEAF

public static final int NODE_TYPE_LEAF

The type number associated with a BoundingVolumeHierarchy.LeafNode. The number is 2.

See Also:

Constant Field Values

NODE_TYPE_TREE

public static final int NODE_TYPE_TREE

The type number associated with a BoundingVolumeHierarchy.TreeNode. The number is 1.

See Also:

Constant Field Values

Method Detail

getRoot

public BoundingVolumeHierarchy.Node getRoot()

Returns the root BoundingVolumeHierarchy.Node of this BoundingVolumeHierarchy instance.

Returns:

the root Node of this BoundingVolumeHierarchy instance

equals

public boolean equals(java.lang.Object object)

Compares object to this BoundingVolumeHierarchy instance for equality.

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

Overrides:

equals in class java.lang.Object

Parameters:

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

Returns:

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

hashCode

public int hashCode()

Returns a hash code for this BoundingVolumeHierarchy instance.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this BoundingVolumeHierarchy instance

createBoundingVolumeHierarchy

public static BoundingVolumeHierarchy createBoundingVolumeHierarchy(java.util.List<Triangle> triangles)

Creates a BoundingVolumeHierarchy based on a List of Triangles.

Returns a BoundingVolumeHierarchy instance.

If either triangles or at least one Triangle in triangles are null, a NullPointerException will be thrown.

Parameters:

triangles - the Triangles to create the BoundingVolumeHierarchy from

Returns:

a BoundingVolumeHierarchy instance

Throws:

java.lang.NullPointerException - thrown if, and only if, either triangles or at least one Triangle in triangles are null