.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Tirex::Map 3pm"
.TH Tirex::Map 3pm 2024-05-06 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Tirex::Map \- A Tirex map configuration
.SH SYNOPSIS
.IX Header "SYNOPSIS"
my \f(CW$map\fR = Tirex::Map\->\fBnew()\fR;
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A Tirex map configuration. It always contains the name, tile directory and zoom
range for this map. Depending on the backend there can be more options.
.SH METHODS
.IX Header "METHODS"
.SS Tirex::Map\->get('foo')
.IX Subsection "Tirex::Map->get('foo')"
Get map by name.
.SS Tirex::Map\->\fBclear()\fP;
.IX Subsection "Tirex::Map->clear();"
Clear list of maps.
.SS Tirex::Map\->get_map_for_metatile($metatile)
.IX Subsection "Tirex::Map->get_map_for_metatile($metatile)"
Get map for a metatile.
.PP
Will croak if the map named in the metatile does not exist. Will also croak if
the zoom given in the metatile is out of range.
.SS "Tirex::Map\->new( ... )"
.IX Subsection "Tirex::Map->new( ... )"
Create new map configuration.
.PP
Default values for minimum zoom (minz) is 0, for maximum zoom (maxz) it's 17.
.ie n .SS "Tirex::Map\->new_from_configfile($filename, $renderer)"
.el .SS "Tirex::Map\->new_from_configfile($filename, \f(CW$renderer\fP)"
.IX Subsection "Tirex::Map->new_from_configfile($filename, $renderer)"
Create new map config from a file for a given renderer.
.PP
Croaks if the file does not exist.
.ie n .SS $map\->\fBget_name()\fP
.el .SS \f(CW$map\fP\->\fBget_name()\fP
.IX Subsection "$map->get_name()"
Get name of this map.
.ie n .SS $map\->\fBget_renderer()\fP
.el .SS \f(CW$map\fP\->\fBget_renderer()\fP
.IX Subsection "$map->get_renderer()"
Get renderer of this map.
.ie n .SS $map\->\fBget_filename()\fP
.el .SS \f(CW$map\fP\->\fBget_filename()\fP
.IX Subsection "$map->get_filename()"
Get filename of config file for this map. This only works if the map was
created from a config file. Otherwise it will return undef.
.ie n .SS $map\->\fBget_tiledir()\fP
.el .SS \f(CW$map\fP\->\fBget_tiledir()\fP
.IX Subsection "$map->get_tiledir()"
Get tile directory of this map.
.ie n .SS $map\->\fBget_minz()\fP
.el .SS \f(CW$map\fP\->\fBget_minz()\fP
.IX Subsection "$map->get_minz()"
Get minimum zoom value of this map.
.ie n .SS $map\->\fBget_maxz()\fP
.el .SS \f(CW$map\fP\->\fBget_maxz()\fP
.IX Subsection "$map->get_maxz()"
Get maximum zoom of this map.
.ie n .SS $map\->\fBto_s()\fP;
.el .SS \f(CW$map\fP\->\fBto_s()\fP;
.IX Subsection "$map->to_s();"
Return human readable description of this map.
.ie n .SS $map\->\fBto_hash()\fP;
.el .SS \f(CW$map\fP\->\fBto_hash()\fP;
.IX Subsection "$map->to_hash();"
Return parameters of this map as hash.
.SS Tirex::Map\->\fBstatus()\fP;
.IX Subsection "Tirex::Map->status();"
Return status of all configured maps.