Class: SMap_Layer_Pan

Source Location: /SMap/Layer.php

Class SMap_Layer_Pan

Class Overview

Navigational elements for panning across a map

SMap_Layer
   |
   --SMap_Layer_Pan

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From SMap_Layer

SMap_Layer::$id

SMap_Layer::$map

Inherited From SMap_Layer

SMap_Layer::__construct()

Construct the layer

SMap_Layer::cacheStatus()

How cachable is this layer?

SMap_Layer::getAdjViewBounds()

Adjust the view coords if we are in an image

SMap_Layer::getID()

Returns the ID of this layer

SMap_Layer::getImageFmt()

Recommended format for this layer

SMap_Layer::getImgObjs()

Composite this layer onto the tile (in a raster way)

SMap_Layer::getMap()

Return the map that contains this layer

SMap_Layer::getMapObjs()

Composite this layer onto the tile

SMap_Layer::hasCachedRects()

Might have cached rects in the DB

SMap_Layer::isValidZoom()

Is this layer zoomed to a useful resolution?

SMap_Layer::pxOffBound()

Get the bound at a pixel offset from a bound.

[ Top ]

Method Summary

void	allocNav()	Allocate set of nav objects
void	allocNavObjs()	Create panning objects
array	getCardLink()	Create a link in a cardinal direction
array	getDiagLink()	Create a link in a diagonal direction
array	getImgObjs()	Put panning navigational graphics and links around the edges
array	getMapObjs()	We need to move.
string	getShiftedURL()	Get a URL for a shifted view
boolean	hasCachedRects()	The panning layer has no cached rects

[ Top ]

Properties

Methods

allocNav [line 1728]

void allocNav(
SMap_View
$view, SMap_Tile
$tile, array
&$objs, integer
$i1, integer
$i2, integer
$i3, integer
$i4 
)

Allocate set of nav objects

Parameters:

object	$view:
object	$tile:
array	&$objs:	Append objects to this array
integer	$i1:	Direction index 1
integer	$i2:	Direction index 2
integer	$i3:	Direction index 3
integer	$i4:	Direction index 4

API Tags:

Access:

protected

[ Top ]

allocNavObjs [line 1800]

void allocNavObjs(
SMap_View
$view, SMap_Tile
$tile 
)

Create panning objects

Parameters:

object	$view:
object	$tile:

API Tags:

Access:

protected

[ Top ]

getCardLink [line 1684]

array getCardLink(
SMap_View
$v, integer
$dir 
)

Create a link in a cardinal direction

Parameters:

object	$v:
integer	$dir:	Link direction

API Tags:

Return:	Link URL & text
Access:	protected

[ Top ]

getDiagLink [line 1704]

array getDiagLink(
SMap_View
$v, integer
$right 
)

Create a link in a diagonal direction

Parameters:

object	$v:
integer	$right:	Link direction

API Tags:

Return:	Link URL & text
Access:	protected

[ Top ]

getImgObjs [line 1848]

array getImgObjs(
SMap_View
$view, SMap_Tile
$tile 
)

Put panning navigational graphics and links around the edges

Parameters:

object The	$view:	view to display the objects in
object The	$tile:	tile to display the objects in

API Tags:

Access:

public

Redefinition of:

SMap_Layer::getImgObjs(): Composite this layer onto the tile (in a raster way)

[ Top ]

getMapObjs [line 1837]

array getMapObjs(
SMap_View
$view, SMap_Tile
$tile 
)

We need to move.

Parameters:

object The	$view:	view to display the objects in
object The	$tile:	tile to display the objects in

API Tags:

Access:

public

Redefinition of:

SMap_Layer::getMapObjs(): Composite this layer onto the tile

[ Top ]

getShiftedURL [line 1642]

string getShiftedURL(
SMap_View
$view, integer
$sX, integer
$sY 
)

Get a URL for a shifted view

Parameters:

object	$view:
integer	$sX:	Shifted X
integer	$sY:	Shifted Y

API Tags:

Return:	URL
Access:	protected
Uses:	SMap_Util::wrapBounds()
Uses:	SMap_Form::getPageLink()
Uses:	$shiftMult

[ Top ]

hasCachedRects [line 1857]

boolean hasCachedRects(
)

The panning layer has no cached rects

API Tags:

Access:

public

Redefinition of:

SMap_Layer::hasCachedRects(): Might have cached rects in the DB

[ Top ]

Documentation generated on Mon, 09 Apr 2007 18:53:20 -0500 by phpDocumentor 1.3.0

	SMap Layers

[ class tree: SMap ] [ index: SMap ] [ all elements ]