Group extends TileLayer implements GroupContainer, PropertyBagHolder Uses PropertyBagTrait
A group layer, used to organize the layers of the map in a hierarchy.
Tags
Interfaces, Classes and Traits
- GroupContainer
- A group container provides different data holder objects.
- PropertyBagHolder
- Interface for all elements, which contains properties.
Table of Contents
- $groups : array<string|int, mixed>
- $id : int|null
- Unique ID of the layer.
- $imageLayers : array<string|int, mixed>
- $layers : array<string|int, mixed>
- $map : Map|null
- The map object, which holds this layer.
- $name : string|null
- The name of the layer.
- $objectLayers : array<string|int, mixed>
- $offsetX : float
- Horizontal offset for this layer in pixels. Defaults to 0.
- $offsetY : float
- Vertical offset for this layer in pixels. Defaults to 0.
- $opacity : float|null
- The opacity of the layer as a value from 0 to 1.
- $propertyBag : PropertyBag|null
- $tintColor : string|null
- A color that is multiplied with any tiles drawn by this layer in #AARRGGBB or #RRGGBB format.
- $visible : bool
- Whether the layer is shown (1) or hidden (0).
- addGroup() : self
- addImageLayer() : self
- addLayer() : self
- addObjectLayer() : self
- getGroups() : array<string|int, Group>
- getId() : int|null
- getImageLayers() : array<string|int, ImageLayer>
- getLayers() : array<string|int, Layer>
- getMap() : Map|null
- getName() : string|null
- getObjectLayers() : array<string|int, ObjectLayer>
- getOffsetX() : float
- getOffsetY() : float
- getOpacity() : float|null
- getPropertyBag() : PropertyBag|null
- getTintColor() : string|null
- isVisible() : bool
- removeGroup() : self
- removeImageLayer() : self
- removeLayer() : self
- removeObjectLayer() : self
- setId() : TileLayer
- setMap() : TileLayer
- setName() : TileLayer
- setOffsetX() : TileLayer
- setOffsetY() : TileLayer
- setOpacity() : TileLayer
- setPropertyBag() : self
- setTintColor() : TileLayer
- setVisible() : TileLayer
Properties
$groups
private
array<string|int, mixed>
$groups
= []
$id
Unique ID of the layer.
private
int|null
$id
= null
Tags
$imageLayers
private
array<string|int, mixed>
$imageLayers
= []
$layers
private
array<string|int, mixed>
$layers
= []
$map
The map object, which holds this layer.
private
Map|null
$map
Tags
$name
The name of the layer.
private
string|null
$name
= null
Tags
$objectLayers
private
array<string|int, mixed>
$objectLayers
= []
$offsetX
Horizontal offset for this layer in pixels. Defaults to 0.
private
float
$offsetX
= 0.0
Tags
$offsetY
Vertical offset for this layer in pixels. Defaults to 0.
private
float
$offsetY
= 0.0
Tags
$opacity
The opacity of the layer as a value from 0 to 1.
private
float|null
$opacity
= 1.0
Tags
$propertyBag
private
PropertyBag|null
$propertyBag
= null
Tags
$tintColor
A color that is multiplied with any tiles drawn by this layer in #AARRGGBB or #RRGGBB format.
private
string|null
$tintColor
= null
Tags
$visible
Whether the layer is shown (1) or hidden (0).
private
bool
$visible
= true
Tags
Methods
addGroup()
public
addGroup(Group $group) : self
Parameters
- $group : Group
Return values
self —addImageLayer()
public
addImageLayer(ImageLayer $imageLayer) : self
Parameters
- $imageLayer : ImageLayer
Return values
self —addLayer()
public
addLayer(Layer $layer) : self
Parameters
- $layer : Layer
Return values
self —addObjectLayer()
public
addObjectLayer(ObjectLayer $objectLayer) : self
Parameters
- $objectLayer : ObjectLayer
Return values
self —getGroups()
public
getGroups() : array<string|int, Group>
Return values
array<string|int, Group> —getId()
public
getId() : int|null
Return values
int|null —getImageLayers()
public
getImageLayers() : array<string|int, ImageLayer>
Return values
array<string|int, ImageLayer> —getLayers()
public
getLayers() : array<string|int, Layer>
Return values
array<string|int, Layer> —getMap()
public
getMap() : Map|null
Return values
Map|null —getName()
public
getName() : string|null
Return values
string|null —getObjectLayers()
public
getObjectLayers() : array<string|int, ObjectLayer>
Return values
array<string|int, ObjectLayer> —getOffsetX()
public
getOffsetX() : float
Return values
float —getOffsetY()
public
getOffsetY() : float
Return values
float —getOpacity()
public
getOpacity() : float|null
Return values
float|null —getPropertyBag()
public
getPropertyBag() : PropertyBag|null
Return values
PropertyBag|null —getTintColor()
public
getTintColor() : string|null
Return values
string|null —isVisible()
public
isVisible() : bool
Return values
bool —removeGroup()
public
removeGroup(Group $group) : self
Parameters
- $group : Group
Return values
self —removeImageLayer()
public
removeImageLayer(ImageLayer $imageLayer) : self
Parameters
- $imageLayer : ImageLayer
Return values
self —removeLayer()
public
removeLayer(Layer $layer) : self
Parameters
- $layer : Layer
Return values
self —removeObjectLayer()
public
removeObjectLayer(ObjectLayer $objectLayer) : self
Parameters
- $objectLayer : ObjectLayer
Return values
self —setId()
public
setId(int|null $id) : TileLayer
Parameters
- $id : int|null
Return values
TileLayer —setMap()
public
setMap(Map|null $map) : TileLayer
Parameters
- $map : Map|null
Return values
TileLayer —setName()
public
setName(string|null $name) : TileLayer
Parameters
- $name : string|null
Return values
TileLayer —setOffsetX()
public
setOffsetX(float $offsetX) : TileLayer
Parameters
- $offsetX : float
Return values
TileLayer —setOffsetY()
public
setOffsetY(float $offsetY) : TileLayer
Parameters
- $offsetY : float
Return values
TileLayer —setOpacity()
public
setOpacity(float|null $opacity) : TileLayer
Parameters
- $opacity : float|null
Return values
TileLayer —setPropertyBag()
public
setPropertyBag(PropertyBag|null $propertyBag) : self
Parameters
- $propertyBag : PropertyBag|null
Return values
self —setTintColor()
public
setTintColor(string|null $tintColor) : TileLayer
Parameters
- $tintColor : string|null
Return values
TileLayer —setVisible()
public
setVisible(bool $visible) : TileLayer
Parameters
- $visible : bool