Skip to main content

KPickHelper

kds-plugin-document / Exports / KPickHelper

Interface: KPickHelper

选择帮助器

The KPickHelper class is used to pick entities.

Table of contents

Methods

Methods

pickByPoint

pickByPoint(x, y, pickSetting?): KPointPickResult

点选。 使用一个 client 窗口的 x,y 坐标来做选择

The method is used to pick by point.

Parameters

NameTypeDescription
xnumberX screen coordinate for the pick.
ynumberY screen coordinate for the pick.
pickSetting?KPickSettingThe setting for the pick.

Returns

KPointPickResult

The result of point pick.

Defined in

api.d.ts:3596


pickByPoint3d

pickByPoint3d(x, y, z, pickSetting?): KPointPickResult

点选。 使用一个 场景世界坐标系的三维坐标来做选择

The method is used to pick by point.

Parameters

NameTypeDescription
xnumberX world coordinate for the pick.
ynumberY world coordinate for the pick.
znumberZ world coordinate for the pick.
pickSetting?KPickSettingThe setting for the pick.

Returns

KPointPickResult

The result of point pick.

Defined in

api.d.ts:3621


pickByRectangle

pickByRectangle(startPoint, endPoint, pickSetting?): KRectPickResult

框选。 使用一个 client 窗口的 2d 矩形来做选择

The method is used to pick by rectangle.

Parameters

NameTypeDescription
startPointKPoint2dFirst screen coordinate point.
endPointKPoint2dSecond screen coordinate point.
pickSetting?KPickSettingThe setting for the pick.

Returns

KRectPickResult

The result of rectangle pick.

Defined in

api.d.ts:3608