TiledLayer (TiledReader 1.1.0 API)

java.lang.Object
- org.tiledreader.TiledLayer

All Implemented Interfaces:

TiledCustomizable

Direct Known Subclasses:

TiledGroupLayer, TiledImageLayer, TiledObjectLayer, TiledTileLayer
```
public abstract class TiledLayer
extends Object
implements TiledCustomizable
```
A TiledLayer represents a tile layer, object layer, image layer, or group layer, depending on which subclass of TiledLayer it is. The TiledLayer class is responsible for the attributes that all layer types have in common. Since a group layer's opacity, visibility, tint color, and rendering x and y offsets recursively affect its child layers, a TiledLayer object's methods specify those four attributes as relative (to the layer's group layer, if it has one) or as absolute. If the layer is not contained in a group layer, its relative opacity, visibility, etc. are equal to its absolute opacity, visibility, etc.

Author:

Alex Heyman

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`getAbsOffsetX()` Returns this layer's absolute rendering x offset.
`float`	`getAbsOffsetY()` Returns this layer's absolute rendering y offset.
`float`	`getAbsOpacity()` Returns this layer's absolute opacity.
`Color`	`getAbsTintColor()` Returns this layer's absolute tint color, or #FFFFFFFF (white) if none was specified.
`boolean`	`getAbsVisible()` Returns whether this layer is visible.
`String`	`getName()` Returns this layer's name.
`TiledGroupLayer`	`getParent()` Returns the group layer that this layer is a child of, or null if this layer is not contained in a group layer.
`Map<String,Object>`	`getProperties()` Returns an unmodifiable Map view of this entity's custom properties.
`Object`	`getProperty(String name)` Returns the value of this entity's custom property with the specified name, or null if no such property was specified.
`float`	`getRelOffsetX()` Returns this layer's rendering x offset, relative to its group layer if it has one.
`float`	`getRelOffsetY()` Returns this layer's rendering y offset, relative to its group layer if it has one.
`float`	`getRelOpacity()` Returns this layer's opacity, relative to its group layer if it has one.
`Color`	`getRelTintColor()` Returns this layer's tint color, relative to its group layer if it has one, or #FFFFFFFF (white) if none was specified.
`boolean`	`getRelVisible()` Returns whether this layer is visible, relative to its group layer if it has one.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getName
```
public final String getName()
```
    Returns this layer's name.
    
    Returns:
    
    This layer's name
  - getParent
```
public final TiledGroupLayer getParent()
```
    Returns the group layer that this layer is a child of, or null if this layer is not contained in a group layer.
    
    Returns:
    
    The group layer that this layer is a child of
  - getRelOpacity
```
public final float getRelOpacity()
```
    Returns this layer's opacity, relative to its group layer if it has one.
    
    Returns:
    
    This layer's relative opacity
  - getAbsOpacity
```
public final float getAbsOpacity()
```
    Returns this layer's absolute opacity.
    
    Returns:
    
    This layer's absolute opacity
  - getRelVisible
```
public final boolean getRelVisible()
```
    Returns whether this layer is visible, relative to its group layer if it has one.
    
    Returns:
    
    This layer's relative visibility
  - getAbsVisible
```
public final boolean getAbsVisible()
```
    Returns whether this layer is visible.
    
    Returns:
    
    This layer's absolute visibility
  - getRelTintColor
```
public final Color getRelTintColor()
```
    Returns this layer's tint color, relative to its group layer if it has one, or #FFFFFFFF (white) if none was specified.
    
    Returns:
    
    This layer's relative tint color
  - getAbsTintColor
```
public final Color getAbsTintColor()
```
    Returns this layer's absolute tint color, or #FFFFFFFF (white) if none was specified.
    
    Returns:
    
    This layer's absolute tint color
  - getRelOffsetX
```
public final float getRelOffsetX()
```
    Returns this layer's rendering x offset, relative to its group layer if it has one.
    
    Returns:
    
    This layer's relative rendering x offset
  - getAbsOffsetX
```
public final float getAbsOffsetX()
```
    Returns this layer's absolute rendering x offset.
    
    Returns:
    
    This layer's absolute rendering x offset
  - getRelOffsetY
```
public final float getRelOffsetY()
```
    Returns this layer's rendering y offset, relative to its group layer if it has one.
    
    Returns:
    
    This layer's relative rendering y offset
  - getAbsOffsetY
```
public final float getAbsOffsetY()
```
    Returns this layer's absolute rendering y offset.
    
    Returns:
    
    This layer's absolute rendering y offset
  - getProperties
```
public final Map<String,Object> getProperties()
```
    Description copied from interface: TiledCustomizable
    
    Returns an unmodifiable Map view of this entity's custom properties. Each key in the Map is the name of a property, and its corresponding value is the value of that property. The type of the value object corresponds to the type of the property: String for a string property, Integer for an int, Float for a float, Boolean for a bool, java.awt.Color for a color, TiledFile for a file, and TiledObject for an object (unless the object property is unset, in which case the value is null).
    
    Specified by:
    
    getProperties in interface TiledCustomizable
    
    Returns:
    
    This entity's custom properties
  - getProperty
```
public final Object getProperty(String name)
```
    Description copied from interface: TiledCustomizable
    
    Returns the value of this entity's custom property with the specified name, or null if no such property was specified. The type of the returned value object corresponds to the type of the property: String for a string property, Integer for an int, Float for a float, Boolean for a bool, java.awt.Color for a color, TiledFile for a file, and TiledObject for an object (unless the object property is unset, in which case the value is null).
    
    Specified by:
    
    getProperty in interface TiledCustomizable
    
    Parameters:
    
    name - The name of the property whose value is to be returned
    
    Returns:
    
    The value of this entity's custom property with the specified name

Class TiledLayer

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getParent

getRelOpacity

getAbsOpacity

getRelVisible

getAbsVisible

getRelTintColor

getAbsTintColor

getRelOffsetX

getAbsOffsetX

getRelOffsetY

getAbsOffsetY

getProperties

getProperty