com.io7m.jspatial.api

Class Ray3D.Builder

java.lang.Object

com.io7m.jspatial.api.Ray3D.Builder

Enclosing class:

Ray3D

public static final class Ray3D.Builder
extends Object

Builds instances of type Ray3D. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
Ray3D	build() Builds a new Ray3D.
Ray3D.Builder	from(Ray3DType instance) Fill a builder with attribute values from the provided Ray3DType instance.
Ray3D.Builder	setDirection(com.io7m.jtensors.core.unparameterized.vectors.Vector3D direction) Initializes the value for the direction attribute.
Ray3D.Builder	setOrigin(com.io7m.jtensors.core.unparameterized.vectors.Vector3D origin) Initializes the value for the origin attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final Ray3D.Builder from(Ray3DType instance)

Fill a builder with attribute values from the provided Ray3DType instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

setOrigin

public final Ray3D.Builder setOrigin(com.io7m.jtensors.core.unparameterized.vectors.Vector3D origin)

Initializes the value for the origin attribute.

Parameters:

origin - The value for origin

Returns:

this builder for use in a chained invocation

setDirection

public final Ray3D.Builder setDirection(com.io7m.jtensors.core.unparameterized.vectors.Vector3D direction)

Initializes the value for the direction attribute.

Parameters:

direction - The value for direction

Returns:

this builder for use in a chained invocation

build

public Ray3D build()

Builds a new Ray3D.

Returns:

An immutable instance of Ray3D

Throws:

IllegalStateException - if any required attributes are missing