TiledObject (mini2Dx)

java.lang.Object
- org.mini2Dx.tiled.TiledObject

All Implemented Interfaces:

GameDataSerializable
```
public class TiledObject
extends java.lang.Object
implements GameDataSerializable
```
Represents an object loaded from a TiledMap

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_PROPERTY_MAP_SIZE

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_PROPERTY_MAP_SIZE`

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsProperty(java.lang.String propertyName)` Returns if the object contains the specified property
`boolean`	`equals(java.lang.Object o)`
`static TiledObject`	`fromInputStream(java.io.DataInputStream inputStream)`
`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
`org.mini2Dx.gdx.utils.ObjectMap<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[]`	`getVertices()`
`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
`int`	`hashCode()`
`boolean`	`isBuiltFromTemplate()`
`boolean`	`isGidFlipDiagonally()`
`boolean`	`isGidFlipHorizontally()`
`boolean`	`isGidFlipVertically()`
`boolean`	`isVisible()`
`boolean`	`isWrapText()`
`void`	`readData(java.io.DataInputStream inputStream)` Deserializes this object from a `DataInputStream`
`void`	`setAsEllipse()` Marks this object as a `TiledObjectShape.ELLIPSE`
`void`	`setAsPoint()` Marks this object as a `TiledObjectShape.POINT`
`void`	`setAsPolygon(float[] vertices)` Marks this object as a `TiledObjectShape.POLYGON`
`void`	`setAsPolygon(java.lang.String points)` Marks this object as a `TiledObjectShape.POLYGON`
`void`	`setAsPolyline(float[] vertices)` Marks this object as a `TiledObjectShape.POLYLINE`
`void`	`setAsPolyline(java.lang.String points)` Marks this object as a `TiledObjectShape.POLYLINE`
`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`	`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.
`org.mini2Dx.gdx.utils.Array<Point>`	`toPolyline()` Creates a new `Array` of `Point`s from this object.
`Rectangle`	`toRectangle()` Creates a new `Rectangle` from this object.
`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
  - TiledObject
```
public TiledObject(int id,
                   float x,
                   float y,
                   float width,
                   float height)
```
- Method Detail
  - fromInputStream
```
public static TiledObject fromInputStream(java.io.DataInputStream inputStream)
                                   throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - 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
  - getProperties
```
public org.mini2Dx.gdx.utils.ObjectMap<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
  - setAsPolygon
```
public void setAsPolygon(float[] vertices)
```
    Marks this object as a TiledObjectShape.POLYGON
    
    Parameters:
    
    vertices - The vertices to set
  - 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
  - setAsPolyline
```
public void setAsPolyline(java.lang.String points)
```
    Marks this object as a TiledObjectShape.POLYLINE
    
    Parameters:
    
    points - The points in the format x1,y1 x2,y2 per the Tiled specification
  - setAsPolyline
```
public void setAsPolyline(float[] vertices)
```
    Marks this object as a TiledObjectShape.POLYLINE
    
    Parameters:
    
    vertices - The line point vertices
  - 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
  - toPolyline
```
public org.mini2Dx.gdx.utils.Array<Point> toPolyline()
```
    Creates a new Array of Points from this object. Warning: If this object's shape is not TiledObjectShape.POLYLINE, an exception will be thrown.
    
    Returns:
    
    A new Array of Points in the line
  - getVertices
```
public float[] getVertices()
```
  - getText
```
public java.lang.String getText()
```
  - isWrapText
```
public boolean isWrapText()
```
  - isBuiltFromTemplate
```
public boolean isBuiltFromTemplate()
```
  - 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

Class TiledObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PROPERTY_MAP_SIZE

Constructor Detail

TiledObject

Method Detail

fromInputStream

writeData

readData

getProperties

containsProperty

getProperty

setProperty

getId

getName

setName

getType

setType

getX

getY

getWidth

getHeight

getGid

setGid

isGidFlipHorizontally

setGidFlipHorizontally

isGidFlipVertically

setGidFlipVertically

isGidFlipDiagonally

setGidFlipDiagonally

getObjectShape

setAsEllipse

setAsPoint

setAsPolygon

setAsPolygon

setAsText

setAsPolyline

setAsPolyline

isVisible

setVisible

toPoint

toCircle

toRectangle

toPolygon

toPolyline

getVertices

getText

isWrapText

isBuiltFromTemplate

equals

hashCode

toString