Quadrangle Class Reference

Inherits BaseJavaClass.

Public Member Functions
	__construct (Point $leftTop, Point $rightTop, Point $rightBottom, Point $leftBottom)
	getLeftTop ()
	setLeftTop (Point $value)
	getRightTop ()
	setRightTop (Point $value)
	getRightBottom ()
	setRightBottom (Point $value)
	getLeftBottom ()
	setLeftBottom (Point $value)
	isEmpty ()
	contains (Point $pt)
	containsPoint (int $x, int $y)
	containsQuadrangle (Quadrangle $quad)
	containsRectangle (Rectangle $rect)
	equals (Quadrangle $other)
	hashCode ()
	toString ()
	getBoundingRectangle ()

Static Public Member Functions
static	EMPTY ()

Detailed Description

Stores a set of four Points that represent a Quadrangle region.

Constructor & Destructor Documentation

__construct()

__construct	(	Point	$leftTop,
		Point	$rightTop,
		Point	$rightBottom,
		Point	$leftBottom
	)

Initializes a new instance of the Quadrangle structure with the describing points.

Parameters

leftTop	A Point that represents the left-top corner of the Quadrangle.
rightTop	A Point that represents the right-top corner of the Quadrangle.
rightBottom	A Point that represents the right-bottom corner of the Quadrangle.
leftBottom	A Point that represents the left-bottom corner of the Quadrangle.

Member Function Documentation

contains()

contains

(

Point

$pt

)

Determines if the specified Point is contained within this Quadrangle structure.

Parameters

pt	The Point to test.

Returns

Returns true if Point is contained within this Quadrangle structure; otherwise, false.

containsPoint()

containsPoint	(	int	$x,
		int	$y
	)

Determines if the specified point is contained within this Quadrangle structure.

Parameters

x	The x point cordinate.
y	The y point cordinate.

Returns

Returns true if point is contained within this Quadrangle structure; otherwise, false.

containsQuadrangle()

containsQuadrangle

(

Quadrangle

$quad

)

Determines if the specified Quadrangle is contained or intersect this Quadrangle structure.

Parameters

quad	The Quadrangle to test.

Returns

Returns true if Quadrangle is contained or intersect this Quadrangle structure; otherwise, false.

containsRectangle()

containsRectangle

(

Rectangle

$rect

)

Determines if the specified Rectangle is contained or intersect this Quadrangle structure.

Parameters

rect	The Rectangle to test.

Returns

Returns true if Rectangle is contained or intersect this Quadrangle structure; otherwise, false.

EMPTY()

static EMPTY ( )

static

Represents a Quadrangle structure with its properties left uninitialized.Value: Quadrangle

equals()

equals

(

Quadrangle

$other

)

Returns a value indicating whether this instance is equal to a specified Quadrangle value.

Parameters

$other

An Quadrangle value to compare to this instance.

Returns

true if obj has the same value as this instance; otherwise, false.

getBoundingRectangle()

getBoundingRectangle

(

)

Creates Rectangle bounding this Quadrangle

Returns

returns Rectangle bounding this Quadrangle

getLeftBottom()

getLeftBottom

(

)

Gets left-bottom corner Point of Quadrangle regionValue: A left-bottom corner Point of Quadrangle region

getLeftTop()

getLeftTop

(

)

Gets left-top corner Point of Quadrangle regionValue: A left-top corner Point of Quadrangle region

getRightBottom()

getRightBottom

(

)

Gets right-bottom corner Point of Quadrangle regionValue: A right-bottom corner Point of Quadrangle region

getRightTop()

getRightTop

(

)

Gets right-top corner Point of Quadrangle regionValue: A right-top corner Point of Quadrangle region

hashCode()

hashCode

(

)

Returns the hash code for this instance.

Returns

A 32-bit signed integer hash code.

isEmpty()

isEmpty

(

)

Tests whether all Points of this Quadrangle have values of zero.Value: Returns true if all Points of this Quadrangle have values of zero; otherwise, false.

setLeftBottom()

setLeftBottom

(

Point

$value

)

Gets left-bottom corner Point of Quadrangle regionValue: A left-bottom corner Point of Quadrangle region

setLeftTop()

setLeftTop

(

Point

$value

)

Gets left-top corner Point of Quadrangle regionValue: A left-top corner Point of Quadrangle region

setRightBottom()

setRightBottom

(

Point

$value

)

Gets right-bottom corner Point of Quadrangle regionValue: A right-bottom corner Point of Quadrangle region

setRightTop()

setRightTop

(

Point

$value

)

Gets right-top corner Point of Quadrangle regionValue: A right-top corner Point of Quadrangle region

toString()

toString

(

)

Returns a human-readable string representation of this Quadrangle.

Returns

A string that represents this Quadrangle.