Package | away3d.paths |
Interface | public interface IPath |
Implementors | CubicPath, QuadraticPath, SegmentedPathBase |
Property | Defined 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 |
Method | Defined 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 |
numSegments | property |
numSegments:uint
[read-only]
The number of CubicPathSegment
instances in the path.
public function get numSegments():uint
segments | property |
segments:Vector.<IPathSegment>
[read-only]
The IPathSegment
instances which make up this path.
public function get segments():Vector.<IPathSegment>
addSegment | () | method |
public function addSegment(segment:IPathSegment):void
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
|
Vector3D — The point on the curve for the given phase
|
getPointsOnCurvePerSegment | () | method |
public function getPointsOnCurvePerSegment(numSegments:uint):Vector.<Vector3D>
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
|
Vector.<Vector3D> |
getSegmentAt | () | method |
public function getSegmentAt(index:uint):IPathSegment
Returns the CubicPathSegment
at the specified index
Parameters
index:uint — The index of the segment
|
IPathSegment — A CubicPathSegment instance
|
removeSegment | () | method |
public function removeSegment(index:uint, join:Boolean = false):void
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.
|