Class M_Curve
Version added: before 9.5
The M_Curve class represents a curve in a vector layer.
Methods of M_Curve:
Name | Returns | Description | Ver |
AimControlHandleAtNeighbor AimControlHandleAtNeighbor(ptID, frame, prePoint) | void | Added in version 12 | 12.0 |
ClosestPointOnSegment ClosestPointOnSegment(segID, vec, forDrawing, extraPrecision) | Vector2 | < 9.5 | |
CorrectControlHandleAngles CorrectControlHandleAngles(ptID, frame, allFrames) | void | Added in version 12 | 12.0 |
CountPoints CountPoints() | int32 | Returns the number of points that make up the curve | < 9.5 |
CountSegments CountSegments() | int32 | Returns the number of segments on the curve | < 9.5 |
Curvature Curvature(id) | AnimVal | < 9.5 | |
CurveLength CurveLength() | real | < 9.5 | |
DeleteCurvatureKey DeleteCurvatureKey(id, when) | void | Added in version 14.0 | 14.0 |
DeselectCurvePoints DeselectCurvePoints() | void | Added in version 11 | 11.0 |
GetControlHandle GetControlHandle(ptID, frame, prePoint) | Vector2 | Returns position vector for one of two bezier handles | 12.0 |
GetControlPoints GetControlPoints(segID, p1, p2, p3, p4, forDrawing) | void | Returns the control points for the given segment id | < 9.5 |
GetCurvature GetCurvature(ptID, frame) | real | Returns the curvature through a given point on the curve | < 9.5 |
GetOffset GetOffset(ptID, frame, prePoint) | real | Returns one of the handles' offsets through a given point on the curve | 12.0 |
GetPercentLocation GetPercentLocation(percent) | Vector2 | < 9.5 | |
GetPercentTangent GetPercentTangent(percent) | Vector2 | < 9.5 | |
GetSegmentRange GetSegmentRange(segID, startPercent, endPercent) | real, real | < 9.5 | |
GetWeight GetWeight(ptID, frame, prePoint) | real | Returns one of the handles' offsets through a given point on the curve | 12.0 |
IsPartiallySelected IsPartiallySelected() | bool | Are any points on this curve selected? | < 9.5 |
IsPointOnSegment IsPointOnSegment(ptID, segID) | bool | Returns true if the given point is on the given curve segment | < 9.5 |
IsSegmentOn IsSegmentOn(segID) | bool | Tests whether a given curve segment is on or not | < 9.5 |
IsSegmentSelected IsSegmentSelected(segID) | bool | Tests whether a segment is selected | < 9.5 |
IsSelected IsSelected() | bool | Are all points on this curve selected? | < 9.5 |
Point Point(id) | M_Point | Returns one of the points making up the curve (use 0 for the first point on the curve) | < 9.5 |
PointID PointID(point) | int32 | Curve point ID for a given point object | 12.0 |
PointOnSegment PointOnSegment(segID, percent, forDrawing) | Vector2 | Returns the location of a point on a segment | < 9.5 |
ResetControlHandles ResetControlHandles(ptID, frame) | void | Added in version 12 | 12.0 |
SegmentLength SegmentLength(segID) | real | < 9.5 | |
SelectCurvePoints SelectCurvePoints() | void | Added in version 11 | 11.0 |
SetControlHandle SetControlHandle(ptID, handle, frame, prePoint, syncAngles) | void | Sets position for one of two bezier handles through a given point on the curve | 12.0 |
SetCurvature SetCurvature(ptID, curvature, frame) | void | Sets the curvature through a given point on the curve | < 9.5 |
SetOffset SetOffset(ptID, offset, frame, prePoint) | void | Sets offset for one of two bezier handles through a given point on the curve | 12.0 |
SetProfileCurve SetProfileCurve(layer, curve) | void | < 9.5 | |
SetSegmentOn SetSegmentOn(segID, b) | void | Turns a curve segment on or off | < 9.5 |
SetWeight SetWeight(ptID, weight, frame, prePoint) | void | Sets weight for one of two bezier handles through a given point on the curve | 12.0 |
Properties of M_Curve:
Name | Type | Description | Ver |
fClosed | bool | true if the curve is closed, otherwise false | < 9.5 |
fEndPercent | AnimVal | This is actually end ratio in the range 0 to 1 inclusive - 0 is none and 1 is total | < 9.5 |
fProfileOffset | AnimVal | Added in version 14.2 | 14.2 |
fProfileRepeat | int32 | < 9.5 | |
fStartPercent | AnimVal | This is actually end ratio in the range 0 to 1 inclusive - 0 is none and 1 is total | < 9.5 |