linea21-externals
[ class tree: linea21-externals ] [ index: linea21-externals ] [ all elements ]

Class: awDriver

Source Location: /class/system/artichow/php5/inc/Driver.class.php

Class Overview


Draw your objects


Author(s):

Variables

Methods


Child classes:

Draw your objects

Class Details

[line 18]
Draw your objects



Tags:

abstract:  


[ Top ]


Class Variables

$antiAliasing =  FALSE

[line 53]

Use anti-aliasing ?



Tags:

access:  protected

Type:   bool


[ Top ]

$driverString =

[line 76]

A string representing the type of the driver



Tags:

access:  protected

Type:   string


[ Top ]

$fileFontDriver =

[line 69]

The FontDriver object that will be used to draw text with TTF or FDB fonts.



Tags:

access:  protected

Type:   awFileFontDriver


[ Top ]

$imageHeight =

[line 32]

Image height



Tags:

access:  public

Type:   int


[ Top ]

$imageWidth =

[line 25]

Image width



Tags:

access:  public

Type:   int


[ Top ]

$phpFontDriver =

[line 61]

The FontDriver object that will be used to draw text with PHP fonts.



Tags:

access:  protected

Type:   awPHPFontDriver


[ Top ]

$x =

[line 39]

Driver X position



Tags:

access:  public

Type:   int


[ Top ]

$y =

[line 46]

Driver Y position



Tags:

access:  public

Type:   int


[ Top ]



Class Methods


constructor __construct [line 81]

awDriver __construct( )



Tags:

access:  public


[ Top ]

method arc [line 233]

void arc( awColor $color, awPoint $center, int $width, int $height, int $from, int $to)

Draw a color arc



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::arc()
Draw a color arc

Parameters:

awColor   $color   Arc color
awPoint   $center   Point center
int   $width   Ellipse width
int   $height   Ellipse height
int   $from   Start angle
int   $to   End angle

[ Top ]

method copyImage [line 183]

void copyImage( awImage $image, awPoint $p1, awPoint $p2)

Draw an image here



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::copyImage()
Draw an image here

Parameters:

awImage   $image   Image
int   $p1   Image top-left point
int   $p2   Image bottom-right point

[ Top ]

method copyResizeImage [line 195]

void copyResizeImage( awImage $image, awPoint $d1, awPoint $d2, awPoint $s1, awPoint $s2, [bool $resample = TRUE])

Draw an image here



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::copyResizeImage()
Draw an image here

Parameters:

awImage   $image   Image
int   $d1   Destination top-left position
int   $d2   Destination bottom-right position
int   $s1   Source top-left position
int   $s2   Source bottom-right position
bool   $resample   Resample image ? (default to TRUE)

[ Top ]

method ellipse [line 255]

void ellipse( awColor $color, awPoint $center, int $width, int $height)

Draw a colored ellipse



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::ellipse()
Draw a colored ellipse

Parameters:

awColor   $color   Ellipse color
awPoint   $center   Ellipse center
int   $width   Ellipse width
int   $height   Ellipse height

[ Top ]

method filledArc [line 245]

void filledArc( awColor $color, awPoint $center, int $width, int $height, int $from, int $to)

Draw an arc with a background color



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::filledArc()
Draw an arc with a background color

Parameters:

awColor   $color   Arc background color
awPoint   $center   Point center
int   $width   Ellipse width
int   $height   Ellipse height
int   $from   Start angle
int   $to   End angle

[ Top ]

method filledEllipse [line 265]

void filledEllipse( mixed $background, awPoint $center, int $width, int $height)

Draw an ellipse with a background



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::filledEllipse()
Draw an ellipse with a background

Parameters:

mixed   $background   Background (can be a color or a gradient)
awPoint   $center   Ellipse center
int   $width   Ellipse width
int   $height   Ellipse height

[ Top ]

method filledPolygon [line 298]

void filledPolygon( mixed $background, awPolygon $polygon)

Draw a polygon with a background



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::filledPolygon()
Draw a polygon with a background

Parameters:

mixed   $background   Background (can be a color or a gradient)
Polygon   $polygon   A polygon

[ Top ]

method filledRectangle [line 282]

void filledRectangle( mixed $background, awLine $line)

Draw a rectangle with a background



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::filledRectangle()
Draw a rectangle with a background

Parameters:

mixed   $background   Background (can be a color or a gradient)
awLine   $line   Rectangle diagonale

[ Top ]

method get [line 312]

void get( awImage $image)

Get the image as binary data



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::get()
Get the image as binary data

Parameters:

awImage   $image  

[ Top ]

method getColor [line 174]

int getColor( awColor $color)

When passed a Color object, returns the corresponding color identifier (driver dependant).



Tags:

return:  A color identifier representing the color composed of the given RGB components
abstract:  
access:  public


Overridden in child classes as:

awMingDriver::getColor()
When passed a Color object, returns the corresponding color identifier (driver dependant).

Parameters:

awColor   $color   A Color object

[ Top ]

method getDriverString [line 333]

string getDriverString( )

Return the string representing the type of driver



Tags:

access:  public


[ Top ]

method getSize [line 158]

array getSize( )

Get the size of the component handled by the driver



Tags:

return:  Absolute width and height of the component
abstract:  
access:  public


Overridden in child classes as:

awMingDriver::getSize()
Get the size of the component handled by the driver

[ Top ]

method getTextHeight [line 326]

void getTextHeight( awText $text)

Return the height of some text



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::getTextHeight()

Parameters:

awText   $text  

[ Top ]

method getTextWidth [line 319]

void getTextWidth( awText $text)

Return the width of some text



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::getTextWidth()

Parameters:

awText   $text  

[ Top ]

method init [line 91]

void init( awImage $image)

Initialize the driver for a particular awImage object



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::init()
Initialize the driver for a particular awImage object

Parameters:

awImage   $image  

[ Top ]

method initFromFile [line 99]

void initFromFile( awFileImage $fileImage, string $file)

Initialize the Driver for a particular FileImage object



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::initFromFile()
Initialize the Driver for a particular FileImage object

Parameters:

awFileImage   $fileImage   The FileImage object to work on
string   $file   Image filename

[ Top ]

method isCompatibleWithFont [line 343]

bool isCompatibleWithFont( awFont $font)

Returns whether or not the driver is compatible with the given font type



Tags:

abstract:  
access:  protected


Overridden in child classes as:

awMingDriver::isCompatibleWithFont()

Parameters:

awFont   $font  

[ Top ]

method line [line 221]

void line( awColor $color, awLine $line, int $thickness)

Draw a colored line



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::line()
Draw a colored line

Parameters:

awColor   $color   Line color
awLine   $line  
int   $thickness   Line tickness

[ Top ]

method movePosition [line 132]

void movePosition( int $x, int $y)

Move the position of the image



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::movePosition()
Move the position of the image

Parameters:

int   $x   Add this value to X axis
int   $y   Add this value to Y axis

[ Top ]

method point [line 212]

void point( awColor $color, awPoint $p)

Draw a pixel



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::point()
Draw a pixel

Parameters:

awColor   $color   Pixel color
awPoint   $p  

[ Top ]

method polygon [line 290]

void polygon( awColor $color, awPolygon $polygon)

Draw a polygon



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::polygon()
Draw a polygon

Parameters:

awColor   $color   Polygon color
Polygon   $polygon   A polygon

[ Top ]

method rectangle [line 274]

void rectangle( awColor $color, awLine $line, awPoint $p2)

Draw a colored rectangle



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::rectangle()
Draw a colored rectangle

Parameters:

awColor   $color   Rectangle color
awLine   $line   Rectangle diagonale
awPoint   $p2  

[ Top ]

method send [line 305]

void send( awImage $image)

Sends the image, as well as the correct HTTP headers, to the browser



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::send()
Sends the image, as well as the correct HTTP headers, to the browser

Parameters:

awImage   $image   The Image object to send

[ Top ]

method setAbsPosition [line 124]

void setAbsPosition( int $x, int $y)

Inform the driver of the position of your image This method need absolutes values



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::setAbsPosition()
Inform the driver of the position of your image This method need absolutes values

Parameters:

int   $x   Left-top corner X position
int   $y   Left-top corner Y position

[ Top ]

method setAbsSize [line 151]

void setAbsSize( int $w, int $h)

Inform the driver of the size of your image You can set absolute size with this method.



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::setAbsSize()
Inform the driver of the size of your image You can set absolute size with this method.

Parameters:

int   $w   Image width
int   $h   Image height

[ Top ]

method setAntiAliasing [line 165]

void setAntiAliasing( $bool)

Turn antialiasing on or off



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::setAntiAliasing()
Turn antialiasing on or off

Parameters:

   $bool  

[ Top ]

method setImageSize [line 107]

void setImageSize( int $width, int $height)

Change the image size



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::setImageSize()
Change the image size

Parameters:

int   $width   Image width
int   $height   Image height

[ Top ]

method setPosition [line 115]

void setPosition( float $x, float $y)

Inform the driver of the position of your image



Tags:

abstract:  
access:  public


Overridden in child classes as:

awMingDriver::setPosition()
Inform the driver of the position of your image

Parameters:

float   $x   Position on X axis of the center of the component
float   $y   Position on Y axis of the center of the component

[ Top ]

method setSize [line 142]

array setSize( int $w, int $h)

Inform the driver of the size of your image Height and width must be between 0 and 1.



Tags:

return:  Absolute width and height of the image
abstract:  
access:  public


Overridden in child classes as:

awMingDriver::setSize()
Inform the driver of the size of your image Height and width must be between 0 and 1.

Parameters:

int   $w   Image width
int   $h   Image height

[ Top ]

method string [line 204]

void string( awText $text, awPoint $point, [int $width = NULL])

Draw a string



Tags:

var:  Text to print
abstract:  
access:  public


Overridden in child classes as:

awMingDriver::string()
Draw a string

Parameters:

awPoint   $point   Draw the text at this point
int   $width   Text max width
awText   $text  

[ Top ]


Documentation generated on Thu, 03 May 2012 15:04:29 +0200 by phpDocumentor 1.4.1