org.mini2Dx.tiled.collisions

Class TiledCollisionMapper<T extends Positionable>

java.lang.Object

org.mini2Dx.tiled.collisions.TiledCollisionMapper<T>

public class TiledCollisionMapper<T extends Positionable>
extends java.lang.Object

Utility class for converting TiledMap data into collision data.

Constructor Summary

Constructors

Constructor and Description
TiledCollisionMapper(TiledCollisionFactory<T> collisionFactory) Creates a TiledCollisionMapper with a TileIdCollisionMerger instance for merge operations
TiledCollisionMapper(TiledCollisionFactory<T> collisionFactory, TiledCollisionMerger collisionMerger) Creates a TiledCollisionMapper with a specifc TiledCollisionMerger implementation for merge operations
TiledCollisionMapper(TiledCollisionFactory<T> collisionFactory, TiledCollisionMerger collisionMerger, TileMergeMode mergeMode) Creates a TiledCollisionMapper with a specifc TiledCollisionMerger implementation for merge operations

Method Summary

Modifier and Type	Method and Description
void	mapAndMergeCollisionsByLayer(java.util.List<T> results, TiledMap tiledMap, int layerIndex) Extracts and merges collisions in a TiledMap layer and adds them to a List instance.
void	mapAndMergeCollisionsByLayer(java.util.List<T> results, TiledMap tiledMap, int layerIndex, int maxColumns, int maxRows) Extracts and merges collisions in a TiledMap layer and adds them to a List instance.
void	mapAndMergeCollisionsByLayer(java.util.List<T> results, TiledMap tiledMap, java.lang.String layerName) Extracts and merges collisions in a TiledMap layer and adds them to a List instance.
void	mapAndMergeCollisionsByLayer(QuadTree<T> quadTree, TiledMap tiledMap, int layerIndex) Extracts and merges collisions in a TiledMap layer and adds them to a QuadTree instance.
void	mapAndMergeCollisionsByLayer(QuadTree<T> quadTree, TiledMap tiledMap, int layerIndex, int maxColumns, int maxRows) Extracts and merges collisions in a TiledMap layer and adds them to a QuadTree instance.
void	mapAndMergeCollisionsByLayer(QuadTree<T> quadTree, TiledMap tiledMap, java.lang.String layerName) Extracts and merges collisions in a TiledMap layer and adds them to a QuadTree instance.
void	mapAndMergeEmptySpacesByLayer(java.util.List<T> results, TiledMap tiledMap, int layerIndex) Extracts and merges empty spaces in a TiledMap layer and adds them to a List instance.
void	mapAndMergeEmptySpacesByLayer(java.util.List<T> results, TiledMap tiledMap, int layerIndex, int maxColumns, int maxRows) Extracts and merges empty spaces in a TiledMap layer and adds them to a List instance.
void	mapAndMergeEmptySpacesByLayer(java.util.List<T> results, TiledMap tiledMap, java.lang.String layerName) Extracts and merges empty spaces in a TiledMap layer and adds them to a List instance.
void	mapAndMergeEmptySpacesByLayer(QuadTree<T> quadTree, TiledMap tiledMap, int layerIndex) Extracts and merges empty spaces in a TiledMap layer and adds them to a QuadTree instance.
void	mapAndMergeEmptySpacesByLayer(QuadTree<T> quadTree, TiledMap tiledMap, int layerIndex, int maxColumns, int maxRows) Extracts and merges empty spaces in a TiledMap layer and adds them to a QuadTree instance.
void	mapAndMergeEmptySpacesByLayer(QuadTree<T> quadTree, TiledMap tiledMap, java.lang.String layerName) Extracts and merges empty spaces in a TiledMap layer and adds them to a QuadTree instance.
void	mapCollisionsByLayer(java.util.List<T> results, TiledMap tiledMap, int layerIndex) Extracts collisions in a TiledMap layer and adds them to a List instance
void	mapCollisionsByLayer(java.util.List<T> results, TiledMap tiledMap, java.lang.String layerName) Extracts collisions in a TiledMap layer and adds them to a List instance
void	mapCollisionsByLayer(QuadTree<T> quadTree, TiledMap tiledMap, int layerIndex) Extracts collisions in a TiledMap layer and adds them to a QuadTree instance
void	mapCollisionsByLayer(QuadTree<T> quadTree, TiledMap tiledMap, java.lang.String layerName) Extracts collisions in a TiledMap layer and adds them to a QuadTree instance
static byte[][]	mapCollisionsByLayer(TiledMap tiledMap, int layerIndex) Creates a 2D byte array representing the collisions in a TiledMap layer
static byte[][]	mapCollisionsByLayer(TiledMap tiledMap, java.lang.String layerName) Creates a 2D byte array representing the collisions in a TiledMap layer
void	mapCollisionsByObjectGroup(java.util.List<T> results, TiledMap tiledMap, java.lang.String groupName) Extracts collisions in a TiledMap object group and adds them to a List instance
void	mapCollisionsByObjectGroup(java.util.List<T> results, TiledMap tiledMap, java.lang.String groupName, java.lang.String objectType) Extracts collisions in a TiledMap object group that have a specific value in their type field and adds them to a List instance
void	mapCollisionsByObjectGroup(QuadTree<T> quadTree, TiledMap tiledMap, java.lang.String groupName) Extracts collisions in a TiledMap object group and adds them to a QuadTree instance
void	mapCollisionsByObjectGroup(QuadTree<T> quadTree, TiledMap tiledMap, java.lang.String groupName, java.lang.String objectType) Extracts collisions in a TiledMap object group that have a specific value in their type field and adds them to a QuadTree instance
void	mapEmptySpacesByLayer(java.util.List<T> results, TiledMap tiledMap, int layerIndex) Extracts empty spaces in a TiledMap layer and adds them to a List instance
void	mapEmptySpacesByLayer(java.util.List<T> results, TiledMap tiledMap, java.lang.String layerName) Extracts empty spaces in a TiledMap layer and adds them to a List instance
void	mapEmptySpacesByLayer(QuadTree<T> quadTree, TiledMap tiledMap, int layerIndex) Extracts empty spaces in a TiledMap layer and adds them to a QuadTree instance
void	mapEmptySpacesByLayer(QuadTree<T> quadTree, TiledMap tiledMap, java.lang.String layerName) Extracts empty spaces in a TiledMap layer and adds them to a QuadTree instance
static byte[][]	mapEmptySpacesByLayer(TiledMap tiledMap, int layerIndex) Creates a 2D byte array representing the empty spaces (non-collisions) in a TiledMap layer
static byte[][]	mapEmptySpacesByLayer(TiledMap tiledMap, java.lang.String layerName) Creates a 2D byte array representing the empty spaces (non-collisions) in a TiledMap layer

Methods inherited from class java.lang.Object

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

Constructor Detail

TiledCollisionMapper

public TiledCollisionMapper(TiledCollisionFactory<T> collisionFactory)

Creates a TiledCollisionMapper with a TileIdCollisionMerger instance for merge operations

Parameters:

collisionFactory - An implementation of TiledCollisionFactory for creating collision instances

TiledCollisionMapper

public TiledCollisionMapper(TiledCollisionFactory<T> collisionFactory,
                            TiledCollisionMerger collisionMerger)

Creates a TiledCollisionMapper with a specifc TiledCollisionMerger implementation for merge operations

Parameters:

collisionFactory - An implementation of TiledCollisionFactory for creating collision instances

collisionMerger - An implementation of TiledCollisionMerger for determining if two tiles can be merged into a single collision

TiledCollisionMapper

public TiledCollisionMapper(TiledCollisionFactory<T> collisionFactory,
                            TiledCollisionMerger collisionMerger,
                            TileMergeMode mergeMode)

Creates a TiledCollisionMapper with a specifc TiledCollisionMerger implementation for merge operations

Parameters:

collisionFactory - An implementation of TiledCollisionFactory for creating collision instances

collisionMerger - An implementation of TiledCollisionMerger for determining if two tiles can be merged into a single collision

mergeMode - The TileMergeMode to use for searching mergable tiles

Method Detail

mapCollisionsByLayer

public static byte[][] mapCollisionsByLayer(TiledMap tiledMap,
                                            java.lang.String layerName)

Creates a 2D byte array representing the collisions in a TiledMap layer

Parameters:

tiledMap - The TiledMap to extract collisions from

layerName - The name of the layer to extract collisions from. Each tile drawn in the layer is treated as a collision.

Returns:

A 2D byte array with the same width and height as the layer. [x][y] will be set to 1 if there is a collision.

mapCollisionsByLayer

public static byte[][] mapCollisionsByLayer(TiledMap tiledMap,
                                            int layerIndex)

Creates a 2D byte array representing the collisions in a TiledMap layer

Parameters:

tiledMap - The TiledMap to extract collisions from

layerIndex - The index of the layer to extract collisions from. Each tile drawn in the layer is treated as a collision.

Returns:

A 2D byte array with the same width and height as the layer. [x][y] will be set to 1 if there is a collision.

mapEmptySpacesByLayer

public static byte[][] mapEmptySpacesByLayer(TiledMap tiledMap,
                                             java.lang.String layerName)

Creates a 2D byte array representing the empty spaces (non-collisions) in a TiledMap layer

Parameters:

tiledMap - The TiledMap to extract empty spaces from

layerName - The name of the layer to extract empty spaces from. Each tile drawn in the layer is treated as a collision.

Returns:

A 2D byte array with the same width and height as the layer. [x][y] will be set to 1 if there is no collision.

mapEmptySpacesByLayer

public static byte[][] mapEmptySpacesByLayer(TiledMap tiledMap,
                                             int layerIndex)

Creates a 2D byte array representing the empty spaces (non-collisions) in a TiledMap layer

Parameters:

tiledMap - The TiledMap to extract empty spaces from

layerIndex - The index of the layer to extract empty spaces from. Each tile drawn in the layer is treated as a collision.

Returns:

A 2D byte array with the same width and height as the layer. [x][y] will be set to 1 if there is no collision.

mapCollisionsByLayer

public void mapCollisionsByLayer(QuadTree<T> quadTree,
                                 TiledMap tiledMap,
                                 int layerIndex)

Extracts collisions in a TiledMap layer and adds them to a QuadTree instance

Parameters:

quadTree - The QuadTree instance to add collisions to

tiledMap - The TiledMap to extract collisions from

layerIndex - The index of the layer to extract collisions from. Each tile drawn in the layer is treated as a collision.

mapEmptySpacesByLayer

public void mapEmptySpacesByLayer(QuadTree<T> quadTree,
                                  TiledMap tiledMap,
                                  int layerIndex)

Extracts empty spaces in a TiledMap layer and adds them to a QuadTree instance

Parameters:

quadTree - The QuadTree instance to add empty spaces to

tiledMap - The TiledMap to extract empty spaces from

layerIndex - The index of the layer to extract empty spaces from. Each tile drawn in the layer is treated as a collision.

mapCollisionsByLayer

public void mapCollisionsByLayer(java.util.List<T> results,
                                 TiledMap tiledMap,
                                 int layerIndex)

Extracts collisions in a TiledMap layer and adds them to a List instance

Parameters:

results - The List instance to add collisions to

tiledMap - The TiledMap to extract collisions from

layerIndex - The index of the layer to extract collisions from. Each tile drawn in the layer is treated as a collision.

mapEmptySpacesByLayer

public void mapEmptySpacesByLayer(java.util.List<T> results,
                                  TiledMap tiledMap,
                                  int layerIndex)

Extracts empty spaces in a TiledMap layer and adds them to a List instance

Parameters:

results - The List instance to add empty spaces to

tiledMap - The TiledMap to extract empty spaces from

layerIndex - The index of the layer to extract empty spaces from. Each tile drawn in the layer is treated as a collision.

mapCollisionsByLayer

public void mapCollisionsByLayer(QuadTree<T> quadTree,
                                 TiledMap tiledMap,
                                 java.lang.String layerName)

Extracts collisions in a TiledMap layer and adds them to a QuadTree instance

Parameters:

quadTree - The QuadTree instance to add collisions to

tiledMap - The TiledMap to extract collisions from

layerName - The name of the layer to extract collisions from. Each tile drawn in the layer is treated as a collision.

mapCollisionsByLayer

public void mapCollisionsByLayer(java.util.List<T> results,
                                 TiledMap tiledMap,
                                 java.lang.String layerName)

Extracts collisions in a TiledMap layer and adds them to a List instance

Parameters:

results - The List instance to add collisions to

tiledMap - The TiledMap to extract collisions from

layerName - The name of the layer to extract collisions from. Each tile drawn in the layer is treated as a collision.

mapEmptySpacesByLayer

public void mapEmptySpacesByLayer(QuadTree<T> quadTree,
                                  TiledMap tiledMap,
                                  java.lang.String layerName)

Extracts empty spaces in a TiledMap layer and adds them to a QuadTree instance

Parameters:

quadTree - The QuadTree instance to add empty spaces to

tiledMap - The TiledMap to extract empty spaces from

layerName - The name of the layer to extract empty spaces from. Each tile drawn in the layer is treated as a collision.

mapEmptySpacesByLayer

public void mapEmptySpacesByLayer(java.util.List<T> results,
                                  TiledMap tiledMap,
                                  java.lang.String layerName)

Extracts empty spaces in a TiledMap layer and adds them to a List instance

Parameters:

results - The List instance to add empty spaces to

tiledMap - The TiledMap to extract empty spaces from

layerName - The name of the layer to extract empty spaces from. Each tile drawn in the layer is treated as a collision.

mapCollisionsByObjectGroup

public void mapCollisionsByObjectGroup(QuadTree<T> quadTree,
                                       TiledMap tiledMap,
                                       java.lang.String groupName)

Extracts collisions in a TiledMap object group and adds them to a QuadTree instance

Parameters:

quadTree - The QuadTree instance to add collisions to

tiledMap - The TiledMap to extract collisions from

groupName - The name of the object group to extract collisions from. Each object is treated as a collision.

mapCollisionsByObjectGroup

public void mapCollisionsByObjectGroup(QuadTree<T> quadTree,
                                       TiledMap tiledMap,
                                       java.lang.String groupName,
                                       java.lang.String objectType)

Extracts collisions in a TiledMap object group that have a specific value in their type field and adds them to a QuadTree instance

Parameters:

quadTree - The QuadTree instance to add collisions to

tiledMap - The TiledMap to extract collisions from

groupName - The name of the object group to extract collisions from. Each object is treated as a collision.

objectType - The object type to extract

mapCollisionsByObjectGroup

public void mapCollisionsByObjectGroup(java.util.List<T> results,
                                       TiledMap tiledMap,
                                       java.lang.String groupName)

Extracts collisions in a TiledMap object group and adds them to a List instance

Parameters:

results - The List instance to add collisions to

tiledMap - The TiledMap to extract collisions from

groupName - The name of the object group to extract collisions from. Each object is treated as a collision.

mapCollisionsByObjectGroup

public void mapCollisionsByObjectGroup(java.util.List<T> results,
                                       TiledMap tiledMap,
                                       java.lang.String groupName,
                                       java.lang.String objectType)

Extracts collisions in a TiledMap object group that have a specific value in their type field and adds them to a List instance

Parameters:

results - The List instance to add collisions to

tiledMap - The TiledMap to extract collisions from

groupName - The name of the object group to extract collisions from. Each object is treated as a collision.

objectType - The object type to extract

mapAndMergeCollisionsByLayer

public void mapAndMergeCollisionsByLayer(QuadTree<T> quadTree,
                                         TiledMap tiledMap,
                                         java.lang.String layerName)

Extracts and merges collisions in a TiledMap layer and adds them to a QuadTree instance. Tiles are determined as mergeable by the TiledCollisionMerger instance associated with this TiledCollisionMapper.

Parameters:

quadTree - The QuadTree instance to add collisions to

tiledMap - The TiledMap to extract collisions from

layerName - The name of the layer to extract collisions from. Each tile drawn in the layer is treated as a collision.

mapAndMergeCollisionsByLayer

public void mapAndMergeCollisionsByLayer(QuadTree<T> quadTree,
                                         TiledMap tiledMap,
                                         int layerIndex)

Extracts and merges collisions in a TiledMap layer and adds them to a QuadTree instance. Tiles are determined as mergeable by the TiledCollisionMerger instance associated with this TiledCollisionMapper.

Parameters:

quadTree - The QuadTree instance to add collisions to

tiledMap - The TiledMap to extract collisions from

layerIndex - The index of the layer to extract collisions from. Each tile drawn in the layer is treated as a collision.

mapAndMergeCollisionsByLayer

public void mapAndMergeCollisionsByLayer(QuadTree<T> quadTree,
                                         TiledMap tiledMap,
                                         int layerIndex,
                                         int maxColumns,
                                         int maxRows)

Extracts and merges collisions in a TiledMap layer and adds them to a QuadTree instance. Tiles are determined as mergeable by the TiledCollisionMerger instance associated with this TiledCollisionMapper.

Parameters:

quadTree - The QuadTree instance to add collisions to

tiledMap - The TiledMap to extract collisions from

layerIndex - The index of the layer to extract collisions from. Each tile drawn in the layer is treated as a collision.

maxColumns - The maximum number of columns to merge

maxRows - The maximum number of rows to merge

mapAndMergeEmptySpacesByLayer

public void mapAndMergeEmptySpacesByLayer(QuadTree<T> quadTree,
                                          TiledMap tiledMap,
                                          java.lang.String layerName)

Extracts and merges empty spaces in a TiledMap layer and adds them to a QuadTree instance. Tiles are determined as mergeable by the TiledCollisionMerger instance associated with this TiledCollisionMapper.

Parameters:

quadTree - The QuadTree instance to add empty spaces to

tiledMap - The TiledMap to extract empty spaces from

layerName - The name of the layer to extract empty spaces from. Each tile drawn in the layer is treated as a collision.

mapAndMergeEmptySpacesByLayer

public void mapAndMergeEmptySpacesByLayer(QuadTree<T> quadTree,
                                          TiledMap tiledMap,
                                          int layerIndex)

Extracts and merges empty spaces in a TiledMap layer and adds them to a QuadTree instance. Tiles are determined as mergeable by the TiledCollisionMerger instance associated with this TiledCollisionMapper.

Parameters:

quadTree - The QuadTree instance to add empty spaces to

tiledMap - The TiledMap to extract empty spaces from

layerIndex - The index of the layer to extract empty spaces from. Each tile drawn in the layer is treated as a collision.

mapAndMergeEmptySpacesByLayer

public void mapAndMergeEmptySpacesByLayer(QuadTree<T> quadTree,
                                          TiledMap tiledMap,
                                          int layerIndex,
                                          int maxColumns,
                                          int maxRows)

Extracts and merges empty spaces in a TiledMap layer and adds them to a QuadTree instance. Tiles are determined as mergeable by the TiledCollisionMerger instance associated with this TiledCollisionMapper.

Parameters:

quadTree - The QuadTree instance to add empty spaces to

tiledMap - The TiledMap to extract empty spaces from

layerIndex - The index of the layer to extract empty spaces from. Each tile drawn in the layer is treated as a collision.

maxColumns - The maximum number of columns to merge

maxRows - The maximum number of rows to merge

mapAndMergeCollisionsByLayer

public void mapAndMergeCollisionsByLayer(java.util.List<T> results,
                                         TiledMap tiledMap,
                                         java.lang.String layerName)

Extracts and merges collisions in a TiledMap layer and adds them to a List instance. Tiles are determined as mergeable by the TiledCollisionMerger instance associated with this TiledCollisionMapper.

Parameters:

results - The List instance to add collisions to

tiledMap - The TiledMap to extract collisions from

layerName - The name of the layer to extract collisions from. Each tile drawn in the layer is treated as a collision.

mapAndMergeCollisionsByLayer

public void mapAndMergeCollisionsByLayer(java.util.List<T> results,
                                         TiledMap tiledMap,
                                         int layerIndex)

Extracts and merges collisions in a TiledMap layer and adds them to a List instance. Tiles are determined as mergeable by the TiledCollisionMerger instance associated with this TiledCollisionMapper.

Parameters:

results - The List instance to add collisions to

tiledMap - The TiledMap to extract collisions from

layerIndex - The index of the layer to extract collisions from. Each tile drawn in the layer is treated as a collision.

mapAndMergeCollisionsByLayer

public void mapAndMergeCollisionsByLayer(java.util.List<T> results,
                                         TiledMap tiledMap,
                                         int layerIndex,
                                         int maxColumns,
                                         int maxRows)

Extracts and merges collisions in a TiledMap layer and adds them to a List instance. Tiles are determined as mergeable by the TiledCollisionMerger instance associated with this TiledCollisionMapper.

Parameters:

results - The List instance to add collisions to

tiledMap - The TiledMap to extract collisions from

layerIndex - The index of the layer to extract collisions from. Each tile drawn in the layer is treated as a collision.

maxColumns - The maximum number of columns to merge

maxRows - The maximum number of rows to merge

mapAndMergeEmptySpacesByLayer

public void mapAndMergeEmptySpacesByLayer(java.util.List<T> results,
                                          TiledMap tiledMap,
                                          java.lang.String layerName)

Extracts and merges empty spaces in a TiledMap layer and adds them to a List instance. Tiles are determined as mergeable by the TiledCollisionMerger instance associated with this TiledCollisionMapper.

Parameters:

results - The List instance to add empty spaces to

tiledMap - The TiledMap to extract empty spaces from

layerName - The name of the layer to extract empty spaces from. Each tile drawn in the layer is treated as a collision.

mapAndMergeEmptySpacesByLayer

public void mapAndMergeEmptySpacesByLayer(java.util.List<T> results,
                                          TiledMap tiledMap,
                                          int layerIndex)

Extracts and merges empty spaces in a TiledMap layer and adds them to a List instance. Tiles are determined as mergeable by the TiledCollisionMerger instance associated with this TiledCollisionMapper.

Parameters:

results - The List instance to add empty spaces to

tiledMap - The TiledMap to extract empty spaces from

layerIndex - The index of the layer to extract empty spaces from. Each tile drawn in the layer is treated as a collision.

mapAndMergeEmptySpacesByLayer

public void mapAndMergeEmptySpacesByLayer(java.util.List<T> results,
                                          TiledMap tiledMap,
                                          int layerIndex,
                                          int maxColumns,
                                          int maxRows)

Extracts and merges empty spaces in a TiledMap layer and adds them to a List instance. Tiles are determined as mergeable by the TiledCollisionMerger instance associated with this TiledCollisionMapper.

Parameters:

results - The List instance to add empty spaces to

tiledMap - The TiledMap to extract empty spaces from

layerIndex - The index of the layer to extract empty spaces from. Each tile drawn in the layer is treated as a collision.

maxColumns - The maximum number of columns to merge

maxRows - The maximum number of rows to merge