Class

Imagine\Image\Box

class Box implements BoxInterface

A box implementation

Methods

__construct(integer $width, integer $height)

Constructs the Size with given width and height

integer getWidth()

Gets current image width

integer getHeight()

Gets current image height

BoxInterface scale(float $ratio)

Creates new BoxInterface instance with ratios applied to both sides

BoxInterface increase(integer $size)

Creates new BoxInterface, adding given size to both sides

Boolean contains(BoxInterface $box, PointInterface $start = null)

Checks whether current box can fit given box at a given start position, start position defaults to top left corner xy(0,0)

integer square()

Gets current box square, useful for getting total number of pixels in a given box

string __toString()

Returns a string representation of the current box

BoxInterface widen(integer $width)

Resizes box to given width, constraining proportions and returns the new box

BoxInterface heighten(integer $height)

Resizes box to given height, constraining proportions and returns the new box

Details

at line 39
public __construct(integer $width, integer $height)

Constructs the Size with given width and height

Parameters

integer $width
integer $height

Exceptions

InvalidArgumentException

at line 52
public integer getWidth()

Gets current image width

Return Value

integer

at line 60
public integer getHeight()

Gets current image height

Return Value

integer

at line 68
public BoxInterface scale(float $ratio)

Creates new BoxInterface instance with ratios applied to both sides

Parameters

float $ratio

Return Value

BoxInterface

at line 76
public BoxInterface increase(integer $size)

Creates new BoxInterface, adding given size to both sides

Parameters

integer $size

Return Value

BoxInterface

at line 84
public Boolean contains(BoxInterface $box, PointInterface $start = null)

Checks whether current box can fit given box at a given start position, start position defaults to top left corner xy(0,0)

Parameters

BoxInterface $box
PointInterface $start

Return Value

Boolean

at line 94
public integer square()

Gets current box square, useful for getting total number of pixels in a given box

Return Value

integer

at line 102
public string __toString()

Returns a string representation of the current box

Return Value

string

at line 110
public BoxInterface widen(integer $width)

Resizes box to given width, constraining proportions and returns the new box

Parameters

integer $width

Return Value

BoxInterface

at line 118
public BoxInterface heighten(integer $height)

Resizes box to given height, constraining proportions and returns the new box

Parameters

integer $height

Return Value

BoxInterface