org.dayflower.pathtracer.scene.compiler

Class CompiledScene

java.lang.Object

org.dayflower.pathtracer.scene.compiler.CompiledScene

public final class CompiledScene
extends java.lang.Object

A CompiledScene represents a compiled version of a Scene instance.

To compile a Scene into a CompiledScene, use SceneCompiler and its compile(Scene) method.

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors

Constructor and Description
CompiledScene(java.lang.String name, float[] camera, float[] point2Fs, float[] point3Fs, float[] spheres, float[] surfaces, float[] terrains, float[] textures, float[] vector3Fs, int[] boundingVolumeHierarchies, int[] planes, int[] primitives, int[] primitivesEmittingLight, int[] triangles) Constructs a new CompiledScene instance.

Method Summary

Modifier and Type	Method and Description
int[]	getBoundingVolumeHierarchies() Returns the array containing all the compiled BoundingVolumeHierarchy instances.
float[]	getCamera() Returns the array containing the compiled Camera instance.
java.lang.String	getName() Returns the name of this CompiledScene instance.
int[]	getPlanes() Returns the array containing all the compiled Plane instances.
float[]	getPoint2Fs() Returns the array containing all the compiled Point2F instances.
float[]	getPoint3Fs() Returns the array containing all the compiled Point3F instances.
int[]	getPrimitives() Returns the array containing all the compiled Primitive instances.
int[]	getPrimitivesEmittingLight() Returns the array containing all the compiled Primitive instances that emits light.
float[]	getSpheres() Returns the array containing all the compiled Sphere instances.
float[]	getSurfaces() Returns the array containing all the compiled Surface instances.
float[]	getTerrains() Returns the array containing all the compiled Terrain instances.
float[]	getTextures() Returns the array containing all the compiled Texture instances.
int[]	getTriangles() Returns the array containing all the compiled Triangle instances.
float[]	getVector3Fs() Returns the array containing all the compiled Vector3F instances.
static CompiledScene	read(java.io.DataInputStream dataInputStream) Reads the data provided by dataInputStream into a CompiledScene instance.
static CompiledScene	read(java.io.File file) Reads the data provided by a file represented by file into a CompiledScene instance.
static CompiledScene	read(java.lang.String filename) Reads the data provided by a file represented by filename into a CompiledScene instance.
void	write(java.io.DataOutputStream dataOutputStream) Writes this CompiledScene instance to dataOutputStream.
void	write(java.io.File file) Writes this CompiledScene instance to the file represented by file.
void	write(java.lang.String filename) Writes this CompiledScene instance to the file represented by filename.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompiledScene

public CompiledScene(java.lang.String name,
                     float[] camera,
                     float[] point2Fs,
                     float[] point3Fs,
                     float[] spheres,
                     float[] surfaces,
                     float[] terrains,
                     float[] textures,
                     float[] vector3Fs,
                     int[] boundingVolumeHierarchies,
                     int[] planes,
                     int[] primitives,
                     int[] primitivesEmittingLight,
                     int[] triangles)

Constructs a new CompiledScene instance.

If at least one of the parameters are null, a NullPointerException will be thrown.

Parameters:

name - the name of this CompiledScene instance

camera - the array containing the compiled Camera instance

point2Fs - the array containing all the compiled Point2F instances

point3Fs - the array containing all the compiled Point3F instances

spheres - the array containing all the compiled Sphere instances

surfaces - the array containing all the compiled Surface instances

terrains - the array containing all the compiled Terrain instances

textures - the array containing all the compiled Texture instances

vector3Fs - the array containing all the compiled Vector3F instances

boundingVolumeHierarchies - the array containing all the compiled BoundingVolumeHierarchy instances

planes - the array containing all the compiled Plane instances

primitives - the array containing all the compiled Primitive instances

primitivesEmittingLight - the array containing all the compiled Primitive instances that emits light

triangles - the array containing all the compiled Triangle instances

Throws:

java.lang.NullPointerException - thrown if, and only if, at least one of the parameters are null

Method Detail

getName

public java.lang.String getName()

Returns the name of this CompiledScene instance.

Returns:

the name of this CompiledScene instance

getCamera

public float[] getCamera()

Returns the array containing the compiled Camera instance.

Returns:

the array containing the compiled Camera instance

getPoint2Fs

public float[] getPoint2Fs()

Returns the array containing all the compiled Point2F instances.

Returns:

the array containing all the compiled Point2F instances

getPoint3Fs

public float[] getPoint3Fs()

Returns the array containing all the compiled Point3F instances.

Returns:

the array containing all the compiled Point3F instances

getSpheres

public float[] getSpheres()

Returns the array containing all the compiled Sphere instances.

Returns:

the array containing all the compiled Sphere instances

getSurfaces

public float[] getSurfaces()

Returns the array containing all the compiled Surface instances.

Returns:

the array containing all the compiled Surface instances

getTerrains

public float[] getTerrains()

Returns the array containing all the compiled Terrain instances.

Returns:

the array containing all the compiled Terrain instances

getTextures

public float[] getTextures()

Returns the array containing all the compiled Texture instances.

Returns:

the array containing all the compiled Texture instances

getVector3Fs

public float[] getVector3Fs()

Returns the array containing all the compiled Vector3F instances.

Returns:

the array containing all the compiled Vector3F instances

getBoundingVolumeHierarchies

public int[] getBoundingVolumeHierarchies()

Returns the array containing all the compiled BoundingVolumeHierarchy instances.

Returns:

the array containing all the compiled BoundingVolumeHierarchy instances

getPlanes

public int[] getPlanes()

Returns the array containing all the compiled Plane instances.

Returns:

the array containing all the compiled Plane instances

getPrimitives

public int[] getPrimitives()

Returns the array containing all the compiled Primitive instances.

Returns:

the array containing all the compiled Primitive instances

getPrimitivesEmittingLight

public int[] getPrimitivesEmittingLight()

Returns the array containing all the compiled Primitive instances that emits light.

Returns:

the array containing all the compiled Primitive instances that emits light

getTriangles

public int[] getTriangles()

Returns the array containing all the compiled Triangle instances.

Returns:

the array containing all the compiled Triangle instances

write

public void write(java.io.DataOutputStream dataOutputStream)

Writes this CompiledScene instance to dataOutputStream.

If dataOutputStream is null, a NullPointerException will be thrown.

If an I/O error occurs, an UncheckedIOException will be thrown.

Parameters:

dataOutputStream - the DataOutputStream to write to

Throws:

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

java.io.UncheckedIOException - thrown if, and only if, an I/O error occurs

write

public void write(java.io.File file)

Writes this CompiledScene instance to the file represented by file.

If file is null, a NullPointerException will be thrown.

If an I/O error occurs, an UncheckedIOException will be thrown.

Parameters:

file - a File representation of the file to write to

Throws:

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

java.io.UncheckedIOException - thrown if, and only if, an I/O error occurs

write

public void write(java.lang.String filename)

Writes this CompiledScene instance to the file represented by filename.

If filename is null, a NullPointerException will be thrown.

If an I/O error occurs, an UncheckedIOException will be thrown.

Parameters:

filename - the filename of the file to write to

Throws:

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

java.io.UncheckedIOException - thrown if, and only if, an I/O error occurs

read

public static CompiledScene read(java.io.DataInputStream dataInputStream)

Reads the data provided by dataInputStream into a CompiledScene instance.

Returns a new CompiledScene instance.

If dataInputStream is null, a NullPointerException will be thrown.

If an I/O error occurs, an UncheckedIOException will be thrown.

Parameters:

dataInputStream - the DataInputStream to read from

Returns:

a new CompiledScene instance

Throws:

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

java.io.UncheckedIOException - thrown if, and only if, an I/O error occurs

read

public static CompiledScene read(java.io.File file)

Reads the data provided by a file represented by file into a CompiledScene instance.

Returns a new CompiledScene instance.

If file is null, a NullPointerException will be thrown.

If an I/O error occurs, an UncheckedIOException will be thrown.

Parameters:

file - a File representation of the file to read from

Returns:

a new CompiledScene instance

Throws:

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

java.io.UncheckedIOException - thrown if, and only if, an I/O error occurs

read

public static CompiledScene read(java.lang.String filename)

Reads the data provided by a file represented by filename into a CompiledScene instance.

Returns a new CompiledScene instance.

If filename is null, a NullPointerException will be thrown.

If an I/O error occurs, an UncheckedIOException will be thrown.

Parameters:

filename - the filename of the file to read from

Returns:

a new CompiledScene instance

Throws:

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

java.io.UncheckedIOException - thrown if, and only if, an I/O error occurs