Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
flash.display 
GraphicsPath 
Packageflash.display
Classpublic final class GraphicsPath
InheritanceGraphicsPath Inheritance Object
Implements IGraphicsPath, IGraphicsData

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

A collection of drawing commands and the coordinate parameters for those commands.

Use a GraphicsPath object with the Graphics.drawGraphicsData() method. Drawing a GraphicsPath object is the equivalent of calling the Graphics.drawPath() method.

The GraphicsPath class also has its own set of methods (curveTo(), lineTo(), moveTo() wideLineTo() and wideMoveTo()) similar to those in the Graphics class for making adjustments to the GraphicsPath.commands and GraphicsPath.data vector arrays.

See also



Public Properties
 PropertyDefined By
  commands : Vector.<int>
The Vector of drawing commands as integers representing the path.
GraphicsPath
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  data : Vector.<Number>
The Vector of Numbers containing the parameters used with the drawing commands.
GraphicsPath
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  winding : String
Specifies the winding rule using a value defined in the GraphicsPathWinding class.
GraphicsPath
Public Methods
 MethodDefined By
  
GraphicsPath(commands:Vector.<int> = null, data:Vector.<Number> = null, winding:String = "evenOdd")
Creates a new GraphicsPath object.
GraphicsPath
  
curveTo(controlX:Number, controlY:Number, anchorX:Number, anchorY:Number):void
Adds a new "curveTo" command to the commands vector and new coordinates to the data vector.
GraphicsPath
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
Adds a new "lineTo" command to the commands vector and new coordinates to the data vector.
GraphicsPath
  
Adds a new "moveTo" command to the commands vector and new coordinates to the data vector.
GraphicsPath
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
  
Adds a new "wideLineTo" command to the commands vector and new coordinates to the data vector.
GraphicsPath
  
Adds a new "wideMoveTo" command to the commands vector and new coordinates to the data vector.
GraphicsPath
Property Detail

commands

property
public var commands:Vector.<int>

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The Vector of drawing commands as integers representing the path. Each command can be one of the values defined by the GraphicsPathCommand class.

See also

data

property 
public var data:Vector.<Number>

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The Vector of Numbers containing the parameters used with the drawing commands.

winding

property 
winding:String

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Specifies the winding rule using a value defined in the GraphicsPathWinding class.



Implementation
    public function get winding():String
    public function set winding(value:String):void

See also

Constructor Detail

GraphicsPath

()Constructor
public function GraphicsPath(commands:Vector.<int> = null, data:Vector.<Number> = null, winding:String = "evenOdd")

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Creates a new GraphicsPath object.

Parameters
commands:Vector.<int> (default = null) — A Vector of integers representing commands defined by the GraphicsPathCommand class.
 
data:Vector.<Number> (default = null) — A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair).
 
winding:String (default = "evenOdd") — Specifies the winding rule using a value defined in the GraphicsPathWinding class.

See also

Method Detail

curveTo

()method
public function curveTo(controlX:Number, controlY:Number, anchorX:Number, anchorY:Number):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Adds a new "curveTo" command to the commands vector and new coordinates to the data vector.

Parameters

controlX:Number — A number that specifies the horizontal position of the control point relative to the registration point of the parent display object.
 
controlY:Number — A number that specifies the vertical position of the control point relative to the registration point of the parent display object.
 
anchorX:Number — A number that specifies the horizontal position of the next anchor point relative to the registration point of the parent display object.
 
anchorY:Number — A number that specifies the vertical position of the next anchor point relative to the registration point of the parent display object.

See also

lineTo

()method 
public function lineTo(x:Number, y:Number):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Adds a new "lineTo" command to the commands vector and new coordinates to the data vector.

Parameters

x:Number — The x coordinate of the destination point for the line.
 
y:Number — The y coordinate of the destination point for the line.

See also

moveTo

()method 
public function moveTo(x:Number, y:Number):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Adds a new "moveTo" command to the commands vector and new coordinates to the data vector.

Parameters

x:Number — The x coordinate of the destination point.
 
y:Number — The y coordinate of the destination point.

See also

wideLineTo

()method 
public function wideLineTo(x:Number, y:Number):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Adds a new "wideLineTo" command to the commands vector and new coordinates to the data vector.

Parameters

x:Number — The x-coordinate of the destination point for the line.
 
y:Number — The y-coordinate of the destination point for the line.

See also

wideMoveTo

()method 
public function wideMoveTo(x:Number, y:Number):void

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Adds a new "wideMoveTo" command to the commands vector and new coordinates to the data vector.

Parameters

x:Number — The x-coordinate of the destination point.
 
y:Number — The y-coordinate of the destination point.

See also