StrokeItem

Defines a stroke item structure, that is a curve or line segment point or an object such as a circle, ellipse or rectangle.

Summary

StrokeItem	Defines a stroke item structure, that is a curve or line segment point or an object such as a circle, ellipse or rectangle.
Public enumeration constants
SEGMENT_START	Start of a line segment/path.
SEGMENT_POINT	Continuation of a line segment/path.
CIRCLE	Circle shaped object.
ELLIPSE	Ellipse shaped object.
RECT	Rectangle shaped object.
ROUND_RECT	Rectangle shaped object with rounded corners.
Public data structure
type	Type of item, one of the Public enumeration constants.
style	Line and fill StrokeStyle in effect for the item.
strokePoint	Primary stroke point for the item.
controlPoint	Secondary control point for the item.
cornerPoint	Tertiary corner point only used to define a rounded rectangle’s corner size.
strokeSprite	Sprite representing the primary stroke point.
controlSprite	Sprite representing the secondary control point.
cornerSprite	Sprite representing the tertiary corner point.
isDefaultItem	State set to true when a default segment start item is created.
Structure creation
StrokeItem	Constructor for creation of a StrokeItem.
updateItem	Change type and points on the existing StrokeItem.
clone	Returns a deep copy of the StrokeItem instance.
createPointSprite	Creates a point sprite representing one of the points defined in a StrokeItem.
Structure destruction
dispose	Removes all referenced data from the instance.
removeSprites	Remove all point sprites from the display list and the StrokeItem.
removeControlPoint	Remove a control point sprite from the display list and the StrokeItem.
Structure manipulation
move	Moves the StrokeItem to a new position.
scale	Scale the position of a StrokeItem.

Public enumeration constants

SEGMENT_START

public static const SEGMENT_START: String

Start of a line segment/path.

SEGMENT_POINT

public static const SEGMENT_POINT: String

Continuation of a line segment/path.

CIRCLE

public static const CIRCLE: String

Circle shaped object.

ELLIPSE

public static const ELLIPSE: String

Ellipse shaped object.

RECT

public static const RECT: String

Rectangle shaped object.

ROUND_RECT

public static const ROUND_RECT: String

Rectangle shaped object with rounded corners.

Public data structure

type

public var type: String

Type of item, one of the Public enumeration constants.

style

public var style: StrokeStyle

Line and fill StrokeStyle in effect for the item.

strokePoint

public var strokePoint: Point

Primary stroke point for the item.

controlPoint

public var controlPoint: Point

Secondary control point for the item.

cornerPoint

public var cornerPoint: Point

Tertiary corner point only used to define a rounded rectangle’s corner size.

strokeSprite

public var strokeSprite: Sprite

Sprite representing the primary stroke point.

controlSprite

public var controlSprite: Sprite

Sprite representing the secondary control point.

cornerSprite

public var cornerSprite: Sprite

Sprite representing the tertiary corner point.

isDefaultItem

public var isDefaultItem: Boolean

State set to true when a default segment start item is created.

Used to eliminate the default item if the subsequent operation does not require it. That is when the next operation is to create a graphics object instead of a line ccontinuation.

Structure creation

StrokeItem

public function StrokeItem( itemParent: DisplayObjectContainer,
itemType: String,
itemStyle: StrokeStyle,
strokePt: Point,
controlPt: Point = null,
cornerPt: Point = null )

Constructor for creation of a StrokeItem.

Parameters

itemParent	display object list parent
itemType	type of item, one of the Public enumeration constants
itemStyle	line and fill StrokeStyle for the item
strokePt	stroke point for the item
controlPt	optional control point (default null)
cornerPt	optional corner point (default null)

updateItem

public function updateItem( itemType: String,
strokePt: Point,
controlPt: Point = null,
cornerPt: Point = null ):void

Change type and points on the existing StrokeItem.

Parameters

itemType	type of item, one of the Public enumeration constants
strokePt	stroke point for the item
controlPt	optional control point (default null)
cornerPt	optional corner point (default null)

clone

public function clone():StrokeItem

Returns a deep copy of the StrokeItem instance.

createPointSprite

private function createPointSprite( itemParent: DisplayObjectContainer,
pos: Point,
spriteName: String ):Sprite

Creates a point sprite representing one of the points defined in a StrokeItem.

Parameters

itemParent	display object list parent
pos	a Point position
spriteName	a point type name as defined in <Stroke point names>

Returns

A colored point sprite

Structure destruction

dispose

public function dispose():void

Removes all referenced data from the instance.

removeSprites

public function removeSprites():void

Remove all point sprites from the display list and the StrokeItem.

removeControlPoint

public function removeControlPoint():void

Remove a control point sprite from the display list and the StrokeItem.

Structure manipulation

move

public function move( xPos: Number,
yPos: Number,
mirrorX: Boolean = false,
mirrorY: Boolean = false ):void

Moves the StrokeItem to a new position.

Parameters

xPos	new X-axis position
yPos	new Y-axis position
mirrorX	true if mirrored in the X-axis (default false)
mirrorY	true if mirrored in the Y-axis (default false)

scale

public function scale( xScale: Number,
yScale: Number ):void

Scale the position of a StrokeItem. Calls on the StrokeStyle.scale method to scale the style as well.

Parameters

xScale	horizontal scale factor
yScale	vertical scale factor