Jaguar - PHP Graphic Library
  • Namespace
  • Class
  • Tree

Namespaces

  • Jaguar
    • Action
      • Blur
      • Color
      • Pixelate
      • Preset
    • Color
    • Drawable
      • Border
      • Style
      • Text
    • Exception
    • Factory
    • Format
    • Gradient

Classes

  • AbstractCanvas
  • Box
  • Canvas
  • CompressableCanvas
  • Coordinate
  • Dimension
  • Font
  • ImageFile
  • Transformation
  • Util

Interfaces

  • CanvasFactory
  • CanvasInterface
  • EqualsInterface

Class Box

Jaguar\Box implements Jaguar\EqualsInterface
Namespace: Jaguar
Located at Jaguar/Box.php

Methods summary

public
# __construct( Jaguar\Dimension $dimension = null, Jaguar\Coordinate $coordinate = null )

Construct New Box Object

Construct New Box Object

Parameters

$dimension
Jaguar\Dimension
$dimension
$coordinate
Jaguar\Coordinate
$coordinate
public Jaguar\Box
# setCoordinate( Jaguar\Coordinate $coordinate )

Set Box Coordinate

Set Box Coordinate

The coordinate represent the (Top Left) position of the box

Parameters

$coordinate
Jaguar\Coordinate
$coordinate

Returns

Jaguar\Box
public Jaguar\Coordinate
# getCoordinate( )

Get Box Coordinate

Get Box Coordinate

Returns

Jaguar\Coordinate
public Jaguar\Box
# setDimension( Jaguar\Dimension $dimension )

Set Box Dimension

Set Box Dimension

Parameters

$dimension
Jaguar\Dimension
$dimension

Returns

Jaguar\Box
public Jaguar\Dimension
# getDimension( )

Get Box Dimension

Get Box Dimension

Returns

Jaguar\Dimension
public Jaguar\Box
# scale( number $ratio )

Scale the box by the given ratio

Scale the box by the given ratio

Parameters

$ratio
number
$ratio

Returns

Jaguar\Box
public integer
# getX( )

Returns

integer

See

Jaguar\Coordinate::getX()

CodeCoverageIgnore

public integer
# getY( )

Returns

integer

See

Jaguar\Coordinate::getY()

CodeCoverageIgnore

public integer
# getWidth( )

Returns

integer

See

Jaguar\Dimension::getWidth()

CodeCoverageIgnore

public integer
# getHeight( )

Returns

integer

See

Jaguar\Dimension::getHeight()

CodeCoverageIgnore

public Jaguar\Box
# resize( integer $width, integer $height )

Resize the box

Resize the box

Parameters

$width
integer
$width
$height
integer
$height

Returns

Jaguar\Box

See

Jaguar\Dimension::resize()

CodeCoverageIgnore

public Jaguar\Box
# translateDimension( integer $dx, integer $dy )

Translate the box dimension

Translate the box dimension

Parameters

$dx
integer
$dx
$dy
integer
$dy

Returns

Jaguar\Box

See

Jaguar\Dimension::translate()

CodeCoverageIgnore

public Jaguar\Box
# move( integer $x, integer $y )

Move box's coordinate

Move box's coordinate

Parameters

$x
integer
$x
$y
integer
$y

Returns

Jaguar\Box

See

Jaguar\Coordinate::move()

CodeCoverageIgnore

public Jaguar\Box
# translateCoordinate( integer $dx, integer $dy )

Translate the box's coordinate

Translate the box's coordinate

Parameters

$dx
integer
$dx
$dy
integer
$dy

Returns

Jaguar\Box

See

Jaguar\Coordinate::translate()

CodeCoverageIgnore

public
# equals( mixed $other )

Check that the current object which implements this interfcae is equal to another object from the same type

Check that the current object which implements this interfcae is equal to another object from the same type

Parameters

$other
mixed
$other

Throws

InvalidArgumentException
if the passed param type is invalid

Implementation of

Jaguar\EqualsInterface::equals()
public string
# __toString( )

Returns a string representation for the box object

Returns a string representation for the box object

Returns

string
public
# __clone( )

Clone Box

Clone Box

Magic methods summary

Jaguar - PHP Graphic Library API documentation generated by ApiGen 2.8.0