Skip to main content

KLine2d

kds-plugin-document / Exports / KLine2d

Interface: KLine2d

KLine2d类代表二维空间的一条直线。 我们用一个点加一个向量来确定一条直。

The KLine2d class represents a line in 2d space.

Hierarchy​

Table of contents​

Properties​

Methods​

Properties​

direction​

• Readonly direction: KVector2d

获得直线的方向。

Get line's direction.

Defined in​

api.d.ts:11021

leftDirection​

• Readonly leftDirection: KVector2d

获得直线的左侧方向。

Get Line2d's left direction (perpendicular vector pointing to the left side).

Defined in​

api.d.ts:11027

origin​

• Readonly origin: KPoint2d

获得直线的原点。

Get line's origin point

Defined in​

api.d.ts:11015

rightDirection​

• Readonly rightDirection: KVector2d

获得直线的右侧方向。

Get Line2d's right direction (perpendicular vector pointing to the right side).

Defined in​

api.d.ts:11033

Methods​

clone​

▸ clone(): KCurve2d

复制一个当前曲线。

Return the cloned curve of this.

Returns​

KCurve2d

复制的曲线。

The cloned curve.

Inherited from​

KCurve2d.clone

Defined in​

api.d.ts:8226

getClosestPoint​

▸ getClosestPoint(point, tolerance?): KPoint2d

获得在指定容差下曲线上距离传入点最近的一点。

Get the closest point on curve for the input point with specified tolerance.

Parameters​

NameTypeDescription
pointKPoint2d传入点。 The input point.
tolerance?number指定容差，默认容差是1e-6。 The specified tolerance.The default value is 1e-6.

Returns​

KPoint2d

最近点。

The closest point.

Inherited from​

KCurve2d.getClosestPoint

Defined in​

api.d.ts:8198

getCurvatureVector​

▸ getCurvatureVector(point): KVector2d

求曲线上某点处的曲率向量。

Get curve's curvature vector for the input point on the curve.

Parameters​

NameTypeDescription
pointKPoint2d曲线上一点。 A point on curve.

Returns​

KVector2d

曲率向量。 向量的模为曲率值，向量的方向为曲率方向。

A curvature vector. Its norm represents the curvature value. Its direction represents the curvature's direction.

Inherited from​

KCurve2d.getCurvatureVector

Defined in​

api.d.ts:8248

getInterval​

▸ getInterval(): KInterval

获取曲线的参数域区间。

Get the parameter interval of the curve.

Returns​

KInterval

曲线的参数域区间。

The parameter interval of the curve.

Inherited from​

KCurve2d.getInterval

Defined in​

api.d.ts:8120

getParam​

▸ getParam(point): number

反求输入点对应的曲线参数值。

Get point's corresponding parameter value on the curve.

Parameters​

NameTypeDescription
pointKPoint2d曲线上的一点。 Point on curve

Returns​

number

输入点对应的曲线参数值。

The corresponding parameter of the point on curve.

Inherited from​

KCurve2d.getParam

Defined in​

api.d.ts:8148

getPoint​

▸ getPoint(t): KPoint2d

求曲线参数值对应的曲线上的点位置。

Get the point on the curve specified by the input parameter t.

Parameters​

NameTypeDescription
tnumber参数值 Parameter value

Returns​

KPoint2d

曲线参数对应的曲线上的点。

The point on the curve for the input parameter.

Inherited from​

KCurve2d.getPoint

Defined in​

api.d.ts:8134

getType​

▸ getType(): KCurve2dType

获得曲线的类型。

Get the curve's type.

Returns​

KCurve2dType

曲线的类型。

The curve's type.

Inherited from​

KCurve2d.getType

Defined in​

api.d.ts:8110

isEqual​

▸ isEqual(curve, tolerance?): boolean

检查两个曲线在指定容差下是否相等。

Check whether two curves are equal with specified tolerance.

Parameters​

NameTypeDescription
curveKCurve2d-
tolerance?number指定容差，默认容差是1e-6。 The specified tolerance.The default value is 1e-6.

Returns​

boolean

如果相等上返回true。

Return true if equal, otherwise return false.

Inherited from​

KCurve2d.isEqual

Defined in​

api.d.ts:8216

isPointOnCurve​

▸ isPointOnCurve(point, tolerance?): boolean

检查传入点在指定容差下是否位于曲线上。

Check whether the input point is on the curve or not with specified tolerance.

Parameters​

NameTypeDescription
pointKPoint2d传入点。 The input point.
tolerance?number指定容差，默认容差是1e-6。 The specified tolerance.The default value is 1e-6.

Returns​

boolean

如果在曲线上返回true。

Return true if on the curve, otherwise return false.

Inherited from​

KCurve2d.isPointOnCurve

Defined in​

api.d.ts:8180

onLeftSide​

▸ onLeftSide(point, tol?): boolean

检查一个点是不是在直线的左侧。

Check whether a point is on the left side of the line.

Parameters​

NameTypeDescription
pointKPoint2d待检查的点。 Point to check.
tol?number距离容差。如果没有给定，则采用全局容差。 distance tolerance. If it is not provided, then global tolerance is used.

Returns​

boolean

如果点在直线左侧则返回真，否则为假。

True, if the point is on the left side of the line, otherwise false.

Defined in​

api.d.ts:11070

onRightSide​

▸ onRightSide(point, tol?): boolean

检查一个点是不是在直线的右侧。

Check whether a point is on the right side of the line.

Parameters​

NameTypeDescription
pointKPoint2d待检查的点。 Point to check.
tol?number距离容差。如果没有给定，则采用全局容差。 distance tolerance. If it is not provided, then global tolerance is used.

Returns​

boolean

如果点在直线右侧则返回真，否则为假。

True, if the point is on the right side of the line, otherwise false.

Defined in​

api.d.ts:11088

reverse​

▸ reverse(): void

把当前曲线反向。

reverse the current curve.

Returns​

void

Inherited from​

KCurve2d.reverse

Defined in​

api.d.ts:8232

side​

▸ side(point, tol?): 0 | 1 | -1

检查一个点相对当前这条二维直线的位置。如果在曲线左侧，则返回1。如果在曲线上，则返回0。如果在曲线右侧，则返回-1。

Check the position of the point against the current 2d line. Return 1, if the point is on the left side. Return 0, if the point is on the line. Return -1, if the point is one the right side.

Parameters​

NameTypeDescription
pointKPoint2d待检查的点。 Point to check.
tol?number距离容差。如果没有给定，则采用全局容差。 distance tolerance. If it is not provided, then global tolerance is used.

Returns​

0 | 1 | -1

如果在曲线左侧，则返回1。如果在曲线上，则返回0。如果在曲线右侧，则返回-1。

Return 1, if the point is on the left side. Return 0, if the point is on the line. Return -1, if the point is one the right side.

Defined in​

api.d.ts:11052

transform​

▸ transform(matrix): boolean

对当前曲线进行变换。

Transform this curve to a new one.

Parameters​

NameTypeDescription
matrixKMatrix3变换矩阵。 The transform matrix.

Returns​

boolean

当执行正确的话，返回true。

Return true if successful, otherwise return false.

Inherited from​

KCurve2d.transform

Defined in​

api.d.ts:8162