com.bonzaiengine.scene.visibility

Class Visibility

java.lang.Object

com.bonzaiengine.scene.visibility.Visibility

public final class Visibility
extends java.lang.Object

Visibility utilities to cull, sort and select LOD levels.
front to back sorting: is usually suited for sorting opaque (or alpha test) objects
back to front sorting: is usually suited for sorting transparent objects
culling: frustum culling algorithm

Constructor Summary

Constructors

Constructor and Description
Visibility()

Method Summary

Modifier and Type	Method and Description
CullTest	cull(ICullable cullable)
void	cull(ICullableNode rootNode) Visible nodes outside the frustum are marked as culled.
float	distanceToView(IBoundable boundable, boolean minDistance)
Frustum	getFrustum()
int	getFrustumCullingMaxDepth()
int	getNodeInsideFrustum() Valid after calling cull(ICullableNode)
int	getNodesCulled() Valid after calling cull(ICullableNode)
int	getNodesInvisible() Valid after calling cull(ICullableNode)
boolean	getUndefinedVolumeInsideFrustum()
int	lodLevel(ILod lod)
void	setFrustumCullingMaxDepth(int maxDepth)
void	setUndefinedVolumeInsideFrustum(boolean nullVolumeInsideFrustum)
<T extends IBoundable> void	sort(Array<T> dst, Array<T> src, boolean frontToBack)
<T extends IBoundable> void	sort(T[] srcAndDst, boolean frontToBack)
<T extends ILod> void	sortAndLodLevel(Array<T> dst, Array<T> src, boolean frontToBack)
<T extends ILod> void	sortAndLodLevel(T[] srcAndDst, boolean frontToBack)
void	update(Frustum frustum) Update the view from a Frustum
void	update(ICamera view, Mat4x4 projection) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Visibility

public Visibility()

Method Detail

getFrustum

public final Frustum getFrustum()

Returns:

the Frustum of this Visibility

See Also:

update(Frustum)

update

public final void update(Frustum frustum)

Update the view from a Frustum

Parameters:

frustum -

See Also:

update(ICamera, Mat4x4)

update

@Deprecated
public final void update(ICamera view,
                                     Mat4x4 projection)

Deprecated.

Update the view from an ICamera

Parameters:

view -

See Also:

update(Frustum)

setFrustumCullingMaxDepth

public final void setFrustumCullingMaxDepth(int maxDepth)

Parameters:

maxDepth - maximum depth

See Also:

getFrustumCullingMaxDepth()

getFrustumCullingMaxDepth

public final int getFrustumCullingMaxDepth()

Returns:

the maximum depth. Used by the culling algorithm to limit recursion, -1 if unlimited

setUndefinedVolumeInsideFrustum

public void setUndefinedVolumeInsideFrustum(boolean nullVolumeInsideFrustum)

getUndefinedVolumeInsideFrustum

public boolean getUndefinedVolumeInsideFrustum()

Returns:

true to consider that a cullable object is inside the frustum when its bounding volume is not defined (null)
Default value: false

getNodeInsideFrustum

public final int getNodeInsideFrustum()

Valid after calling cull(ICullableNode)

Returns:

the number of nodes inside the Frustum

getNodesCulled

public final int getNodesCulled()

Valid after calling cull(ICullableNode)

Returns:

the number of nodes outside the Frustum, ie culled

getNodesInvisible

public final int getNodesInvisible()

Valid after calling cull(ICullableNode)

Returns:

the number of nodes invisible, could be inside or outside the Frustum

See Also:

ICullable.isVisible()

cull

public final void cull(ICullableNode rootNode)

Visible nodes outside the frustum are marked as culled.

See Also:

setFrustumCullingMaxDepth(int), getFrustumCullingMaxDepth(), getNodeInsideFrustum(), getNodesCulled(), getNodesInvisible()

cull

public final CullTest cull(ICullable cullable)

Parameters:

frustum - Frustum volume for visibility test

cullable - a ICullable object

Returns:

the cull state

sort

public final <T extends IBoundable> void sort(Array<T> dst,
                                              Array<T> src,
                                              boolean frontToBack)

Parameters:

dst - destination list to store sorted objects, can be src

src - source list IBoundable of objects to sort

frontToBack - true: front to back sorting (best for opaque / alpha test), false: back to front sorting (best for transparent)

sort

public final <T extends IBoundable> void sort(T[] srcAndDst,
                                              boolean frontToBack)

sortAndLodLevel

public final <T extends ILod> void sortAndLodLevel(Array<T> dst,
                                                   Array<T> src,
                                                   boolean frontToBack)

Parameters:

dst - destination list to store sorted objects, can be src

src - source list ILod of objects to sort and update lod level

frontToBack - true: front to back sorting (best for opaque / alpha test), false: back to front sorting (best for transparent)

sortAndLodLevel

public final <T extends ILod> void sortAndLodLevel(T[] srcAndDst,
                                                   boolean frontToBack)

lodLevel

public final int lodLevel(ILod lod)

Parameters:

lod - ILod object to update lod level based on

Returns:

the lod level set

See Also:

update(Frustum), update(ICamera, Mat4x4)

distanceToView

public final float distanceToView(IBoundable boundable,
                                  boolean minDistance)

Parameters:

boundable - an IBoundable objects

minDistance - true: min distance
false: max distance