\src\Utils\Graphics2D\Shapes\Styles\EdgeStyle.inc

Show: inherited
Table of Contents

\Utils\Graphics2D\Shapes\Styles\EdgeStyle

Package: Default

This class implements a style for edges.

Parent(s)
\Utils\Graphics2D\Shapes\Styles\LineStyle

Constants

Constant  DIRECT_EDGE = 0

the identifier for a direct edge, i.e. a direct line from source to target

Constant  POLY_EDGE = 1

the identifier for a poly edge, i.e. a connection from source to target via horizonal or vertical lines only

Properties

Propertyprotected\Utils\Graphics2D\Shapes\Styles\RGBColor  $color= 'null'
inherited

the color of the line

Inherited from: \Utils\Graphics2D\Shapes\Styles\LineStyle::$color
Default valuenullDetails
Type
\Utils\Graphics2D\Shapes\Styles\RGBColor
Inherited_from
\Utils\Graphics2D\Shapes\Styles\LineStyle::$color  
Propertyprotectedint  $type= 'self::POLY_EDGE'

the type of this edge, either self::DIRECT_EDGE or self::POLY_EDGE

Default valueself::POLY_EDGEDetails
Type
int
Propertyprotectedint  $width= 'null'
inherited

the width of the line

Inherited from: \Utils\Graphics2D\Shapes\Styles\LineStyle::$width
Default valuenullDetails
Type
int
Inherited_from
\Utils\Graphics2D\Shapes\Styles\LineStyle::$width  

Methods

methodpublic__construct( int $width = 1, \Utils\Color\Color $color = null, int $type = self::POLY_EDGE ) : void

This acts as the constructor of the class.

Parameters
Name Type Description
$width int

the width of the edge

$color \Utils\Color\Color

the color of the edge, or null for transparent color

$type int

the type of edge, either self::DIRECT_EDGE for a direct line, or self::POLY_EDGE for a poly edge

methodpublic__get( string $memberName ) : mixed
inherited

This method is a magic getter method for the class.

Inherited from: \Utils\Graphics2D\Shapes\Styles\LineStyle::__get()
Parameters
Name Type Description
$memberName string

the name of the member to get

Returns
Type Description
mixed the value of the member
Details
Todo
replace this with Trait in PHP 5.4  
methodpublicsetColor( \Utils\Color\Color $color ) : void
inherited

This method is a setter for the color of the line style.

Inherited from: \Utils\Graphics2D\Shapes\Styles\LineStyle::setColor()
Parameters
Name Type Description
$color \Utils\Color\Color

the new color of the line style

methodpublicsetWidth( int $width ) : void
inherited

This method is a setter for the width of the line style.

Inherited from: \Utils\Graphics2D\Shapes\Styles\LineStyle::setWidth()
Parameters
Name Type Description
$width int

the new width of the line style

Documentation was generated by DocBlox 0.15.1.