| Package | com.degrafa.geometry |
| Class | public class Path |
| Inheritance | Path  Geometry DegrafaObject |
| Implements | IGeometry |
Paths represent the geometry of the outline of an object, defined in terms of moveto (set a new current point), lineto (draw a straight line), curveto (draw a curve using a cubic Bézier), arc (elliptical or circular arc) and closepath (close the current shape by drawing a line to the last moveto) elements.
Default MXML Propertysegments
See also
| Property | Defined by | ||
|---|---|---|---|
 | alpha : Number
The alpha setting that applies to this object.
| Geometry | |
| autoClearGraphicsTarget : Boolean
When using a graphicsTarget and if this property is set to true
the draw phase will clear the graphics context before drawing.
| Geometry | |
| bottom : Number
When set, the bottom of the layout will be located
offset from the bottom of it's parent.
| Geometry | |
| bounds : Rectangle
The tight bounds of this element as represented by a Rectangle.
| Geometry | |
| clippingRectangle : Rectangle
A clipping rectangle to use when rendering this geometry.
| Geometry | |
| commandStack : CommandStack
Provides access to the command stack.
| Geometry | |
| currentState : String
The current view state.
| Geometry | |
| data : Object
Path short hand data value.
| Path | ||
| decoratorCollection : DecoratorCollection
Access to the Decorator collection object for this Geometry object.
| Geometry | |
| decorators : Array
A array of IDecorator objects to be applied on this Geometry.
| Geometry | |
| derive : Path
[write-only]
An object to derive this objects properties from.
| Path | ||
| document : Object
The MXML document that created this object.
| DegrafaObject | |
| enableEvents : Boolean
Enable events for this object.
| DegrafaObject | |
| fill : IGraphicsFill
Defines the fill object that will be used for
rendering this geometry object.
| Geometry | |
| filters : Array
An array of BitmapFilter objects applied to this Geometry.
| Geometry | |
| geometricLength : Number
Returns geometric length of this object.
| Geometry | |
| geometry : Array
A array of IGeometryComposition objects.
| Geometry | |
| geometryCollection : GeometryCollection
Access to the Degrafa geometry collection object for this geometry object.
| Geometry | |
| graphicsTarget : Array
One or more display object's that this Geometry is to be drawn to.
| Geometry | |
| graphicsTargetCollection : DisplayObjectCollection
Access to the Degrafa target collection object for this geometry object.
| Geometry | |
| hasDecorators : Boolean
Returns true if this Geometry has decorators.
| Geometry | |
| hasEventManager : Boolean
Tests to see if a EventDispatcher instance has been created for this object.
| DegrafaObject | |
| hasFilters : Boolean
Returns true if this Geometry has filters.
| Geometry | |
| hasLayout : Boolean
Returns true if this Geometry has layout.
| Geometry | |
| hasStates : Boolean
Returns true if this Geometry has states.
| Geometry | |
| hasTriggers : Boolean
Returns true if this Geometry has triggers.
| Geometry | |
| height : Number
Defines the height of the layout boundary.
| Geometry | |
| horizontalCenter : Number
When set, if left or right is not set, the layout
will be centered horizontally offset by the numeric
value of this property.
| Geometry | |
| id : String
The identifier used by document to refer to this object.
| DegrafaObject | |
| IGraphicParent : IGraphic | Geometry | |
| inheritFill : Boolean
If set to true and no fill is defined and there is a parent object
then this object will walk up through the parents to retrive a fill
object.
| Geometry | |
| inheritStroke : Boolean
If set to true and no stroke is defined and there is a parent object
then this object will walk up through the parents to retrive a stroke
object.
| Geometry | |
| invalidated : Boolean
Specifies whether this object is to be re calculated
on the next cycle.
| Geometry | |
| isInitialized : Boolean | DegrafaObject | |
| isInvalidated : Boolean
Returns true if this Geometry object is invalidated
| Geometry | |
| isRootGeometry : Boolean
Returns true if this Geometry object is a root Geometry Object.
| Geometry | |
| layoutConstraint : LayoutConstraint
The layout constraint that is used for positioning/sizing this geometry object.
| Geometry | |
| _layoutMatrix : Matrix
Access to the layout matrix if this Geometry has layout.
| Geometry | |
| layoutRectangle : Rectangle
Returns the constraint based layout rectangle for this object
or bounds if no layout constraint is specified.
| Geometry | |
| left : Number
When set, the left of the layout will be located
offset by the value of this property multiplied
by the containing width.
| Geometry | |
| maintainAspectRatio : Boolean
When true, the size of the layout will always
maintain an aspect ratio relative to the ratio
of the current width and height properties, even
if those properties are not in control of the
height and width of the layout.
| Geometry | |
| mask : IGeometryComposition
A separate geometry object to use as a mask when rendering this geometry.
| Geometry | |
| maskMode : String
The mode used when this object is being masked by the geometry assigned to the mask property.
| Geometry | |
| maskSpace : String
The coordinate space within which the referenced mask geometry is rendered before being applied as a mask (respecting maskMode)
to this object.
| Geometry | |
| maxHeight : Number
The maximum height that can be applied
to the layout.
| Geometry | |
| maxWidth : Number
The maximum width that can be applied
to the layout.
| Geometry | |
| maxX : Number
The maximum x location that can be applied
to the layout.
| Geometry | |
| maxY : Number
The maximum y location that can be applied
to the layout.
| Geometry | |
| minHeight : Number
The minimum height that can be applied
to the layout.
| Geometry | |
| minWidth : Number
The minimum width that can be applied
to the layout.
| Geometry | |
| minX : Number
The minimum x location that can be applied
to the layout.
| Geometry | |
| minY : Number
The minimum y location that can be applied
to the layout.
| Geometry | |
| name : String
The name that refers to this object.
| DegrafaObject | |
| objectBindings : Array | DegrafaObject | |
| parent : IDegrafaObject
The current degrafa object parent.
| DegrafaObject | |
| percentHeight : Number
When set, the height of the layout will be
set as the value of this property multiplied
by the containing height.
| Geometry | |
| percentWidth : Number
When set, the width of the layout will be
set as the value of this property multiplied
by the containing width.
| Geometry | |
| right : Number
When set, the right of the layout will be located
offset by the value of this property multiplied
by the containing width.
| Geometry | |
| scaleOnLayout : Boolean
When using layout this flag will determine if you want
Scale to be applied to fit layout rules
| Geometry | |
| segmentCollection : SegmentsCollection
[read-only]
Access to the Degrafa segment collection object for this path.
| Path | ||
| segments : Array
A array of segments that describe this path.
| Path | ||
| state : String
The state at which to draw this object.
| Geometry | |
| stateEvent : String
The state event at which to draw this object.
| Geometry | |
| states : Array
An array of states defined for this Geometry.
| Geometry | |
| stroke : IGraphicsStroke
Defines the stroke object that will be used for
rendering this geometry object.
| Geometry | |
| styleName : Object
The css style name associated with this Geometry.
| Geometry | |
| suppressEventProcessing : Boolean
Temporarily suppress event processing for this object.
| DegrafaObject | |
| targetCoordinateSpace : DisplayObject
The display object that defines the coordinate system to use.
| Geometry | |
| top : Number
When set, the top of the layout will be located
offset from the top of it's parent.
| Geometry | |
| transform : ITransform
Defines the transform object that will be used for
rendering this geometry object.
| Geometry | |
| transformBounds : Rectangle
Returns a transformed version of this objects bounds as
represented by a Rectangle.
| Geometry | |
| transformContext : Matrix
A reference to the transformation matrix context within which local transforms will be applied.
| Geometry | |
| triggers : Array
An array of ITrigger objects that this Geometry object will use.
| Geometry | |
| verticalCenter : Number
When set, if top or bottom is not set, the layout
will be centered vertically offset by the numeric
value of this property.
| Geometry | |
| visible : Boolean
Controls the visibility of this geometry object.
| Geometry | |
| width : Number
Defines the width of the layout.
| Geometry | |
| x : Number
Defines the x location (top left) of the layout.
| Geometry | |
| y : Number
Defines the y location (top left) of the layout.
| Geometry | |
| Method | Defined by | ||
|---|---|---|---|
|
Path(data:String = null)
Constructor.
| Path | ||
|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
| DegrafaObject | |
|
angleAt(t:Number):Number
Returns the angle of a point t(0-1) on the path.
| Geometry | |
|
calculateLayout(childBounds:Rectangle = null):void
Performs the specific layout work required by this Geometry.
| Path | ||
|
clearGraphicsTargets():void
Clears all graphics targets specified in the graphicsTarget array.
| Geometry | |
|
dispatchEvent(evt:Event):Boolean
Dispatches an event into the event flow.
| DegrafaObject | |
|
dispatchPropertyChange(bubbles:Boolean = false, property:Object = null, oldValue:Object = null, newValue:Object = null, source:Object = null):Boolean
Dispatches an property change event into the event flow.
| DegrafaObject | |
|
draw(graphics:Graphics, rc:Rectangle):void
Begins the draw phase for geometry objects.
| Path | ||
|
drawToTargets():void
Requests a draw for each graphics target specified in the graphicsTarget array.
| Geometry | |
|
endDraw(graphics:Graphics):void
Ends the draw phase for geometry objects.
| Geometry | |
|
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
| DegrafaObject | |
|
initChange(property:String, oldValue:Object, newValue:Object, source:Object):void
Helper function for dispatching property changes
| DegrafaObject | |
|
initFill(graphics:Graphics, rc:Rectangle):void
Initialise the fill for this geometry object.
| Geometry | |
|
initialized(document:Object, id:String):void
Called after the implementing object has been created and all component properties specified on the MXML tag have been initialized.
| DegrafaObject | |
|
initStroke(graphics:Graphics, rc:Rectangle):void
Initialise the stroke for this geometry object.
| Geometry | |
|
pointAt(t:Number):Point
Returns the point at t(0-1) on this object.
| Geometry | |
|
preDraw():void
Performs any pre calculation that is required to successfully render
this element.
| Path | ||
|
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
| DegrafaObject | |
|
styleChanged(styleProp:String):void
Called when the value of a style property is changed.
| Geometry | |
|
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
| DegrafaObject | |
| Method | Defined by | ||
|---|---|---|---|
|
propertyChangeHandler(event:PropertyChangeEvent):void
Principle event handler for any property changes to a
geometry object or it's child objects.
| Path | ||
| data | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesdata:Object [read-write]Path short hand data value.
The line data property expects exactly 1 value that defines the path. See below link to SVG path specification of which we follow most of.
This property can be used as the source for data binding.
Implementation public function get data():Object
public function set data(value:Object):void
See also
| derive | property |
derive:Path [write-only]An object to derive this objects properties from. When specified this object will derive it's unspecified properties from the passed object.
This property can be used as the source for data binding.
Implementation public function set derive(value:Path):void
| segmentCollection | property |
segmentCollection:SegmentsCollection [read-only]Access to the Degrafa segment collection object for this path.
This property can be used as the source for data binding.
Implementation public function get segmentCollection():SegmentsCollection
| segments | property |
segments:Array [read-write]A array of segments that describe this path.
This property can be used as the source for data binding.
Implementation public function get segments():Array
public function set segments(value:Array):void
| Path | () | constructor |
public function Path(data:String = null)Constructor.
The path constructor accepts 1 optional argument that defines it's segments.
Parametersdata:String (default = null) |
| calculateLayout | () | method |
public override function calculateLayout(childBounds:Rectangle = null):voidPerforms the specific layout work required by this Geometry.
ParameterschildBounds:Rectangle (default = null) |
| draw | () | method |
public override function draw(graphics:Graphics, rc:Rectangle):voidBegins the draw phase for geometry objects. All geometry objects override this to do their specific rendering.
Parametersgraphics:Graphics — The current context to draw to.
|
|
rc:Rectangle — A Rectangle object used for fill bounds.
|
| preDraw | () | method |
public override function preDraw():voidPerforms any pre calculation that is required to successfully render this element. Including bounds calculations and lower level drawing command storage. Each geometry object overrides this and is responsible for it's own pre calculation cycle.
| propertyChangeHandler | () | method |
protected override function propertyChangeHandler(event:PropertyChangeEvent):voidPrinciple event handler for any property changes to a geometry object or it's child objects.
Parametersevent:PropertyChangeEvent |