Class: SMap_Object_Line

Source Location: /SMap/Object.php

Class SMap_Object_Line

Class Overview

A line between two points

The line can include a grid line, part of a path, or a boundary line.

SMap_Object
   |
   --SMap_Object_Line

Properties

Methods

[ Top ]

Direct descendents

Child Class	Description
SMap_Object_Line_Path	A path that connects a series of points
SMap_Object_Line_Boundary	A boundary line

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From SMap_Object

SMap_Object::$alt

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

mixed	$color
mixed	$label
boolean	$locked	Lock this when we start retrieving data from it
array	$points	Beginning and end of the line

[ Top ]

Method Summary

SMap_Object_Line	__construct()	Construct with the beginning and end of the line
void	applyTile()
void	draw()
void	extend()	Extends this line
array	getInnerBounds()
void	label()	Place the label on the line
void	map()

[ Top ]

Properties

mixed $color = array(0,0,0,null) [line 346]

API Tags:

Access:

protected

Redefinition of:

SMap_Object::$color: The color

[ Top ]

mixed $label = null [line 347]

API Tags:

Access:

protected

Redefinition of:

SMap_Object::$label: Are we labeling this object?

[ Top ]

boolean $locked = false [line 341]

Lock this when we start retrieving data from it

API Tags:

Access:

protected

[ Top ]

array $points = array() [line 334]

Beginning and end of the line

API Tags:

Access:

protected

[ Top ]

Methods

Constructor __construct [line 352]

SMap_Object_Line __construct(
SMap_View
$view, SMap_Layer
$layer, 
$begX, 
$begY, 
$endX, 
$endY 
)

Construct with the beginning and end of the line

Parameters:

SMap_View	$view:
SMap_Layer	$layer:
	$begX:
	$begY:
	$endX:
	$endY:

Redefinition of:

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

[ Top ]

applyTile [line 404]

void applyTile(
SMap_Tile
$tile 
)

Parameters:

SMap_Tile

$tile:

API Tags:

Access:

public

Redefinition of:

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

Redefined in descendants as:

[ Top ]

draw [line 413]

void draw(
SMap_Canvas
$canvas 
)

Parameters:

SMap_Canvas

$canvas:

API Tags:

Access:

public

Redefinition of:

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

Redefined in descendants as:

[ Top ]

extend [line 366]

void extend(
float
$x, float
$y 
)

Extends this line

Parameters:

float	$x:	Next X coord
float	$y:	Next Y coord

API Tags:

Access:

public

[ Top ]

getInnerBounds [line 376]

array getInnerBounds(
)

API Tags:

Return:	A reasonable inner bounds
Access:	public

Redefinition of:

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

[ Top ]

label [line 397]

void label(
SMap_Object_Area_Label
$label 
)

Place the label on the line

Parameters:

SMap_Object_Area_Label

$label:

API Tags:

Access:

public

Redefinition of:

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

Redefined in descendants as:

SMap_Object_Line_Boundary::label()

[ Top ]

map [line 458]

void map(
)

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

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

	SMap Objects

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