IObjectStack

References
public interface IObjectStack
Interface for exposing sampling functionality of a Raycaster.

Methods

ContinueAndSample

#
Color ContinueAndSample(Ray ray)
Continue an existing ray.
Parameters:
ray (Ray)Ray to continue.
Returns: Colour at continued ray location.

FirstObjectAbove

#
int FirstObjectAbove(double x, double y, int startAt)
Find the index of the first object at the (u,v) location at or above the given layer index.
Parameters:
x (double)U coordinate.
y (double)V coordinate.
startAt (int)Start layer. Objects on this layer are taken into account.
Returns: The index of the first object coincident with (u,v) at or above the start layer. Or, if no object was found, -1.

FirstObjectBelow

#
int FirstObjectBelow(double x, double y, int startAt)
Find the index of the first object at the (u,v) location at or below the given layer index.
Parameters:
x (double)U coordinate.
y (double)V coordinate.
startAt (int)Start layer. Objects on this layer are taken into account.
Returns: The index of the first object coincident with (u,v) at or below the start layer. Or, if no object was found, -1.

Sample

#
Color Sample(Ray ray)
Shoot a ray into the object stack and evaluate the colour.
Parameters:
ray (Ray)Ray to shoot.
Returns: Colour at ray location.