libGDX 1.14.2 · com.badlogic.gdx.maps.MapLayer · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private String	name
private MapObjects	objects
private float	offsetX
private float	offsetY
private float	opacity
private float	parallaxX
private float	parallaxY
private MapLayer	parent
private MapProperties	properties
private boolean	renderOffsetDirty
private float	renderOffsetX
private float	renderOffsetY
private Color	tempColor
private Color	tintColor
private boolean	visible

Constructor Summary

Access	Constructor and Description
public	MapLayer()

Method Summary

Modifier and Type	Method and Description
protected void	calculateRenderOffsets()
public Color	Returns: layer's tint color combined with the parent's tint color getCombinedTintColor() Returns a temporary color that is the combination of this layer's tint color and its parent's tint color.
public String	getName() Returns: layer's name
public MapObjects	getObjects() Returns: collection of objects contained in the layer
public float	getOffsetX() Returns: layer's x offset
public float	getOffsetY() Returns: layer's y offset
public float	getOpacity() Returns: layer's opacity
public float	getParallaxX() Returns: layer's parallax scrolling factor for x-axis
public float	getParallaxY() Returns: layer's parallax scrolling factor for y-axis
public MapLayer	getParent() Returns: the layer's parent `MapLayer`, or null if the layer does not have a parent
public MapProperties	getProperties() Returns: layer's set of properties
public float	getRenderOffsetX() Returns: the layer's x render offset, this takes into consideration all parent layers' offsets
public float	getRenderOffsetY() Returns: the layer's y render offset, this takes into consideration all parent layers' offsets
public Color	getTintColor() Returns: layer's tint color
public void	invalidateRenderOffset() set the renderOffsetDirty state to true, when this layer or any parents' offset has changed
public boolean	isVisible() Returns: whether the layer is visible or not
public void	setName(String new name for the layer name)
public void	setOffsetX(float new x offset for the layer offsetX)
public void	setOffsetY(float new y offset for the layer offsetY)
public void	setOpacity(float new opacity for the layer opacity)
public void	setParallaxX(float parallaxX)
public void	setParallaxY(float parallaxY)
public void	setParent(MapLayer the layer's new parent {@MapLayer }, internal use only parent)
public void	setTintColor(Color new tint color for the layer tintColor)
public void	setVisible(boolean toggles layer's visibility visible)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

name	back to summary
private String name

objects	back to summary
private MapObjects objects

offsetX	back to summary
private float offsetX

offsetY	back to summary
private float offsetY

opacity	back to summary
private float opacity

parallaxX	back to summary
private float parallaxX

parallaxY	back to summary
private float parallaxY

parent	back to summary
private MapLayer parent

properties	back to summary
private MapProperties properties

renderOffsetDirty	back to summary
private boolean renderOffsetDirty

renderOffsetX	back to summary
private float renderOffsetX

renderOffsetY	back to summary
private float renderOffsetY

tempColor	back to summary
private Color tempColor

tintColor	back to summary
private Color tintColor

visible	back to summary
private boolean visible

Constructor Detail

MapLayer	back to summary
public MapLayer()

Method Detail

calculateRenderOffsets	back to summary
protected void calculateRenderOffsets()

getCombinedTintColor	back to summary
public Color getCombinedTintColor() Returns a temporary color that is the combination of this layer's tint color and its parent's tint color. The returned color is reused internally, so it should not be held onto or modified. Returns:Color layer's tint color combined with the parent's tint color

getCombinedTintColor

back to summary

public Color getCombinedTintColor()

Returns a temporary color that is the combination of this layer's tint color and its parent's tint color. The returned color is reused internally, so it should not be held onto or modified.

Returns:Color: layer's tint color combined with the parent's tint color

getName	back to summary
public String getName() Returns:String layer's name

getObjects	back to summary
public MapObjects getObjects() Returns:MapObjects collection of objects contained in the layer

getOffsetX	back to summary
public float getOffsetX() Returns:float layer's x offset

getOffsetY	back to summary
public float getOffsetY() Returns:float layer's y offset

getOpacity	back to summary
public float getOpacity() Returns:float layer's opacity

getParallaxX	back to summary
public float getParallaxX() Returns:float layer's parallax scrolling factor for x-axis

getParallaxY	back to summary
public float getParallaxY() Returns:float layer's parallax scrolling factor for y-axis

getParent	back to summary
public MapLayer getParent() Returns:MapLayer the layer's parent `MapLayer`, or null if the layer does not have a parent

getProperties	back to summary
public MapProperties getProperties() Returns:MapProperties layer's set of properties

getRenderOffsetX	back to summary
public float getRenderOffsetX() Returns:float the layer's x render offset, this takes into consideration all parent layers' offsets

getRenderOffsetY	back to summary
public float getRenderOffsetY() Returns:float the layer's y render offset, this takes into consideration all parent layers' offsets

getTintColor	back to summary
public Color getTintColor() Returns:Color layer's tint color

invalidateRenderOffset	back to summary
public void invalidateRenderOffset() set the renderOffsetDirty state to true, when this layer or any parents' offset has changed

isVisible	back to summary
public boolean isVisible() Returns:boolean whether the layer is visible or not

setName	back to summary
public void setName(String name) Parameters name:String new name for the layer

setOffsetX	back to summary
public void setOffsetX(float offsetX) Parameters offsetX:float new x offset for the layer

setOffsetY	back to summary
public void setOffsetY(float offsetY) Parameters offsetY:float new y offset for the layer

setOpacity	back to summary
public void setOpacity(float opacity) Parameters opacity:float new opacity for the layer

setParallaxX	back to summary
public void setParallaxX(float parallaxX)

setParallaxY	back to summary
public void setParallaxY(float parallaxY)

setParent	back to summary
public void setParent(MapLayer parent) Parameters parent:MapLayer the layer's new parent {@MapLayer }, internal use only

setTintColor	back to summary
public void setTintColor(Color tintColor) Parameters tintColor:Color new tint color for the layer