Class Overlay
-
Jaguar\Action\AbstractAction
implements
Jaguar\Action\ActionInterface
-
Jaguar\Action\Overlay
Namespace: Jaguar\
Action
Located at Jaguar/Action/Overlay.php
Methods summary
public
|
#
__construct( Jaguar\CanvasInterface $overlay, integer $amount = 100, Jaguar\Box $box = null )
construct new overlay action
construct new overlay action
Parameters
- $overlay
Jaguar\CanvasInterface
$canvas
- $amount
integer $amount in range(0,100)
- $box
Jaguar\Box
$box defulat null which means the size of given canvas will be used for the
given overlay.
Throws
InvalidArgumentException
|
public
Jaguar\Action\Overlay
|
|
public
Jaguar\CanvasInterface
|
|
public
Jaguar\Action\Overlay
|
#
setBox( Jaguar\Box $box )
Set the overlay box
Overlay box define a position and the size for overlay to use when it merged
with the given canvas
Parameters
Returns
|
public
Jaguar\Box
|
|
public
Jaguar\Action\Overlay
|
#
setAmount( integer $amount )
Set overlay amount
Parameters
- $amount
integer $amount in range(0,100)
Returns
Throws
InvalidArgumentException
|
public
integer
|
#
getAmount( )
Get overlay amount
Returns
integer
|
public
|
#
__clone( )
Disable clone
Throws
RuntimeException
|
apply()
Magic methods summary