org.dayflower.pathtracer.scene

Class Primitive

java.lang.Object

org.dayflower.pathtracer.scene.Primitive

public final class Primitive
extends java.lang.Object

A Primitive represents a primitive that is associated with a Shape and a Surface.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields

Modifier and Type	Field and Description
static int	RELATIVE_OFFSET_SHAPE_OFFSET The relative offset of the Shape Offset parameter in the float array.
static int	RELATIVE_OFFSET_SHAPE_TYPE The relative offset of the Shape Type parameter in the float array.
static int	RELATIVE_OFFSET_SURFACE_OFFSET The relative offset of the Surface Offset parameter in the float array.
static int	SIZE The size of a Primitive in the float array.

Constructor Summary

Constructors

Constructor and Description
Primitive(Shape shape, Surface surface) Constructs a new Primitive instance.
Primitive(Shape shape, Surface surface, Matrix44F objectToWorld) Constructs a new Primitive instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Compares object to this Primitive instance for equality.
Matrix44F	getObjectToWorld() Returns the Matrix44F to transform from object-space to world-space.
Shape	getShape() Returns the Shape assigned to this Primitive instance.
Surface	getSurface() Returns the Surface assigned to this Primitive instance.
Matrix44F	getWorldToObject() Returns the Matrix44F to transform from world-space to object-space.
int	hashCode() Returns a hash code for this Primitive instance.
void	setObjectToWorld(Matrix44F objectToWorld) Sets the Matrix44F to transform from object-space to world-space and updates the Matrix44F to transform from world-space to object-space.
void	setShape(Shape shape) Sets the Shape for this Primitive instance.
void	setSurface(Surface surface) Sets the Surface for this Primitive instance.
void	setWorldToObject(Matrix44F worldToObject) Sets the Matrix44F to transform from world-space to object-space and updates the Matrix44F to transform from object-space to world-space.
java.lang.String	toString() Returns a String representation of this Primitive instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RELATIVE_OFFSET_SHAPE_OFFSET

public static final int RELATIVE_OFFSET_SHAPE_OFFSET

The relative offset of the Shape Offset parameter in the float array. The value is 1.

See Also:

Constant Field Values

RELATIVE_OFFSET_SHAPE_TYPE

public static final int RELATIVE_OFFSET_SHAPE_TYPE

The relative offset of the Shape Type parameter in the float array. The value is 1.

See Also:

Constant Field Values

RELATIVE_OFFSET_SURFACE_OFFSET

public static final int RELATIVE_OFFSET_SURFACE_OFFSET

The relative offset of the Surface Offset parameter in the float array. The value is 2.

See Also:

Constant Field Values

SIZE

public static final int SIZE

The size of a Primitive in the float array. The size is 3.

See Also:

Constant Field Values

Constructor Detail

Primitive

public Primitive(Shape shape,
                 Surface surface)

Constructs a new Primitive instance.

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

Parameters:

shape - the Shape to use

surface - the Surface to use

Throws:

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

Primitive

public Primitive(Shape shape,
                 Surface surface,
                 Matrix44F objectToWorld)

Constructs a new Primitive instance.

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

If objectToWorld cannot be inversed, an IllegalStateException will be thrown.

Parameters:

shape - the Shape to use

surface - the Surface to use

objectToWorld - the Matrix44F to transform from object-space to world-space

Throws:

java.lang.IllegalStateException - thrown if, and only if, objectToWorld cannot be inversed

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

Method Detail

getObjectToWorld

public Matrix44F getObjectToWorld()

Returns the Matrix44F to transform from object-space to world-space.

Returns:

the Matrix44F to transform from object-space to world-space

getWorldToObject

public Matrix44F getWorldToObject()

Returns the Matrix44F to transform from world-space to object-space.

Returns:

the Matrix44F to transform from world-space to object-space

getShape

public Shape getShape()

Returns the Shape assigned to this Primitive instance.

Returns:

the Shape assigned to this Primitive instance

toString

public java.lang.String toString()

Returns a String representation of this Primitive instance.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this Primitive instance

getSurface

public Surface getSurface()

Returns the Surface assigned to this Primitive instance.

Returns:

the Surface assigned to this Primitive instance

equals

public boolean equals(java.lang.Object object)

Compares object to this Primitive instance for equality.

Returns true if, and only if, object is an instance of Primitive, and their respective values are equal, false otherwise.

Overrides:

equals in class java.lang.Object

Parameters:

object - the Object to compare to this Primitive instance for equality

Returns:

true if, and only if, object is an instance of Primitive, and their respective values are equal, false otherwise

hashCode

public int hashCode()

Returns a hash code for this Primitive instance.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this Primitive instance

setObjectToWorld

public void setObjectToWorld(Matrix44F objectToWorld)

Sets the Matrix44F to transform from object-space to world-space and updates the Matrix44F to transform from world-space to object-space.

If objectToWorld is null, a NullPointerException will be thrown.

If objectToWorld cannot be inversed, an IllegalStateException will be thrown.

Parameters:

objectToWorld - the new Matrix44F to transform from object-space to world-space

Throws:

java.lang.IllegalStateException - thrown if, and only if, objectToWorld cannot be inversed

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

setShape

public void setShape(Shape shape)

Sets the Shape for this Primitive instance.

If shape is null, a NullPointerException will be thrown.

Parameters:

shape - the new Shape

Throws:

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

setSurface

public void setSurface(Surface surface)

Sets the Surface for this Primitive instance.

If surface is null, a NullPointerException will be thrown.

Parameters:

surface - the new Surface

Throws:

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

setWorldToObject

public void setWorldToObject(Matrix44F worldToObject)

Sets the Matrix44F to transform from world-space to object-space and updates the Matrix44F to transform from object-space to world-space.

If worldToObject is null, a NullPointerException will be thrown.

If worldToObject cannot be inversed, an IllegalStateException will be thrown.

Parameters:

worldToObject - the new Matrix44F to transform from world-space to object-space

Throws:

java.lang.IllegalStateException - thrown if, and only if, worldToObject cannot be inversed

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