org.dayflower.pathtracer.scene.compiler

Class DynamicCompiledScene

java.lang.Object

org.dayflower.pathtracer.scene.compiler.DynamicCompiledScene

public final class DynamicCompiledScene
extends java.lang.Object

A DynamicCompiledScene represents a dynamic and compiled version of a Scene instance.

The difference between a DynamicCompiledScene and a CompiledScene, is that the structures of the former are dynamic, whereas the structures of the latter are static.

A DynamicCompiledScene allows you to add new and update or remove existing structures. A structure may only be removed when no other structure is referencing it. When a new structure has been added, or an existing updated, pruning can be performed to automatically remove structures that are not referenced. To perform pruning, call prune().

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors

Constructor and Description
DynamicCompiledScene() Constructs a new DynamicCompiledScene instance.

Method Summary

Modifier and Type	Method and Description
int	add(Point2F point2F) Adds point2F to this DynamicCompiledScene instance.
int	add(Point3F point3F) Adds point3F to this DynamicCompiledScene instance.
int	add(Surface surface) Adds surface to this DynamicCompiledScene instance.
int	add(Texture texture) Adds texture to this DynamicCompiledScene instance.
int	add(Vector3F vector3F) Adds vector3F to this DynamicCompiledScene instance.
int	indexOf(Point2F point2F) Returns the index of point2F, or -1 if it does not exist.
int	indexOf(Point3F point3F) Returns the index of point3F, or -1 if it does not exist.
int	indexOf(Surface surface) Returns the index of surface, or -1 if it does not exist.
int	indexOf(Texture texture) Returns the index of texture, or -1 if it does not exist.
int	indexOf(Vector3F vector3F) Returns the index of vector3F, or -1 if it does not exist.
void	prune() Prunes the structures of this DynamicCompiledScene instance.
int	referencesTo(Point2F point2F) Returns the number of references to point2F.
int	referencesTo(Point3F point3F) Returns the number of references to point3F.
int	referencesTo(Surface surface) Returns the number of references to surface.
int	referencesTo(Texture texture) Returns the number of references to texture.
int	referencesTo(Vector3F vector3F) Returns the number of references to vector3F.
int	remove(Point2F point2F) Removes point2F from this DynamicCompiledScene instance, if it exists.
int	remove(Point3F point3F) Removes point3F from this DynamicCompiledScene instance, if it exists.
int	remove(Surface surface) Removes surface from this DynamicCompiledScene instance, if it exists.
int	remove(Texture texture) Removes texture from this DynamicCompiledScene instance, if it exists.
int	remove(Vector3F vector3F) Removes vector3F from this DynamicCompiledScene instance, if it exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicCompiledScene

public DynamicCompiledScene()

Constructs a new DynamicCompiledScene instance.

Method Detail

add

public int add(Point2F point2F)

Adds point2F to this DynamicCompiledScene instance.

Returns the index of point2F.

If point2F is null, a NullPointerException will be thrown.

Parameters:

point2F - the Point2F to add

Returns:

the index of point2F

Throws:

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

add

public int add(Point3F point3F)

Adds point3F to this DynamicCompiledScene instance.

Returns the index of point3F.

If point3F is null, a NullPointerException will be thrown.

Parameters:

point3F - the Point3F to add

Returns:

the index of point3F

Throws:

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

add

public int add(Surface surface)

Adds surface to this DynamicCompiledScene instance.

Returns the index of surface.

If surface is null, a NullPointerException will be thrown.

Parameters:

surface - the Surface to add

Returns:

the index of surface

Throws:

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

add

public int add(Texture texture)

Adds texture to this DynamicCompiledScene instance.

Returns the index of texture.

If texture is null, a NullPointerException will be thrown.

Parameters:

texture - the Texture to add

Returns:

the index of texture

Throws:

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

add

public int add(Vector3F vector3F)

Adds vector3F to this DynamicCompiledScene instance.

Returns the index of vector3F.

If vector3F is null, a NullPointerException will be thrown.

Parameters:

vector3F - the Vector3F to add

Returns:

the index of vector3F

Throws:

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

indexOf

public int indexOf(Point2F point2F)

Returns the index of point2F, or -1 if it does not exist.

If point2F is null, a NullPointerException will be thrown.

Parameters:

point2F - the Point2F to check

Returns:

the index of point2F, or -1 if it does not exist

Throws:

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

indexOf

public int indexOf(Point3F point3F)

Returns the index of point3F, or -1 if it does not exist.

If point3F is null, a NullPointerException will be thrown.

Parameters:

point3F - the Point3F to check

Returns:

the index of point3F, or -1 if it does not exist

Throws:

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

indexOf

public int indexOf(Surface surface)

Returns the index of surface, or -1 if it does not exist.

If surface is null, a NullPointerException will be thrown.

Parameters:

surface - the Surface to check

Returns:

the index of surface, or -1 if it does not exist

Throws:

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

indexOf

public int indexOf(Texture texture)

Returns the index of texture, or -1 if it does not exist.

If texture is null, a NullPointerException will be thrown.

Parameters:

texture - the Texture to check

Returns:

the index of texture, or -1 if it does not exist

Throws:

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

indexOf

public int indexOf(Vector3F vector3F)

Returns the index of vector3F, or -1 if it does not exist.

If vector3F is null, a NullPointerException will be thrown.

Parameters:

vector3F - the Vector3F to check

Returns:

the index of vector3F, or -1 if it does not exist

Throws:

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

referencesTo

public int referencesTo(Point2F point2F)

Returns the number of references to point2F.

If point2F is null, a NullPointerException will be thrown.

Parameters:

point2F - a Point2F

Returns:

the number of references to point2F

Throws:

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

referencesTo

public int referencesTo(Point3F point3F)

Returns the number of references to point3F.

If point3F is null, a NullPointerException will be thrown.

Parameters:

point3F - a Point3F

Returns:

the number of references to point3F

Throws:

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

referencesTo

public int referencesTo(Surface surface)

Returns the number of references to surface.

If surface is null, a NullPointerException will be thrown.

Parameters:

surface - a Surface

Returns:

the number of references to surface

Throws:

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

referencesTo

public int referencesTo(Texture texture)

Returns the number of references to texture.

If texture is null, a NullPointerException will be thrown.

Parameters:

texture - a Texture

Returns:

the number of references to texture

Throws:

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

referencesTo

public int referencesTo(Vector3F vector3F)

Returns the number of references to vector3F.

If vector3F is null, a NullPointerException will be thrown.

Parameters:

vector3F - a Vector3F

Returns:

the number of references to vector3F

Throws:

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

remove

public int remove(Point2F point2F)

Removes point2F from this DynamicCompiledScene instance, if it exists.

Returns the index of point2F, or -1 if it does not exist.

If point2F is null, a NullPointerException will be thrown.

Parameters:

point2F - the Point3F to remove

Returns:

the index of point2F, or -1 if it does not exist

Throws:

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

remove

public int remove(Point3F point3F)

Removes point3F from this DynamicCompiledScene instance, if it exists.

Returns the index of point3F, or -1 if it does not exist.

If point3F is null, a NullPointerException will be thrown.

Parameters:

point3F - the Point3F to remove

Returns:

the index of point3F, or -1 if it does not exist

Throws:

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

remove

public int remove(Surface surface)

Removes surface from this DynamicCompiledScene instance, if it exists.

Returns the index of surface, or -1 if it does not exist.

If surface is null, a NullPointerException will be thrown.

Parameters:

surface - the Surface to remove

Returns:

the index of surface, or -1 if it does not exist

Throws:

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

remove

public int remove(Texture texture)

Removes texture from this DynamicCompiledScene instance, if it exists.

Returns the index of texture, or -1 if it does not exist.

If texture is null, a NullPointerException will be thrown.

Parameters:

texture - the Texture to remove

Returns:

the index of texture, or -1 if it does not exist

Throws:

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

remove

public int remove(Vector3F vector3F)

Removes vector3F from this DynamicCompiledScene instance, if it exists.

Returns the index of vector3F, or -1 if it does not exist.

If vector3F is null, a NullPointerException will be thrown.

Parameters:

vector3F - the Vector3F to remove

Returns:

the index of vector3F, or -1 if it does not exist

Throws:

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

prune

public void prune()

Prunes the structures of this DynamicCompiledScene instance.

The pruning process consists of removing structures that are currently not referenced from other structures.

Some structures cannot be referenced from other structures, so these will not be pruned.

In some cases, a flag has been associated with a given structure, indicating that the structure should be exempt from pruning. These structures are usually materials or textures that can be switched between.