CurveLocation objects describe a location on Curve objects, as defined by the curve parameter, a value between 0 (beginning of the curve) and 1 (end of the curve). If the curve is part of a Path item, its index inside the path.curves list is also provided.
The class is in use in many places, such as path.getLocation(offset), path.getPoint(offset), path.split(location), pathItem.getIntersections(path), etc.
Constructors
- Parameters:
- curve: Curve
- parameter: Number
- Returns:
- CurveLocation
- Parameters:
- path: Path
- index: Number
- parameter: Number
- Returns:
- CurveLocation
Properties
The index of the curve within the path.curves list, if the curve is part of a Path item. Read-only.
- Returns:
- Number
The length of the path from its beginning up to the location described by this object. Read-only.
- Returns:
- Number
The length of the curve from its beginning up to the location described by this object. Read-only.
- Returns:
- Number
The curve parameter, as used by various bezier curve calculations. It is value between 0 (beginning of the curve) and 1 (end of the curve). Read-only.
- Returns:
- Number