org.mini2Dx.tiled

Class TiledObject

java.lang.Object

org.mini2Dx.tiled.TiledObject

public class TiledObject
extends java.lang.Object

Represents an object loaded from a TiledMap

Constructor Summary

Constructors

Constructor and Description
TiledObject(int id, float x, float y, float width, float height)

Method Summary

Modifier and Type	Method and Description
boolean	containsProperty(java.lang.String propertyName) Returns if the object contains the specified property
int	getGid() Returns the Tile GID of this object
float	getHeight() Returns the height of this object in pixels
int	getId() Returns the ID of this object
java.lang.String	getName() Returns the name of this object
TiledObjectShape	getObjectShape() Returns the TiledObjectShape of this object
java.lang.String	getPolyline()
java.util.Map<java.lang.String,java.lang.String>	getProperties() Returns this object's properties
java.lang.String	getProperty(java.lang.String propertyName) Returns the value of a specified property
java.lang.String	getText()
java.lang.String	getType() Returns the type of this object
float	getWidth() Returns the width of this object in pixels
float	getX() Returns the x coordinate of this object in pixels
float	getY() Returns the y coordinate of this object in pixels
boolean	isGidFlipDiagonally()
boolean	isGidFlipHorizontally()
boolean	isGidFlipVertically()
boolean	isVisible()
boolean	isWrapText()
void	setAsEllipse() Marks this object as a TiledObjectShape.ELLIPSE
void	setAsPoint() Marks this object as a TiledObjectShape.POINT
void	setAsPolygon(java.lang.String points) Marks this object as a TiledObjectShape.POLYGON
void	setAsText(java.lang.String text, boolean wrapText) Marks this object as a TiledObjectShape.TEXT
void	setGid(int gid) Sets the Tile GID of this object
void	setGidFlipDiagonally(boolean gidFlipDiagonally)
void	setGidFlipHorizontally(boolean gidFlipHorizontally)
void	setGidFlipVertically(boolean gidFlipVertically)
void	setName(java.lang.String name) Sets the name of this object
void	setPolyline(java.lang.String polyline)
void	setProperty(java.lang.String propertyName, java.lang.String value) Sets the value of a specified property
void	setType(java.lang.String type) Sets the type of this object
void	setVisible(boolean visible)
Circle	toCircle() Creates a new Circle from this object.
Point	toPoint() Creates a new Point from this object.
Polygon	toPolygon() Creates a new Polygon from this object.
Rectangle	toRectangle() Creates a new Rectangle from this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

TiledObject

public TiledObject(int id,
                   float x,
                   float y,
                   float width,
                   float height)

Method Detail

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns this object's properties

Returns:

Null if there are no properties

containsProperty

public boolean containsProperty(java.lang.String propertyName)

Returns if the object contains the specified property

Parameters:

propertyName - The property name to search for

Returns:

True if the object 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

getId

public int getId()

Returns the ID of this object

Returns:

-1 if using a version of Tiled where IDs are not generated

getName

public java.lang.String getName()

Returns the name of this object

Returns:

setName

public void setName(java.lang.String name)

Sets the name of this object

Parameters:

name - The name to set

getType

public java.lang.String getType()

Returns the type of this object

Returns:

setType

public void setType(java.lang.String type)

Sets the type of this object

Parameters:

type -

getX

public float getX()

Returns the x coordinate of this object in pixels

Returns:

getY

public float getY()

Returns the y coordinate of this object in pixels

Returns:

getWidth

public float getWidth()

Returns the width of this object in pixels

Returns:

getHeight

public float getHeight()

Returns the height of this object in pixels

Returns:

getGid

public int getGid()

Returns the Tile GID of this object

Returns:

setGid

public void setGid(int gid)

Sets the Tile GID of this object

Parameters:

gid -

isGidFlipHorizontally

public boolean isGidFlipHorizontally()

setGidFlipHorizontally

public void setGidFlipHorizontally(boolean gidFlipHorizontally)

isGidFlipVertically

public boolean isGidFlipVertically()

setGidFlipVertically

public void setGidFlipVertically(boolean gidFlipVertically)

isGidFlipDiagonally

public boolean isGidFlipDiagonally()

setGidFlipDiagonally

public void setGidFlipDiagonally(boolean gidFlipDiagonally)

getObjectShape

public TiledObjectShape getObjectShape()

Returns the TiledObjectShape of this object

Returns:

Defaults to TiledObjectShape.RECTANGLE

setAsEllipse

public void setAsEllipse()

Marks this object as a TiledObjectShape.ELLIPSE

setAsPoint

public void setAsPoint()

Marks this object as a TiledObjectShape.POINT

setAsPolygon

public void setAsPolygon(java.lang.String points)

Marks this object as a TiledObjectShape.POLYGON

Parameters:

points - The points in the format x1,y1 x2,y2 per the Tiled specification

setAsText

public void setAsText(java.lang.String text,
                      boolean wrapText)

Marks this object as a TiledObjectShape.TEXT

Parameters:

text - The text to display

wrapText - True if the text wraps

getPolyline

public java.lang.String getPolyline()

setPolyline

public void setPolyline(java.lang.String polyline)

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean visible)

toPoint

public Point toPoint()

Creates a new Point from this object. Warning: If this object's shape is not TiledObjectShape.POINT, an exception will be thrown.

Returns:

A new Point

toCircle

public Circle toCircle()

Creates a new Circle from this object. Warning: If this object's shape is not TiledObjectShape.ELLIPSE, an exception will be thrown.

Returns:

A new Circle

toRectangle

public Rectangle toRectangle()

Creates a new Rectangle from this object. Warning: If this object's shape is not TiledObjectShape.RECTANGLE, an exception will be thrown.

Returns:

A new Rectangle

toPolygon

public Polygon toPolygon()

Creates a new Polygon from this object. Warning: If this object's shape is not TiledObjectShape.POLYGON, an exception will be thrown.

Returns:

A new Polygon

getText

public java.lang.String getText()

isWrapText

public boolean isWrapText()