org.dayflower.pathtracer.scene.bvh

Class BoundingVolumeHierarchy.LeafNode

java.lang.Object

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

org.dayflower.pathtracer.scene.bvh.BoundingVolumeHierarchy.LeafNode

Enclosing class:

BoundingVolumeHierarchy

public static final class BoundingVolumeHierarchy.LeafNode
extends BoundingVolumeHierarchy.Node

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

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addBounds(java.util.Collection<Point3F> point3Fs) Adds the maximum and minimum bounds to point3Fs.
void	addTriangle(Triangle triangle) Adds triangle to this LeafNode instance.
boolean	equals(java.lang.Object object) Compares object to this LeafNode instance for equality.
int	getSize() Returns the size of this LeafNode instance.
java.util.List<Triangle>	getTriangles() Returns a List with the Triangles currently added.
int	hashCode() Returns a hash code for this LeafNode instance.
boolean	isLeaf() Returns true.
void	removeTriangle(Triangle triangle) Removes triangle from this LeafNode instance.
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 LeafNode instance.
java.lang.String	toString(int indentation) Returns a String representation of this LeafNode 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

LeafNode

public LeafNode(int depth)

Constructs a new LeafNode instance.

Parameters:

depth - the depth of this LeafNode

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

getTriangles

public java.util.List<Triangle> getTriangles()

Returns a List with the Triangles currently added.

Modifying the returned List will affect this LeafNode instance.

Returns:

a List with the Triangles currently added

toString

public java.lang.String toString()

Returns a String representation of this LeafNode instance.

Calling this method is equivalent to toString(0).

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this LeafNode instance

toString

public java.lang.String toString(int indentation)

Returns a String representation of this LeafNode instance.

Specified by:

toString in class BoundingVolumeHierarchy.Node

Parameters:

indentation - the number of indentations to use

Returns:

a String representation of this LeafNode instance

equals

public boolean equals(java.lang.Object object)

Compares object to this LeafNode instance for equality.

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

Overrides:

equals in class java.lang.Object

Parameters:

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

Returns:

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

isLeaf

public boolean isLeaf()

Returns true.

Specified by:

isLeaf in class BoundingVolumeHierarchy.Node

Returns:

true

getSize

public int getSize()

Returns the size of this LeafNode instance.

Specified by:

getSize in class BoundingVolumeHierarchy.Node

Returns:

the size of this LeafNode instance

hashCode

public int hashCode()

Returns a hash code for this LeafNode instance.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this LeafNode 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

addTriangle

public void addTriangle(Triangle triangle)

Adds triangle to this LeafNode instance.

If triangle is null, a NullPointerException will be thrown.

Parameters:

triangle - the Triangle to add

Throws:

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

removeTriangle

public void removeTriangle(Triangle triangle)

Removes triangle from this LeafNode instance.

If triangle is null, a NullPointerException will be thrown.

Parameters:

triangle - the Triangle to remove

Throws:

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