Package org.sunflow.core

Class Instance

java.lang.Object

org.sunflow.core.Instance

All Implemented Interfaces:

RenderObject

public class Instance
extends java.lang.Object
implements RenderObject

This represents an instance of a Geometry into the scene. This class maps object space to world space and maintains a list of shaders and modifiers attached to the surface.

Field Summary

Fields

Modifier and Type	Field	Description
private BoundingBox	bounds
private Geometry	geometry
private Modifier[]	modifiers
private MovingMatrix4	o2w
private Shader[]	shaders
private MovingMatrix4	w2o

Constructor Summary

Constructors

Constructor	Description
Instance()

Method Summary

Modifier and Type	Method	Description
static Instance	createTemporary(PrimitiveList primitives, Matrix4 transform, Shader shader)
(package private) PrimitiveList	getBakingPrimitives()
BoundingBox	getBounds()	Get the world space bounding box for this instance.
(package private) Geometry	getGeometry()
Modifier	getModifier(int i)	Get a modifier for the instance's list.
(package private) int	getNumPrimitives()
(package private) Matrix4	getObjectToWorld(float time)
Shader	getShader(int i)	Get a shader for the instance's list.
(package private) Matrix4	getWorldToObject(float time)
boolean	hasGeometry(Geometry g)	Checks to see if this instance is relative to the specified geometry.
(package private) void	intersect(Ray r, IntersectionState state)
void	prepareShadingState(ShadingState state)	Prepare the shading state for shader invocation.
void	removeModifier(Modifier m)	Remove the specified modifier from the instance's list if it is being used.
void	removeShader(Shader s)	Remove the specified shader from the instance's list if it is being used.
boolean	update(ParameterList pl, SunflowAPI api)	Update this object given a list of parameters.
void	updateBounds()	Recompute world space bounding box of this instance.

Methods inherited from class java.lang.Object

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

Field Detail

o2w

private MovingMatrix4 o2w

w2o

private MovingMatrix4 w2o

bounds

private BoundingBox bounds

geometry

private Geometry geometry

shaders

private Shader[] shaders

modifiers

private Modifier[] modifiers

Constructor Detail

Instance

public Instance()

Method Detail

createTemporary

public static Instance createTemporary(PrimitiveList primitives,
                                       Matrix4 transform,
                                       Shader shader)

update

public boolean update(ParameterList pl,
                      SunflowAPI api)

Description copied from interface: RenderObject

Update this object given a list of parameters. This method is guarenteed to be called at least once on every object, but it should correctly handle empty parameter lists. This means that the object should be in a valid state from the time it is constructed. This method should also return true or false depending on whether the update was succesfull or not.

Specified by:

update in interface RenderObject

Parameters:

pl - list of parameters to read from

api - reference to the current scene

Returns:

true if the update is succesfull, false otherwise

updateBounds

public void updateBounds()

Recompute world space bounding box of this instance.

hasGeometry

public boolean hasGeometry(Geometry g)

Checks to see if this instance is relative to the specified geometry.

Parameters:

g - geometry to check against

Returns:

true if the instanced geometry is equals to g, false otherwise

removeShader

public void removeShader(Shader s)

Remove the specified shader from the instance's list if it is being used.

Parameters:

s - shader to remove

removeModifier

public void removeModifier(Modifier m)

Remove the specified modifier from the instance's list if it is being used.

Parameters:

m - modifier to remove

getBounds

public BoundingBox getBounds()

Get the world space bounding box for this instance.

Returns:

bounding box in world space

getNumPrimitives

int getNumPrimitives()

intersect

void intersect(Ray r,
               IntersectionState state)

prepareShadingState

public void prepareShadingState(ShadingState state)

Prepare the shading state for shader invocation. This also runs the currently attached surface modifier.

Parameters:

state - shading state to be prepared

getShader

public Shader getShader(int i)

Get a shader for the instance's list.

Parameters:

i - index into the shader list

Returns:

requested shader, or null if the input is invalid

getModifier

public Modifier getModifier(int i)

Get a modifier for the instance's list.

Parameters:

i - index into the modifier list

Returns:

requested modifier, or null if the input is invalid

getObjectToWorld

Matrix4 getObjectToWorld(float time)

getWorldToObject

Matrix4 getWorldToObject(float time)

getBakingPrimitives

PrimitiveList getBakingPrimitives()

getGeometry

Geometry getGeometry()