Packageaway3d.paths
Interfacepublic interface IPath
Implementors CubicPath, QuadraticPath, SegmentedPathBase


Public Properties
 PropertyDefined By
  numSegments : uint
Deprecated: Deprecated
[read-only] The number of CubicPathSegment instances in the path.
IPath
  segments : Vector.<IPathSegment>
Deprecated: Deprecated
[read-only] The IPathSegment instances which make up this path.
IPath
Public Methods
 MethodDefined By
  
addSegment(segment:IPathSegment):void
Deprecated: Deprecated
Adds a CubicPathSegment to the end of the path
IPath
  
dispose():void
Disposes the path and all the segments
IPath
  
getPointOnCurve(t:Number, target:Vector3D = null):Vector3D
Gets a point on the curve
IPath
  
getPointsOnCurvePerSegment(numSegments:uint):Vector.<Vector3D>
Deprecated: Deprecated
Discretizes the segment into a set of sample points.
IPath
  
getSegmentAt(index:uint):IPathSegment
Deprecated: Deprecated
Returns the CubicPathSegment at the specified index
IPath
  
removeSegment(index:uint, join:Boolean = false):void
Deprecated: Deprecated
Removes a segment from the path
IPath
Property Detail
numSegmentsproperty
numSegments:uint  [read-only]
Deprecated: Deprecated

The number of CubicPathSegment instances in the path.


Implementation
    public function get numSegments():uint
segmentsproperty 
segments:Vector.<IPathSegment>  [read-only]
Deprecated: Deprecated

The IPathSegment instances which make up this path.


Implementation
    public function get segments():Vector.<IPathSegment>
Method Detail
addSegment()method
public function addSegment(segment:IPathSegment):void
Deprecated: Deprecated

Adds a CubicPathSegment to the end of the path

Parameters

segment:IPathSegment

dispose()method 
public function dispose():void

Disposes the path and all the segments

getPointOnCurve()method 
public function getPointOnCurve(t:Number, target:Vector3D = null):Vector3D

Gets a point on the curve

Parameters

t:Number — The phase for which to get the point. A number between 0 and 1.
 
target:Vector3D (default = null) — An optional parameter to store the calculation, to avoid creating a new Vector3D object

Returns
Vector3D — The point on the curve for the given phase
getPointsOnCurvePerSegment()method 
public function getPointsOnCurvePerSegment(numSegments:uint):Vector.<Vector3D>
Deprecated: Deprecated

Discretizes the segment into a set of sample points.

Parameters

numSegments:uint — The amount of segments to split the sampling in. The amount of points returned is numSegments + 1 TODO: is this really even necessary? We should be able to simply call getPointOnCurve(t) instead, oblivious of segments

Returns
Vector.<Vector3D>
getSegmentAt()method 
public function getSegmentAt(index:uint):IPathSegment
Deprecated: Deprecated

Returns the CubicPathSegment at the specified index

Parameters

index:uint — The index of the segment

Returns
IPathSegment — A CubicPathSegment instance
removeSegment()method 
public function removeSegment(index:uint, join:Boolean = false):void
Deprecated: Deprecated

Removes a segment from the path

Parameters

index:uint — The index of the CubicPathSegment to be removed
 
join:Boolean (default = false) — Determines if the segments on either side of the removed segment should be adjusted so there is no gap.





Tue May 7 2013, 10:42 PM +01:00