Package com.simsilica.lemur

Class LayerComparator

java.lang.Object

com.simsilica.lemur.LayerComparator

All Implemented Interfaces:

GeometryComparator, Comparator<Geometry>

public class LayerComparator
extends Object
implements GeometryComparator

Sorts geometry based on an included "layer" user data, accumulating an effective layer by walking up the scene graph back to root. Layers are parent-local layers and not global layers. In other words, they only control the sorting of children. This approach is more useful in a GUI environment where UI elements are grouped in scene graph hierarchies already.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EFFECTIVE_LAYER
static final String	LAYER

Constructor Summary

Constructors

Constructor	Description
LayerComparator(GeometryComparator delegate)
LayerComparator(GeometryComparator delegate, int bias)

Method Summary

Modifier and Type	Method	Description
protected float	calculateEffectiveLayer(Geometry g)
static void	clearEffectiveLayer(Spatial s)
int	compare(Geometry g1, Geometry g2)
float	getLayer(Geometry g)
static Integer	getLayer(Spatial s)
static void	resetLayer(Spatial s, int layer)
void	setCamera(Camera cam)	Set the camera to use for sorting.
static void	setLayer(Spatial s, int layer)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Details

LAYER

public static final String LAYER

See Also:

• Constant Field Values

EFFECTIVE_LAYER

public static final String EFFECTIVE_LAYER

See Also:

• Constant Field Values

Constructor Details

LayerComparator

public LayerComparator(GeometryComparator delegate)

LayerComparator

public LayerComparator(GeometryComparator delegate,
 int bias)

Method Details

setLayer

public static void setLayer(Spatial s,
 int layer)

resetLayer

public static void resetLayer(Spatial s,
 int layer)

getLayer

public static Integer getLayer(Spatial s)

clearEffectiveLayer

public static void clearEffectiveLayer(Spatial s)

setCamera

public void setCamera(Camera cam)

Description copied from interface: GeometryComparator

Set the camera to use for sorting.

Specified by:

setCamera in interface GeometryComparator

Parameters:

cam - The camera to use for sorting

calculateEffectiveLayer

protected float calculateEffectiveLayer(Geometry g)

getLayer

public float getLayer(Geometry g)

compare

public int compare(Geometry g1,
 Geometry g2)

Specified by:

compare in interface Comparator<Geometry>

toString

public String toString()

Overrides:

toString in class Object