org.mini2Dx.tiled

Class Layer

java.lang.Object

org.mini2Dx.tiled.Layer

All Implemented Interfaces:

GameDataSerializable, org.mini2Dx.gdx.utils.Disposable

Direct Known Subclasses:

GroupLayer, TiledObjectGroup, TileLayer

public abstract class Layer
extends java.lang.Object
implements org.mini2Dx.gdx.utils.Disposable, GameDataSerializable

Base class for TiledMap layers

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PROPERTY_MAP_SIZE

Constructor Summary

Constructors

Constructor and Description
Layer(LayerType layerType)

Method Summary

Modifier and Type	Method and Description
boolean	containsProperty(java.lang.String propertyName) Returns if the layer contains the specified property
void	dispose()
boolean	equals(java.lang.Object o)
static Layer	fromInputStream(java.io.DataInputStream inputStream)
int	getIndex() Returns the index in the TiledMap of this layer
LayerType	getLayerType()
java.lang.String	getName() Returns the name of this layer
org.mini2Dx.gdx.utils.ObjectMap<java.lang.String,java.lang.String>	getProperties() Returns the properties ObjectMap of this Layer
java.lang.String	getProperty(java.lang.String propertyName) Returns the value of a specified property
int	hashCode()
boolean	isVisible() Returns if this Layer is visible
void	readData(java.io.DataInputStream inputStream) Deserializes this object from a DataInputStream
void	setIndex(int index) Sets the index in the TiledMap of this layer
void	setName(java.lang.String name) Sets the name of this layer
void	setProperty(java.lang.String propertyName, java.lang.String value) Sets the value of a specified property
void	setVisible(boolean visible) Sets if this Layer is visible
java.lang.String	toString()
void	writeData(java.io.DataOutputStream outputStream) Serializes this object to a DataOutputStream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_PROPERTY_MAP_SIZE

public static int DEFAULT_PROPERTY_MAP_SIZE

Constructor Detail

Layer

public Layer(LayerType layerType)

Method Detail

fromInputStream

public static Layer fromInputStream(java.io.DataInputStream inputStream)
                             throws java.io.IOException

Throws:

java.io.IOException

dispose

public void dispose()

Specified by:

dispose in interface org.mini2Dx.gdx.utils.Disposable

writeData

public void writeData(java.io.DataOutputStream outputStream)
               throws java.io.IOException

Description copied from interface: GameDataSerializable

Serializes this object to a DataOutputStream

Specified by:

writeData in interface GameDataSerializable

Parameters:

outputStream - The DataOutputStream to write to

Throws:

java.io.IOException - Thrown if an error occurs during I/O

readData

public void readData(java.io.DataInputStream inputStream)
              throws java.io.IOException

Description copied from interface: GameDataSerializable

Deserializes this object from a DataInputStream

Specified by:

readData in interface GameDataSerializable

Parameters:

inputStream - The DataInputStream to read from

Throws:

java.io.IOException - Thrown if an error occurs during I/O

getName

public java.lang.String getName()

Returns the name of this layer

Returns:

Null if there is no name

setName

public void setName(java.lang.String name)

Sets the name of this layer

Parameters:

name - The name to set

getIndex

public int getIndex()

Returns the index in the TiledMap of this layer

Returns:

The index of the layer

setIndex

public void setIndex(int index)

Sets the index in the TiledMap of this layer

Parameters:

index - The index of the layer

containsProperty

public boolean containsProperty(java.lang.String propertyName)

Returns if the layer contains the specified property

Parameters:

propertyName - The property name to search for

Returns:

True if the layer contains the property

getProperty

public java.lang.String getProperty(java.lang.String propertyName)

Returns the value of a specified property

Parameters:

propertyName - The property name to search for

Returns:

Null if there is no such property

setProperty

public void setProperty(java.lang.String propertyName,
                        java.lang.String value)

Sets the value of a specified property

Parameters:

propertyName - The property name to set the value for

value - The value of the property to set

getProperties

public org.mini2Dx.gdx.utils.ObjectMap<java.lang.String,java.lang.String> getProperties()

Returns the properties ObjectMap of this Layer

Returns:

Null if there are no properties

isVisible

public boolean isVisible()

Returns if this Layer is visible

Returns:

True if visible

setVisible

public void setVisible(boolean visible)

Sets if this Layer is visible

Parameters:

visible - True if visible

getLayerType

public LayerType getLayerType()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object