org.dayflower.pathtracer.scene.wavefront

Class ObjectLoader

java.lang.Object

org.dayflower.pathtracer.scene.wavefront.ObjectLoader

public final class ObjectLoader
extends java.lang.Object

This ObjectLoader class is used for loading Wavefront Object (.obj) models into Primitive instances.

Since:

1.0.0

Author:

Jörgen Lundgren

Method Summary

Modifier and Type	Method and Description
static java.util.List<Primitive>	load(java.io.File file) Loads a Wavefront Object (.obj) model.
static java.util.List<Primitive>	load(java.io.File file, float scale) Loads a Wavefront Object (.obj) model.
static java.util.List<Primitive>	load(java.io.File file, float scale, java.util.function.BiFunction<java.lang.String,java.lang.String,Surface> surfaceMapper) Loads a Wavefront Object (.obj) model.
static java.util.List<Primitive>	load(java.io.File file, float scale, java.util.function.BiFunction<java.lang.String,java.lang.String,Surface> surfaceMapper, float translateX, float translateY, float translateZ) Loads a Wavefront Object (.obj) model.
static java.util.List<Primitive>	load(java.io.File file, float scale, Surface surface) Loads a Wavefront Object (.obj) model.
static java.util.List<Primitive>	load(java.lang.String filename) Loads a Wavefront Object (.obj) model.
static java.util.List<Primitive>	load(java.lang.String filename, float scale) Loads a Wavefront Object (.obj) model.
static java.util.List<Primitive>	load(java.lang.String filename, float scale, java.util.function.BiFunction<java.lang.String,java.lang.String,Surface> surfaceMapper) Loads a Wavefront Object (.obj) model.
static java.util.List<Primitive>	load(java.lang.String filename, float scale, java.util.function.BiFunction<java.lang.String,java.lang.String,Surface> surfaceMapper, float translateX, float translateY, float translateZ) Loads a Wavefront Object (.obj) model.
static java.util.List<Primitive>	load(java.lang.String filename, float scale, Surface surface) Loads a Wavefront Object (.obj) model.

Methods inherited from class java.lang.Object

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

Method Detail

load

public static java.util.List<Primitive> load(java.io.File file)

Loads a Wavefront Object (.obj) model.

Returns a List of Primitives that represents the loaded Wavefront Object model.

Calling this method is equivalent to load(file, 1.0F).

If file is null, a NullPointerException will be thrown.

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

Parameters:

file - a File representing the file to load from

Returns:

a List of Primitives that represents the loaded Wavefront Object model

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

load

public static java.util.List<Primitive> load(java.io.File file,
                                             float scale)

Loads a Wavefront Object (.obj) model.

Returns a List of Primitives that represents the loaded Wavefront Object model.

Calling this method is equivalent to load(file, scale, (groupName, materialName) -> new Surface(new LambertianMaterial(), new ConstantTexture(Color.GRAY), new ConstantTexture(Color.BLACK), new ConstantTexture(Color.BLACK))).

If file is null, a NullPointerException will be thrown.

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

Parameters:

file - a File representing the file to load from

scale - the scale to use on the Wavefront Object model

Returns:

a List of Primitives that represents the loaded Wavefront Object model

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

load

public static java.util.List<Primitive> load(java.io.File file,
                                             float scale,
                                             java.util.function.BiFunction<java.lang.String,java.lang.String,Surface> surfaceMapper)

Loads a Wavefront Object (.obj) model.

Returns a List of Primitives that represents the loaded Wavefront Object model.

Calling this method is equivalent to load(file, scale, surfaceMapper, 0.0F, 0.0F, 0.0F).

If either file or surfaceMapper are null, a NullPointerException will be thrown.

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

Parameters:

file - a File representing the file to load from

scale - the scale to use on the Wavefront Object model

surfaceMapper - a BiFunction that maps a group name or a material name into a specific Surface instance

Returns:

a List of Primitives that represents the loaded Wavefront Object model

Throws:

java.lang.NullPointerException - thrown if, and only if, either file or surfaceMapper are null

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

load

public static java.util.List<Primitive> load(java.io.File file,
                                             float scale,
                                             java.util.function.BiFunction<java.lang.String,java.lang.String,Surface> surfaceMapper,
                                             float translateX,
                                             float translateY,
                                             float translateZ)

Loads a Wavefront Object (.obj) model.

Returns a List of Primitives that represents the loaded Wavefront Object model.

If either file or surfaceMapper are null, a NullPointerException will be thrown.

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

Parameters:

file - a File representing the file to load from

scale - the scale to use on the Wavefront Object model

surfaceMapper - a BiFunction that maps a group name or a material name into a specific Surface instance

translateX - use this to translate the Wavefront Object model in the X-direction

translateY - use this to translate the Wavefront Object model in the Y-direction

translateZ - use this to translate the Wavefront Object model in the Z-direction

Returns:

a List of Primitives that represents the loaded Wavefront Object model

Throws:

java.lang.NullPointerException - thrown if, and only if, either file or surfaceMapper are null

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

load

public static java.util.List<Primitive> load(java.io.File file,
                                             float scale,
                                             Surface surface)

Loads a Wavefront Object (.obj) model.

Returns a List of Primitives that represents the loaded Wavefront Object model.

Calling this method is equivalent to load(file, scale, (groupName, materialName) -> surface).

If either file or surface are null, a NullPointerException will be thrown.

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

Parameters:

file - a File representing the file to load from

scale - the scale to use on the Wavefront Object model

surface - the Surface to use on the Wavefront Object model

Returns:

a List of Primitives that represents the loaded Wavefront Object model

Throws:

java.lang.NullPointerException - thrown if, and only if, either file or surface are null

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

load

public static java.util.List<Primitive> load(java.lang.String filename)

Loads a Wavefront Object (.obj) model.

Returns a List of Primitives that represents the loaded Wavefront Object model.

Calling this method is equivalent to load(filename, 1.0F).

If filename is null, a NullPointerException will be thrown.

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

Parameters:

filename - a String representing the filename of the file to load from

Returns:

a List of Primitives that represents the loaded Wavefront Object model

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

load

public static java.util.List<Primitive> load(java.lang.String filename,
                                             float scale)

Loads a Wavefront Object (.obj) model.

Returns a List of Primitives that represents the loaded Wavefront Object model.

Calling this method is equivalent to load(filename, scale, (groupName, materialName) -> new Surface(new LambertianMaterial(), new ConstantTexture(Color.GRAY), new ConstantTexture(Color.BLACK), new ConstantTexture(Color.BLACK))).

If filename is null, a NullPointerException will be thrown.

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

Parameters:

filename - a String representing the filename of the file to load from

scale - the scale to use on the Wavefront Object model

Returns:

a List of Primitives that represents the loaded Wavefront Object model

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

load

public static java.util.List<Primitive> load(java.lang.String filename,
                                             float scale,
                                             java.util.function.BiFunction<java.lang.String,java.lang.String,Surface> surfaceMapper)

Loads a Wavefront Object (.obj) model.

Returns a List of Primitives that represents the loaded Wavefront Object model.

Calling this method is equivalent to load(filename, scale, surfaceMapper, 0.0F, 0.0F, 0.0F).

If either filename or surfaceMapper are null, a NullPointerException will be thrown.

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

Parameters:

filename - a String representing the filename of the file to load from

scale - the scale to use on the Wavefront Object model

surfaceMapper - a BiFunction that maps a group name or a material name into a specific Surface instance

Returns:

a List of Primitives that represents the loaded Wavefront Object model

Throws:

java.lang.NullPointerException - thrown if, and only if, either filename or surfaceMapper are null

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

load

public static java.util.List<Primitive> load(java.lang.String filename,
                                             float scale,
                                             java.util.function.BiFunction<java.lang.String,java.lang.String,Surface> surfaceMapper,
                                             float translateX,
                                             float translateY,
                                             float translateZ)

Loads a Wavefront Object (.obj) model.

Returns a List of Primitives that represents the loaded Wavefront Object model.

If either filename or surfaceMapper are null, a NullPointerException will be thrown.

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

Parameters:

filename - a String representing the filename of the file to load from

scale - the scale to use on the Wavefront Object model

surfaceMapper - a BiFunction that maps a group name or a material name into a specific Surface instance

translateX - use this to translate the Wavefront Object model in the X-direction

translateY - use this to translate the Wavefront Object model in the Y-direction

translateZ - use this to translate the Wavefront Object model in the Z-direction

Returns:

a List of Primitives that represents the loaded Wavefront Object model

Throws:

java.lang.NullPointerException - thrown if, and only if, either filename or surfaceMapper are null

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

load

public static java.util.List<Primitive> load(java.lang.String filename,
                                             float scale,
                                             Surface surface)

Loads a Wavefront Object (.obj) model.

Returns a List of Primitives that represents the loaded Wavefront Object model.

Calling this method is equivalent to load(filename, scale, (groupName, materialName) -> surface).

If either filename or surface are null, a NullPointerException will be thrown.

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

Parameters:

filename - a String representing the filename of the file to load from

scale - the scale to use on the Wavefront Object model

surface - the Surface to use on the Wavefront Object model

Returns:

a List of Primitives that represents the loaded Wavefront Object model

Throws:

java.lang.NullPointerException - thrown if, and only if, either filename or surface are null

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