Class: Point

Source Location: /common/BasicTypes.php

Class Overview

CwSerializable
   |
   --Shape
      |
      --Point

A single point

Author(s):

Sylvain Pasche <sylvain.pasche@camptocamp.com>

Variables

Methods

Inherited Variables

Class: CwSerializable

CwSerializable::$className

Inherited Methods

Class: Shape

Shape::getArea(): Computes the shape's area
Shape::getCenter(): Computes the shape's center
Shape::unserialize()

Class: CwSerializable

CwSerializable::__construct(): Constructor
CwSerializable::copyAllVars(): Copy all properties from one object to another (overwriting previous ones)
CwSerializable::getValue(): Returns structure's property value if property exists
CwSerializable::guessClassName(): Tries to guess the class to use from the property being unserialised.
CwSerializable::unserialize(): Unserializes from a stdClass structure
CwSerializable::unserializeArray(): Returns an array of typed values
CwSerializable::unserializeObject(): Returns an unserialized object from a stdClass structure
CwSerializable::unserializeObjectMap(): Returns an array of unserialized objects from a stdClass structure
CwSerializable::unserializeStringArray(): Returns an array of typed values from a string
CwSerializable::unserializeValue(): Returns a typed value from a structure property

Class Details

[line 131]
A single point

Tags:

author:

Sylvain Pasche <sylvain.pasche@camptocamp.com>

[ Top ]

Class Variables

$x =

[line 136]

Tags:

access:

public

Type:

double

[ Top ]

$y =

[line 141]

Tags:

access:

public

Type:

double

[ Top ]

Class Methods

constructor __construct [line 148]

Point __construct(
[double
$x = 0], [double
$y = 0])

Constructor

Tags:

access:

public

Overrides CwSerializable::__construct() (Constructor)

Parameters:

double	$x
double	$y

[ Top ]

method getArea [line 199]

double getArea(
)

Tags:

access:	public
see:	Shape::getArea()

Overrides Shape::getArea() (Computes the shape's area)

[ Top ]

method getCenter [line 189]

void getCenter(
)

Tags:

access:	public
see:	Shape::getCenter()

Overrides Shape::getCenter() (Computes the shape's center)

[ Top ]

method getX [line 166]

double getX(
)

Tags:

access:

public

[ Top ]

method getY [line 173]

double getY(
)

Tags:

access:

public

[ Top ]

method setXY [line 181]

void setXY(
double
$x, double
$y)

Tags:

access:

public

Parameters:

double	$x
double	$y

[ Top ]

method toBbox [line 210]

Bbox toBbox(
[double
$margin = 0])

Converts the Point to a Bbox

Optional margin will create a square around the point.

Tags:

return:	the Point converted to Bbox
access:	public

Parameters:

double

$margin

the margin

[ Top ]

method unserialize [line 157]

void unserialize(
mixed
$struct)

Tags:

access:	public
see:	CwSerializable::unserialize()

Overrides Shape::unserialize() (parent method not documented)

[ Top ]

Documentation generated on Fri, 21 Sep 2007 13:30:31 +0200 by phpDocumentor 1.3.0RC3