1. class
  2. Imagine
  3. \
  4. Image
  5. \
  6. Point

Point

class Point implements PointInterface

The point class.

Methods

__construct(int $x, int $y)

Constructs a point of coordinates.

int
getX()

Gets points x coordinate.

int
getY()

Gets points y coordinate.

bool
in(BoxInterface $box)

Checks if current coordinate is inside a given box.

PointInterface
move(int $amount)

Returns another point, moved by a given amount from current coordinates.

string
__toString()

Gets a string representation for the current point.

Details

at line 39
__construct(int $x, int $y)

Constructs a point of coordinates.

Parameters

int $x
int $y

Exceptions

InvalidArgumentException

at line 54
int getX()

Gets points x coordinate.

Return Value

int

See also

PointInterface::getX

at line 64
int getY()

Gets points y coordinate.

Return Value

int

See also

PointInterface::getY

at line 74
bool in(BoxInterface $box)

Checks if current coordinate is inside a given box.

Parameters

BoxInterface $box

Return Value

bool

See also

PointInterface::in

at line 84
PointInterface move(int $amount)

Returns another point, moved by a given amount from current coordinates.

Parameters

int $amount

Return Value

PointInterface

See also

PointInterface::move

at line 94
string __toString()

Gets a string representation for the current point.

Return Value

string

See also

PointInterface::__toString