KCircle2d

kds-plugin-document / Exports / KCircle2d

Interface: KCircle2d

KCircle2d类代表着二维空间中的一个圆。

The KCircle2d class represents a circle in 2d space.

Hierarchy

• KCurve2d

  ↳ KCircle2d

Table of contents

Properties

• center
• radius

Methods

• clone
• getClosestPoint
• getCurvatureVector
• getInterval
• getParam
• getPoint
• getTangent
• getType
• isEqual
• isPointOnCurve
• reverse
• transform

Properties

center

• Readonly center: KPoint2d

获取圆心。

Get center of the circle.

Defined in

api.d.ts:7936

---

radius

• Readonly radius: number

获取圆的半径。

Get radius of the circle.

Defined in

api.d.ts:7942

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

Name	Type	Description
point	KPoint2d	传入点。 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

Name	Type	Description
point	KPoint2d	曲线上一点。 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

Name	Type	Description
point	KPoint2d	曲线上的一点。 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

Name	Type	Description
t	number	参数值 Parameter value

Returns

KPoint2d

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

The point on the curve for the input parameter.

Inherited from

KCurve2d.getPoint

Defined in

api.d.ts:8134

---

getTangent

▸ getTangent(point): KVector2d

获取圆上一点的法向量。 注意：传入点需要确保落在圆上。

Get circle's tangent vector of a point on the circle. NOTE: the caller need to make sure the point is on the circle.

Parameters

Name	Type	Description
point	KPoint2d	圆上一点。 A point on the circle.

Returns

KVector2d

切向量。

The tangent vector.

Defined in

api.d.ts:7958

---

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

Name	Type	Description
curve	KCurve2d	-
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

Name	Type	Description
point	KPoint2d	传入点。 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

---

reverse

▸ reverse(): void

把当前曲线反向。

reverse the current curve.

Returns

void

Inherited from

KCurve2d.reverse

Defined in

api.d.ts:8232

---

transform

▸ transform(matrix): boolean

对当前圆进行变换。 注意：如果变换之后的几何不是一个圆，则会抛出error, 本操作仅支持旋转和平移。

Transform this circle to a new one. NOTE: If the new one is not a circle, it will throw error. Only support for rotate and move translation now.

Parameters

Name	Type	Description
matrix	KMatrix3	变换矩阵。 The transform matrix.

Returns

boolean

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

Return true if successful, otherwise return false.

Overrides

KCurve2d.transform

Defined in

api.d.ts:7974