Docs For Class SMap

Class Overview

Controls geographic charicteristics of the view

The user of the library will implement these to return appropriate numbers for whatever coordinate system this is being used in. Also sets geographical defaults.

Located in /SMap.php [line 1374]

Author(s):

API Tags:

Abstract:

Methods

[ Top ]

Methods

bearing [line 1406]

object SMap_Object_Line bearing(
SMap_Object_Point
$start, float
$dist, float
$bearing 
)

Return a line that has followed a bearing from a point

Parameters:

object SMap_Object_Point	$start:
float	$dist:	Distance in meters
float	$bearing:	Angle in radians

API Tags:

Access:	public
Abstract:

[ Top ]

distBetween [line 1388]

void distBetween(
SMap_Object_Point
$p1, SMap_Object_Point
$p2 
)

Give the distance between two points in meters

Parameters:

object First	$p1:	point
object Second	$p2:	point

API Tags:

Access:	public
Abstract:

[ Top ]

follow [line 1396]

void follow(

$path, float
$dist 
)

Return a point that has followed a path for a distance

Parameters:

object SMap_Object_Path	$path:
float	$dist:	Distance in meters

API Tags:

Access:	public
Abstract:

[ Top ]

getMaxZoom [line 1380]

integer getMaxZoom(
)

Get the maximum zoom level

API Tags:

Access:	public
Abstract:

[ Top ]

getWrap [line 1432]

array getWrap(
)

Get globe wrapping information

Does this map wrap? On what bounds does it wrap? This should return an array of bounds which are wrapped.

API Tags:

Return:	Wrapping information
Usedby:	SMap::__construct()
Access:	public
Abstract:

[ Top ]

pretty [line 1439]

string pretty(

$val, 
$side 
)

Return a nicely printed coordinate

Parameters:

	$val:
	$side:

API Tags:

Return:	Coordinate text
Access:	public
Abstract:

[ Top ]

zoomFctr [line 1422]

array zoomFctr(
integer
$zoomNum 
)

Get the zoom factor

At the chosen zoom number, one pixel equals how many SMap Units?

(SMap Units per pixel)

This number should be zero or a positive integer. Zero is zoomed in all the way.

Parameters:

integer

$zoomNum:

Zoom number

API Tags:

Return:	Scaling factor X,Y
Usedby:	SMap::__construct()
Access:	public
Abstract:
See:	SMap_Form::setDefaults()

[ Top ]

Class: SMap_Geo

Class SMap_Geo