\Tazorax\MathUtils\TwoDRectangle

Represents a rectangle (geometric form)

Summary

Methods

Properties

Constants

__construct()
addPoint()
getPoint()
setPoint()
pointsCount()
getPerimeter()
translate()
getPointA()
setPointA()
getPointB()
setPointB()
getPointC()
setPointC()
getPointD()
setPointD()

No public properties found

COMPARAISON_PRECISION
A_POINT
B_POINT
C_POINT
D_POINT

No protected methods found

$_points

N/A

checkPoints()

No private properties found

N/A

File: TwoD/Rectangle.php
Package: MathUtils\TwoD
Class hierarchy: \Tazorax\MathUtils\TwoD\Polygon

\Tazorax\MathUtils\TwoD\Rectangle

Constants

COMPARAISON_PRECISION

COMPARAISON_PRECISION

Precision of size comparison

A_POINT

A_POINT

A point

B_POINT

B_POINT

B point

C_POINT

C_POINT

C point

D_POINT

D_POINT

D point

Properties

$_points

$_points : array<mixed,\Tazorax\MathUtils\TwoD\Point2d>

Type

array<mixed,\Tazorax\MathUtils\TwoD\Point2d>

Methods

__construct()

__construct(\Tazorax\MathUtils\TwoD\Point2d  $pointA, \Tazorax\MathUtils\TwoD\Point2d  $pointB, \Tazorax\MathUtils\TwoD\Point2d  $pointC, \Tazorax\MathUtils\TwoD\Point2d  $pointD)

Rectangle constructor.

Parameters

\Tazorax\MathUtils\TwoD\Point2d	$pointA	A point
\Tazorax\MathUtils\TwoD\Point2d	$pointB	B point
\Tazorax\MathUtils\TwoD\Point2d	$pointC	C point
\Tazorax\MathUtils\TwoD\Point2d	$pointD	D point

Throws

\Tazorax\MathUtils\Exception

addPoint()

addPoint(\Tazorax\MathUtils\TwoD\Point2d  $point) : \Tazorax\MathUtils\TwoD\Polygon

Add point

Parameters

\Tazorax\MathUtils\TwoD\Point2d

$point

Throws

\Tazorax\MathUtils\Exception

Returns

\Tazorax\MathUtils\TwoD\Polygon

Tags

inheritdoc

pointsCount()

pointsCount() : integer

Get the number of points in this polygon

Returns

integer

getPerimeter()

getPerimeter() : float

Get perimeter

Throws

\Tazorax\MathUtils\Exception

Returns

float

translate()

translate(\Tazorax\MathUtils\TwoD\Vector2d  $vector) : \Tazorax\MathUtils\TwoD\Polygon

Apply a vector on each point and return a new instance of Polygon

Parameters

\Tazorax\MathUtils\TwoD\Vector2d

$vector

Returns

\Tazorax\MathUtils\TwoD\Polygon

getPointA()

getPointA() : \Tazorax\MathUtils\TwoD\Point2d

Get A point

Returns

\Tazorax\MathUtils\TwoD\Point2d

setPointA()

setPointA(\Tazorax\MathUtils\TwoD\Point2d  $point) : \Tazorax\MathUtils\TwoD\Rectangle

Set A point

Parameters

\Tazorax\MathUtils\TwoD\Point2d

$point

Returns

\Tazorax\MathUtils\TwoD\Rectangle

getPointB()

getPointB() : \Tazorax\MathUtils\TwoD\Point2d

Get B point

Returns

\Tazorax\MathUtils\TwoD\Point2d

setPointB()

setPointB(\Tazorax\MathUtils\TwoD\Point2d  $point) : \Tazorax\MathUtils\TwoD\Rectangle

Set B point

Parameters

\Tazorax\MathUtils\TwoD\Point2d

$point

Returns

\Tazorax\MathUtils\TwoD\Rectangle

getPointC()

getPointC() : \Tazorax\MathUtils\TwoD\Point2d

Get C point

Returns

\Tazorax\MathUtils\TwoD\Point2d

setPointC()

setPointC(\Tazorax\MathUtils\TwoD\Point2d  $point) : \Tazorax\MathUtils\TwoD\Rectangle

Set C point

Parameters

\Tazorax\MathUtils\TwoD\Point2d

$point

Returns

\Tazorax\MathUtils\TwoD\Rectangle

getPointD()

getPointD() : \Tazorax\MathUtils\TwoD\Point2d

Get D point

Returns

\Tazorax\MathUtils\TwoD\Point2d

setPointD()

setPointD(\Tazorax\MathUtils\TwoD\Point2d  $point) : \Tazorax\MathUtils\TwoD\Rectangle

Set D point

Parameters

\Tazorax\MathUtils\TwoD\Point2d

$point

Returns

\Tazorax\MathUtils\TwoD\Rectangle

checkPoints()

checkPoints()

Checks if it is a polygon (with 3 points min.)

Throws

\Tazorax\MathUtils\Exception