org.dayflower.pathtracer.scene

Class Scene

java.lang.Object

org.dayflower.pathtracer.scene.Scene

public final class Scene
extends java.lang.Object

A Scene contains various Shapes and Textures.

This class is mutable and therefore not suitable for concurrent use without external synchronization.

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors

Constructor and Description
Scene(java.lang.String name) Constructs a new empty Scene instance.

Method Summary

Modifier and Type	Method and Description
void	addPrimitive(Primitive primitive) Adds primitive to this Scene instance.
void	addPrimitives(java.util.Collection<Primitive> primitives) Adds all Primitives in primitives to this Scene instance.
Camera	getCamera() Returns the Camera instance used by this Scene instance.
java.lang.String	getName() Returns the name of this Scene instance.
java.util.List<Primitive>	getPrimitives() Returns a List with all currently added Primitives.
Sky	getSky() Returns the Sky instance used by this Scene instance.
void	removePrimitive(Primitive primitive) Removes primitive from this Scene instance.
void	removePrimitives(java.util.Collection<Primitive> primitives) Removes all Primitives in primitives from this Scene instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Scene

public Scene(java.lang.String name)

Constructs a new empty Scene instance.

If name is null, a NullPointerException will be thrown.

Parameters:

name - the name of this Scene

Throws:

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

Method Detail

getCamera

public Camera getCamera()

Returns the Camera instance used by this Scene instance.

Returns:

the Camera instance used by this Scene instance

getPrimitives

public java.util.List<Primitive> getPrimitives()

Returns a List with all currently added Primitives.

Modifying the returned List will not affect this Scene instance.

Returns:

a List with all currently added Primitives

getSky

public Sky getSky()

Returns the Sky instance used by this Scene instance.

Returns:

the Sky instance used by this Scene instance

getName

public java.lang.String getName()

Returns the name of this Scene instance.

Returns:

the name of this Scene instance

addPrimitive

public void addPrimitive(Primitive primitive)

Adds primitive to this Scene instance.

If primitive is null, a NullPointerException will be thrown.

Parameters:

primitive - the Primitive to add

Throws:

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

addPrimitives

public void addPrimitives(java.util.Collection<Primitive> primitives)

Adds all Primitives in primitives to this Scene instance.

If either primitives or a Primitive in primitives are null, a NullPointerException will be thrown.

Parameters:

primitives - the Primitives to add

Throws:

java.lang.NullPointerException - thrown if, and only if, either primitives or a Primitive in primitives are null

removePrimitive

public void removePrimitive(Primitive primitive)

Removes primitive from this Scene instance.

If primitive is null, a NullPointerException will be thrown.

Parameters:

primitive - the Primitive to remove

Throws:

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

removePrimitives

public void removePrimitives(java.util.Collection<Primitive> primitives)

Removes all Primitives in primitives from this Scene instance.

If either primitives or a Primitive in primitives are null, a NullPointerException will be thrown.

Parameters:

primitives - the Primitives to remove

Throws:

java.lang.NullPointerException - thrown if, and only if, either primitives or a Primitive in primitives are null