org.dayflower.pathtracer.scene.loader

Class SceneLoader

java.lang.Object

org.dayflower.pathtracer.scene.loader.SceneLoader

public final class SceneLoader
extends java.lang.Object

A class that loads Scenes and CompiledScenes.

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors

Constructor and Description
SceneLoader() Constructs a new SceneLoader instance.
SceneLoader(java.io.File directory) Constructs a new SceneLoader instance.
SceneLoader(java.io.File directory, boolean isCompilingExistingScene) Constructs a new SceneLoader instance.
SceneLoader(java.io.File directory, boolean isCompilingExistingScene, java.lang.String name) Constructs a new SceneLoader instance.

Method Summary

Modifier and Type	Method and Description
java.io.File	getDirectory() Returns a File with the root directory.
java.lang.String	getName() Returns the scene name.
boolean	isCompilingExistingScene() Returns true if, and only if, compilation of existing scene is enabled, false otherwise.
CompiledScene	loadCompiledScene() Returns a CompiledScene given the name provided by getName().
Scene	loadScene() Returns a Scene given the name provided by getName().
void	setName(java.lang.String name) Sets the scene name.

Methods inherited from class java.lang.Object

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

Constructor Detail

SceneLoader

public SceneLoader()

Constructs a new SceneLoader instance.

Calling this constructor is equivalent to new SceneLoader(new File(".")).

SceneLoader

public SceneLoader(java.io.File directory)

Constructs a new SceneLoader instance.

Calling this constructor is equivalent to new SceneLoader(directory, false).

If directory is null, a NullPointerException will be thrown.

Parameters:

directory - the root directory to use

Throws:

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

SceneLoader

public SceneLoader(java.io.File directory,
                   boolean isCompilingExistingScene)

Constructs a new SceneLoader instance.

Calling this constructor is equivalent to new SceneLoader(directory, isCompilingExistingScene, "Material_Showcase_Scene").

If directory is null, a NullPointerException will be thrown.

Parameters:

directory - the root directory to use

isCompilingExistingScene - true if, and only if, compilation should be performed if the scene has already been compiled, false otherwise

Throws:

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

SceneLoader

public SceneLoader(java.io.File directory,
                   boolean isCompilingExistingScene,
                   java.lang.String name)

Constructs a new SceneLoader instance.

If either directory or name are null, a NullPointerException will be thrown.

Parameters:

directory - the root directory to use

isCompilingExistingScene - true if, and only if, compilation should be performed if the scene has already been compiled, false otherwise

name - the name of the scene

Throws:

java.lang.NullPointerException - thrown if, and only if, either directory or name are null

Method Detail

loadCompiledScene

public CompiledScene loadCompiledScene()

Returns a CompiledScene given the name provided by getName().

Returns:

a CompiledScene given the name provided by getName()

getDirectory

public java.io.File getDirectory()

Returns a File with the root directory.

Returns:

a File with the root directory

loadScene

public Scene loadScene()

Returns a Scene given the name provided by getName().

Returns:

a Scene given the name provided by getName()

getName

public java.lang.String getName()

Returns the scene name.

Returns:

the scene name

isCompilingExistingScene

public boolean isCompilingExistingScene()

Returns true if, and only if, compilation of existing scene is enabled, false otherwise.

Returns:

true if, and only if, compilation of existing scene is enabled, false otherwise

setName

public void setName(java.lang.String name)

Sets the scene name.

If name is null, a NullPointerException will be thrown.

Parameters:

name - the new scene name

Throws:

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