com.lhkbob.entreri.task

Class Result

java.lang.Object

com.lhkbob.entreri.task.Result

Direct Known Subclasses:

ElapsedTimeResult

public class Result
extends Object

Result represents a computed result, preferably that of a bulk computation, performed by a Task. Results allow Taskss to easily pass data to other tasks in the same job that might be interested in their computations.

Tasks that wish to expose results define classes that extend Result and provide the actual result data. During processing of a task, result instances are created and supplied to all future tasks by calling Job.report(Result).

To receive computed results, Tasks define public void report(T extends Result) methods that are invoked through reflection by the job when a compatible result is reported.

Author:

Michael Ludwig

Constructor Summary

Constructors

Constructor and Description
Result()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isSingleton() Return true if this result is a "singleton" result.

Methods inherited from class java.lang.Object

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

Constructor Detail

Result

public Result()

Method Detail

isSingleton

public boolean isSingleton()

Return true if this result is a "singleton" result. A singleton result is a type of result that is can only be reported once per execution of a job. The job verifies that singleton results are supplied at most once per job execution. Most results should return false. The returned value should be the same for every instance of a type, it should not depend on the state of the instance.

Singleton results should only be used when the computation of the result produces all of the result data. As an example, a 3D engine might assign entities to lights, and each unique configuration of lights on an entity is a "light group". It makes more sense to provide a single result that describes all light groups than individual results for each group. They are packed into a single result because each group is dependent on the others to guarantee its uniqueness.

As a counter example, computing potentially visible sets for a 3D engine should not be a singleton result. A result that contains the view and set of visible entities is a self-contained result, other views or cameras do not affect the PVS results.

The default implementation returns false. Subtypes are free to override it, but it must return the same value for all instances of a given type.

Returns:

True if this result should only be supplied at most once during each frame