linea21-externals
[ class tree: linea21-externals ] [ index: linea21-externals ] [ all elements ]

Class: awPolygon

Source Location: /class/system/artichow/php5/inc/Math.class.php

Class Overview

awShape
   |
   --awPolygon

Describe a polygon


Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: awShape

awShape::getStyle()
Return shape style
awShape::getThickness()
Return shape thickness
awShape::hide()
Hide the shape
awShape::isHidden()
Is the line hidden ?
awShape::setStyle()
Change shape style
awShape::setThickness()
Change shape thickness
awShape::show()
Show the shape

Class Details

[line 716]
Describe a polygon



[ Top ]


Class Variables

$points = array()

[line 723]

Polygon points



Tags:

access:  protected

Type:   array


[ Top ]



Class Methods


method all [line 772]

array all( )

Returns all points in the polygon



Tags:

access:  public


[ Top ]

method append [line 742]

void append( awPoint $point)

Add a point at the end of the polygon



Tags:

access:  public


Parameters:

awPoint   $point  

[ Top ]

method count [line 763]

int count( )

Count number of points in the polygon



Tags:

access:  public


[ Top ]

method get [line 754]

Point get( int $pos)

Get a point at a position in the polygon



Tags:

access:  public


Parameters:

int   $pos   Point position

[ Top ]

method getBoxPoints [line 801]

array getBoxPoints( )

Get the upper-left and lower-right points of the bounding box around the polygon



Tags:

return:  An array of two Point objects
access:  public


[ Top ]

method getBoxXRange [line 838]

array getBoxXRange( )

Return the range of the polygon on the x axis, i.e. the minimum and maximum x value of any point in the polygon



Tags:

access:  public


[ Top ]

method getBoxYRange [line 823]

array getBoxYRange( )

Return the range of the polygon on the y axis, i.e. the minimum and maximum y value of any point in the polygon



Tags:

access:  public


[ Top ]

method getLines [line 781]

array getLines( )

Returns the different lines formed by the polygon vertices



Tags:

access:  public


[ Top ]

method set [line 731]

void set( int $pos, awPoint $point)

Set a point in the polygon



Tags:

access:  public


Parameters:

int   $pos   Point position
awPoint   $point  

[ Top ]


Documentation generated on Thu, 03 May 2012 15:06:12 +0200 by phpDocumentor 1.4.1