Class: SMap_Object_Point

Source Location: /SMap/Object.php

Class SMap_Object_Point

Class Overview

A point on a map

Displays a pixel

SMap_Object
   |
   --SMap_Object_Point

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From SMap_Object

SMap_Object::$alt

SMap_Object::$label

SMap_Object::$layer

SMap_Object::$map

SMap_Object::$tile

SMap_Object::$url

SMap_Object::$view

Inherited From SMap_Object

SMap_Object::__construct()

Give the object a context

SMap_Object::applyTile()

Apply a tile to this object

SMap_Object::draw()

Draw this object on a canvas

SMap_Object::getInnerBounds()

Get the rough inner rectangular bounds for this object.

SMap_Object::label()

Are we drawing a label for this object?

SMap_Object::map()

Return a map of this object

SMap_Object::setColor()

Set the color for this object

SMap_Object::setLink()

Set this to link to something

[ Top ]

Property Summary

array	$color	Color of point
float	$x	Location of the point
mixed	$y

[ Top ]

Method Summary

SMap_Object_Point	__construct()	Set the location of the point
boolean	applyTile()	Apply a tile to this point
void	draw()	Set a pixel on the canvas
array	getInnerBounds()	Return the bounds of the point
void	label()
array	map()	A pixel gives nothing to work with

[ Top ]

Properties

array $color = array(255,0,0) [line 237]

Color of point

Defaults to red

API Tags:

Access:

protected

Redefinition of:

SMap_Object::$color: The color

[ Top ]

float $x = null [line 227]

Location of the point

In SMap Units.

API Tags:

Access:

protected

[ Top ]

mixed $y = null [line 228]

API Tags:

Access:

protected

[ Top ]

Methods

Constructor __construct [line 244]

SMap_Object_Point __construct(
SMap_View
$view, SMap_Layer
$layer, 
$x, 
$y 
)

Set the location of the point

Parameters:

object The	$view:	view that this object is attached to
SMap_Layer	$layer:
	$x:
	$y:

Redefinition of:

SMap_Object::__construct(): Give the object a context

[ Top ]

applyTile [line 280]

boolean applyTile(
SMap_Tile
$tile 
)

Apply a tile to this point

Parameters:

object

$tile:

API Tags:

Access:

public

Redefinition of:

SMap_Object::applyTile(): Apply a tile to this object

[ Top ]

draw [line 298]

void draw(
SMap_Canvas
$canvas 
)

Set a pixel on the canvas

Alone, it won't be noticable, but if you draw many, you might have something.

Parameters:

object

$canvas:

API Tags:

Access:

public

Redefinition of:

SMap_Object::draw(): Draw this object on a canvas

[ Top ]

getInnerBounds [line 257]

array getInnerBounds(
)

Return the bounds of the point

Expands the point by a pixel in each direction

API Tags:

Return:	Bounding array
Access:	public

Redefinition of:

SMap_Object::getInnerBounds(): Get the rough inner rectangular bounds for this object.

[ Top ]

label [line 269]

void label(
SMap_Object_Area_Label
$label 
)

Parameters:

SMap_Object_Area_Label

$label:

API Tags:

Access:

public

Redefinition of:

SMap_Object::label(): Are we drawing a label for this object?

[ Top ]

map [line 315]

array map(
)

A pixel gives nothing to work with

So, an empty array is returned.

API Tags:

Return:	Nothing
Access:	public

Redefinition of:

SMap_Object::map(): Return a map of this object

[ Top ]

Documentation generated on Mon, 09 Apr 2007 18:55:05 -0500 by phpDocumentor 1.3.0

	SMap Objects

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