M3D / M3D / Actions / RaypickAction

Class: RaypickAction

M3D.Actions.RaypickAction

Memberof

M3D.Actions

Description

射线拾取Action

Author

YW

Date

Hierarchy

• Action

  ↳ RaypickAction

Table of contents

Constructors

• constructor

Properties

• id
• count

Methods

• addIntersectPnt
• addIntersectTrianglePnts
• addShape
• addToFramePickCollection
• beginOnceFramePick
• beginPickAsGroup
• canPickGeo
• canPickShape
• endPickAsGroup
• execute
• frustumIntersectWithWorldBox
• getAllPickPoint
• getData
• getEvents
• getFarPickShape
• getFramePickMatchPntCount
• getFramePickShapes
• getFramePickType
• getId
• getIntersectPnts
• getIntersectType
• getIsPickAll
• getNearPickPoint
• getNearPickShape
• getNearestPickPoint
• getNormal
• getOnceFramePickCount
• getPickGeoType
• getPickShapeType
• getScreenPoint
• getUseClipPlane
• getViewport
• increaseFramePickMatchPntCount
• increaseFramePickPntCount
• intersect
• isIntersectRayAndTriangle
• isPointInFrustum
• isintersecFrustumLine
• isintersecFrustumTriangle
• registerEvent
• removeEvent
• setFramePickSection
• setFramePickType
• setId
• setIntersectType
• setNearestPickPoint
• setPickAll
• setPickGeoType
• setPickRadius
• setPickShapeFilterType
• setPickShapeType
• setRay
• setShapePickState
• setUseClipPlane
• setViewport
• updateFramePickFrustum
• updateGroupPickPnts
• updateIntersectPnts
• updateModelRay
• getPickPosition
• getPickShape

Constructors

constructor

• new RaypickAction(viewport): RaypickAction

Parameters

Name	Type	Description
viewport	Viewport	视口

Returns

RaypickAction

Description

构造函数

Overrides

Action.constructor

Properties

id

• id: number

Inherited from

Action.id

---

count

▪ Static count: number

Inherited from

Action.count

Methods

addIntersectPnt

▸ addIntersectPnt(pos): void

Parameters

Name	Type	Description
pos	Vector3	模型交点

Returns

void

Description

临时记录和模型的相交点

---

addIntersectTrianglePnts

▸ addIntersectTrianglePnts(normal): void

Parameters

Name	Type
normal	Vector3

Returns

void

Description

给存储射线和三角面片的交点添加射线相交的三角面片法线

---

addShape

▸ addShape(shape, zIndex?): void

Parameters

Name	Type	Description
shape	Shape	shape对象
zIndex?	number	拾取优先级

Returns

void

Description

将相交对象，加入缓存列表，供最后判断拾取先后关系使用

---

addToFramePickCollection

▸ addToFramePickCollection(shape): void

Parameters

Name	Type	Description
shape	Shape	Shape对象

Returns

void

Description

添加到框选集合

---

beginOnceFramePick

▸ beginOnceFramePick(): void

Returns

void

Description

开始当前一次框选

---

beginPickAsGroup

▸ beginPickAsGroup(shape): void

Parameters

Name	Type
shape	Shape

Returns

void

Description

以组开始拾取（未实现）

---

canPickGeo

▸ canPickGeo(geoType): boolean

Parameters

Name	Type	Description
geoType	GeoFeatureEnum	待判断的几何属性类型

Returns

boolean

true 能够拾取此类型 false 不能够拾取此类型

Description

判断当前拾取动作，能否拾取此几何类型的shape

---

canPickShape

▸ canPickShape(shapeType): boolean

Parameters

Name	Type	Description
shapeType	ShapeType	待判断的类型

Returns

boolean

true 能够拾取此类型 false 不能够拾取此类型

Description

判断当前拾取动作能否拾取此类型

---

endPickAsGroup

▸ endPickAsGroup(shape, zIndex?): void

Parameters

Name	Type
shape	Shape
zIndex?	number

Returns

void

Description

结束以组拾取（未实现）

---

execute

▸ execute(): ActionState

Returns

ActionState

Description

执行Action

Inherited from

Action.execute

---

frustumIntersectWithWorldBox

▸ frustumIntersectWithWorldBox(box): boolean

Parameters

Name	Type	Description
box	BoundingBox	待求交的包围盒

Returns

boolean

true相交 false 不相交

Description

是否和包围盒相交

---

getAllPickPoint

▸ getAllPickPoint(shape): Vector3[]

Parameters

Name	Type
shape	Shape

Returns

Vector3[]

所有拾取点

Description

获取所有拾取点

---

getData

▸ getData(): RayPickActionData

Returns

RayPickActionData

射线求交数据

Description

获取射线求交的数据

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

Action.getEvents

---

getFarPickShape

▸ getFarPickShape(): Shape

Returns

Shape

拾取到的对象 null 表示没有拾取到

Description

得到最后端拾取对象

---

getFramePickMatchPntCount

▸ getFramePickMatchPntCount(): number

Returns

number

框选相交模型数量

Description

获取当前一次框选相交模型数量

---

getFramePickShapes

▸ getFramePickShapes(): Shape[]

Returns

Shape[]

拾取到的对象 null 表示没有拾取到

Description

获取存储所有框选相交的对象

---

getFramePickType

▸ getFramePickType(): number

Returns

number

框选类型 1 inside 全部在内部 2 intersect 相交即可

Description

获取框选类型

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

Action.getId

---

getIntersectPnts

▸ getIntersectPnts(): Vector3[]

Returns

Vector3[]

模型交点数组

Description

获取所有和模型的相交点

---

getIntersectType

▸ getIntersectType(): number

Returns

number

求交类型 0 三角网格相交 1 线相交 2 点相交

Description

获取求交类型 0 三角网格相交 1 线相交 2 点相交

---

getIsPickAll

▸ getIsPickAll(): boolean

Returns

boolean

是否框选

Description

是否框选

---

getNearPickPoint

▸ getNearPickPoint(): Vector3

Returns

Vector3

拾取到的点 null表示没有拾取到

Description

得到最前端的拾取到的点

---

getNearPickShape

▸ getNearPickShape(): Shape

Returns

Shape

拾取到的对象 null 表示没有拾取到

Description

得到最前端拾取对象

---

getNearestPickPoint

▸ getNearestPickPoint(): Vector3

Returns

Vector3

拾取到的模型最近的点

Description

获取拾取到的模型最近的点

---

getNormal

▸ getNormal(): Vector3

Returns

Vector3

返回法向

Description

返回拾取到的三角面片的法向

---

getOnceFramePickCount

▸ getOnceFramePickCount(): number

Returns

number

框选数量

Description

获取当前框选数量

---

getPickGeoType

▸ getPickGeoType(): GeoFeatureEnum

Returns

GeoFeatureEnum

允许拾取对象的几何属性类型

Description

获取允许拾取对象的几何属性类型

---

getPickShapeType

▸ getPickShapeType(): PickShapeFilterType

Returns

PickShapeFilterType

拾取类型

Description

获取拾取类型

---

getScreenPoint

▸ getScreenPoint(): Vector2

Returns

Vector2

屏幕点

Description

获取屏幕点

---

getUseClipPlane

▸ getUseClipPlane(): boolean

Returns

boolean

是否需要考虑裁剪平面

Description

获取是否需要考虑裁剪平面

---

getViewport

▸ getViewport(): Viewport

Returns

Viewport

视口对象

Description

获取当前视口

---

increaseFramePickMatchPntCount

▸ increaseFramePickMatchPntCount(): void

Returns

void

Description

当前一次框选相交模型数量加一

---

increaseFramePickPntCount

▸ increaseFramePickPntCount(): void

Returns

void

Description

当前框选拾取数量加一

---

intersect

▸ intersect(v0, v1): Vector3

Parameters

Name	Type	Description
v0	Vector3	线段起点
v1	Vector3	线段终点

Returns

Vector3

交点 null表示没有交点

Description

射线是否和线段相交

▸ intersect(point): boolean

Parameters

Name	Type	Description
point	Vector3	待判断点

Returns

boolean

true相交 false不相交

Description

射线是否和点相交

▸ intersect(point, size): boolean

Parameters

Name	Type	Description
point	Vector3	待判断点
size	number	点的大小

Returns

boolean

true相交 false不相交

Description

射线折否和点相交

---

isIntersectRayAndTriangle

▸ isIntersectRayAndTriangle(v0, v1, v2): Vector3

Parameters

Name	Type	Description
v0	Vector3	三角形第一个点
v1	Vector3	第二个点
v2	Vector3	第三个点

Returns

Vector3

交点 null表示没有交点

Description

射线是否和三角形有交点

▸ isIntersectRayAndTriangle(v0, v1, v2, ray): Vector3

Parameters

Name	Type	Description
v0	Vector3	三角形第一个点
v1	Vector3	第二个点
v2	Vector3	第三个点
ray	Ray	射线

Returns

Vector3

交点 null表示没有交点

Description

射线是否和三角形有交点

---

isPointInFrustum

▸ isPointInFrustum(v0): boolean

Parameters

Name	Type
v0	Vector3

Returns

boolean

是否在视锥体内

Description

点是否在视锥体内

---

isintersecFrustumLine

▸ isintersecFrustumLine(raypickAction, v0, v1): boolean

Parameters

Name	Type	Description
raypickAction	RaypickAction
v0	Vector3	线段第一个点
v1	Vector3	第二个点

Returns

boolean

是否相交

Description

判断线段是否与视锥体相交

---

isintersecFrustumTriangle

▸ isintersecFrustumTriangle(v0, v1, v2): boolean

Parameters

Name	Type	Description
v0	Vector3	三角形第一个点
v1	Vector3	第二个点
v2	Vector3	第三个点

Returns

boolean

是否相交

Description

判断视锥体的四条射线是否和三角形相交

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

Action.registerEvent

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

Action.removeEvent

---

setFramePickSection

▸ setFramePickSection(leftTop, rightBottom): void

Parameters

Name	Type	Description
leftTop	Vector2	左上角位置点
rightBottom	Vector2	右下角位置点

Returns

void

Description

设置框选区域

---

setFramePickType

▸ setFramePickType(framePickType): void

Parameters

Name	Type	Description
framePickType	number	框选类型 1 inside 全部在内部 2 intersect 相交即可

Returns

void

Description

设置框选类型

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

Action.setId

---

setIntersectType

▸ setIntersectType(type): void

Parameters

Name	Type	Description
type	number	求交类型 0 三角网格相交 1 线相交 2 点相交

Returns

void

Description

设置求交类型

---

setNearestPickPoint

▸ setNearestPickPoint(val): void

Parameters

Name	Type	Description
val	Vector3	拾取到的模型最近的点

Returns

void

Description

设置拾取到的模型最近的点

---

setPickAll

▸ setPickAll(flag): void

Parameters

Name	Type	Description
flag	boolean	是否为框选

Returns

void

Description

设置框选标识

---

setPickGeoType

▸ setPickGeoType(geoType): void

Parameters

Name	Type	Description
geoType	GeoFeatureEnum	拾取对象的几何属性类型

Returns

void

Description

设置待拾取对象具有的几何属性类型

---

setPickRadius

▸ setPickRadius(radius): void

Parameters

Name	Type	Description
radius	number	拾取阈值

Returns

void

Description

设置拾取阈值，此阈值对应屏幕上的距离，不可过大也不用过小。建议 10 -- 20 像素

---

setPickShapeFilterType

▸ setPickShapeFilterType(shapeType, excludeShapeType?): void

Parameters

Name	Type	Description
shapeType	PickShapeFilterType	拾取对象的类型
excludeShapeType?	ShapeType	排除的拾取对象

Returns

void

Description

设置待拾取对象的类型

---

setPickShapeType

▸ setPickShapeType(shapeType, excludeShapeType?): void

Parameters

Name	Type	Description
shapeType	ShapeType	拾取对象的类型
excludeShapeType?	ShapeType	排除的拾取对象

Returns

void

Description

设置待拾取对象的类型

---

setRay

▸ setRay(winx, winY): any

Parameters

Name	Type	Description
winx	number	屏幕坐标x
winY	number	屏幕坐标y

Returns

any

Description

设置射线 根据屏幕坐标点

▸ setRay(ray): any

Parameters

Name	Type	Description
ray	Ray	射线对象

Returns

any

Description

设置射线

▸ setRay(screenPnt): any

Parameters

Name	Type	Description
screenPnt	Vector2	屏幕坐标点

Returns

any

Description

设置射线 根据屏幕坐标点

---

setShapePickState

▸ setShapePickState(shapeType, state): void

Parameters

Name	Type	Description
shapeType	ShapeType	拾取对象的类型
state	boolean	状态

Returns

void

Description

设置Shape拾取状态

---

setUseClipPlane

▸ setUseClipPlane(val): void

Parameters

Name	Type	Description
val	boolean	是否需要考虑裁剪平面

Returns

void

Description

设置是否需要考虑裁剪平面

---

setViewport

▸ setViewport(viewport): void

Parameters

Name	Type	Description
viewport	Viewport	视口对象

Returns

void

Description

设置当前视口

---

updateFramePickFrustum

▸ updateFramePickFrustum(modelMatrix): void

Parameters

Name	Type
modelMatrix	Matrix3x4

Returns

void

Description

更新框选视锥

---

updateGroupPickPnts

▸ updateGroupPickPnts(): void

Returns

void

Description

更新拾取点（未实现）

---

updateIntersectPnts

▸ updateIntersectPnts(modelMatrix): void

Parameters

Name	Type
modelMatrix	Matrix3x4

Returns

void

Description

更新相交点（未实现）

---

updateModelRay

▸ updateModelRay(modelMatrix): void

Parameters

Name	Type	Description
modelMatrix	Matrix3x4	模型世界坐标系变换矩阵

Returns

void

Description

通过模型矩阵，更新模型局部坐标系射线

---

getPickPosition

▸ getPickPosition(scene, isNear, screenPos): Vector3

Parameters

Name	Type	Description
scene	Scene	场景
isNear	boolean
screenPos	Vector2

Returns

Vector3

Description

拾取模型上的点

▸ getPickPosition(scene, isNear, ray): Vector3

Parameters

Name	Type
scene	Scene
isNear	boolean
ray	Ray

Returns

Vector3

---

getPickShape

▸ getPickShape(scene, screenPos, shapeType): Shape

Parameters

Name	Type	Description
scene	Scene	场景
screenPos	Vector2	屏幕点
shapeType	ShapeType	shape类型

Returns

Shape

Description

根据类型拾取Shape