Packagepegas.draw
Classpublic dynamic class PolygonPen
InheritancePolygonPen Inheritance Pen Inheritance flash.utils.Proxy

This pen is the tool to draw a regular polygon vector shape.


Public Properties
 PropertyDefined by
 Inheritedalign : uint
(read-write) Determinates the align value of the pen.
Pen
  angle : Number = 0
Starting angle in degrees (default to 0).
PolygonPen
 Inheritedfill : IFillStyle
Determinates the fill style object of the pen.
Pen
 Inheritedgraphics : Graphics
Specifies the Graphics object belonging to this Shape object, where vector drawing commands can occur.
Pen
 Inheritedline : ILineStyle
Determinates the line style object of the pen.
Pen
  radius : Number
The radius value of the pen.
PolygonPen
  sides : uint
The number of sides (Math.abs(sides) must be > 2)
PolygonPen
 InheriteduseClear : Boolean = true
Indicates if the clear() method is invoked at the end of the draw method.
Pen
 InheriteduseEndFill : Boolean = true
Indicates if the endFill() method is invoked at the end of the draw method.
Pen
  x : Number
The offset x value of the center of the circle.
PolygonPen
  y : Number
The offset y value of the center of the circle.
PolygonPen
Public Methods
 MethodDefined by
  
PolygonPen(graphic:*, ... arguments)
Creates a new PolygonPen.
PolygonPen
 Inherited
BF(... arguments):void
Defines a shortcut reference to used the beginBitmapFill method.
Pen
 Inherited
C(... arguments):void
Defines a shortcut reference to used the curveTo method.
Pen
 Inherited
CL():void
Defines a shortcut reference to used the clear method.
Pen
  
draw(... arguments):void
Draws the shape.
PolygonPen
  
drawShape():void
This method contains the basic drawing shape algorithm.
PolygonPen
 Inherited
EF():void
Defines a shortcut reference to used the endFill method.
Pen
 Inherited
F(... arguments):void
Defines a shortcut reference to used the beginFill method.
Pen
 Inherited
GF(... arguments):void
Defines a shortcut reference to used the beginGradientFill method.
Pen
 Inherited
GS(... arguments):void
Defines a shortcut reference to used the lineGradientStyle method.
Pen
 Inherited
L(... arguments):void
Defines a shortcut reference to used the lineTo method.
Pen
 Inherited
M(... arguments):void
Defines a shortcut reference to used the moveTo method.
Pen
 Inherited
S(... arguments):void
Defines a shortcut reference to used the lineStyle method.
Pen
  
setPen(... arguments):void
Sets the shape options to defined all values to draw the shape.
PolygonPen
 Inherited
toString():String
Returns the string representation of this object.
Pen
Protected Methods
 MethodDefined by
 Inherited
callProperty(methodName:*, ... rest):*
Overrides the behavior of an object property that can be called as a function.
Pen
Property detail
angleproperty
public var angle:Number = 0

Starting angle in degrees (default to 0).

radiusproperty 
public var radius:Number

The radius value of the pen.

sidesproperty 
sides:uint  [read-write]

The number of sides (Math.abs(sides) must be > 2)

Implementation
    public function get sides():uint
    public function set sides(value:uint):void
xproperty 
public var x:Number

The offset x value of the center of the circle.

yproperty 
public var y:Number

The offset y value of the center of the circle.

Constructor detail
PolygonPen()constructor
public function PolygonPen(graphic:*, ... arguments)

Creates a new PolygonPen. The Pen class use composition to control a Graphics reference and draw custom vector graphic shapes.

Parameters
graphic:* — The Graphics reference to control with this helper. You can passed-in a Shape or Sprite/MovieClip reference in argument.
 
... arguments — (optional)The x location of the center of the circle relative to the registration point of the parent display object (in pixels).
Method detail
draw()method
public override function draw(... arguments):void

Draws the shape.

Parameters
... arguments — (optional)The x location of the center of the circle relative to the registration point of the parent display object (in pixels).
drawShape()method 
public override function drawShape():void

This method contains the basic drawing shape algorithm.

setPen()method 
public function setPen(... arguments):void

Sets the shape options to defined all values to draw the shape.

Parameters
... arguments — (optional) The x location of the center of the circle relative to the registration point of the parent display object (in pixels).