M3D / M3D / Shapes / SectionPlane

Class: SectionPlane

M3D.Shapes.SectionPlane

Memberof

M3D.Shapes

Implements

Utility.Subscriber

Description

剖切面

Date

2022-1-12

Version

1.0

Copyright

All Rights Reserved. Copyright (C) 2022 HOTEAMSOFT, Ltd

Hierarchy

• RenderableShape

  ↳ SectionPlane

  ↳↳ CrossSection

Implements

• Subscriber

Table of contents

Constructors

• constructor

Properties

• absNormal
• crossSections
• d
• dirtyEdge
• figureSectionLines
• id
• sectionLineRoot
• sectionLinesDataBase
• showEdge
• count
• isProto
• pVertexHeader

Accessors

• isProto

Methods

• addEffect
• calMatrixByPntXZAxis
• clearFigureSectionLines
• clearSectionLineDataBse
• copy
• expandClpPlane
• getAlpha
• getBoundingBox
• getCappingColor
• getCenterPoint
• getColor
• getDrawables
• getEdgeColor
• getEffect
• getEnable
• getEquation
• getEvents
• getFaceColor
• getId
• getInsectPnt
• getIsDirty
• getIsFrontShow
• getIsSectionBox
• getLocalTransform
• getModelWidthAndLength
• getName
• getNeedClip
• getNormalArray
• getObjectId
• getOriShowCappingPlane
• getOriShowClipPlane
• getParam
• getParameters
• getPointArray
• getPosition
• getProgress
• getProperties
• getProto
• getRenderShapes
• getReverseClip
• getRotation
• getScene
• getSceneBox
• getSectionBox
• getSectionLine
• getSectionLineColor
• getSectionLineInfo
• getSelectedModelList
• getSelectedModelPath
• getShaderProgramName
• getShapeType
• getShowCappingPlane
• getShowClipPlane
• getShowCutPlane
• getShowPlaneRect
• getShowSectionLine
• getStates
• getTextureObject
• getTransformPlaneParam
• getType
• getVertexHeader
• getVertexSet
• getWorldBoundingBox
• getWorldTransform
• init
• intersect
• isNeedUpdate
• isPlaneAvaliable
• isPreSelected
• isSelected
• isVisible
• markDirty
• post
• registerEvent
• removeEffect
• removeEvent
• send
• sendClipMessage
• sendEffectMessage
• sendUpdateMessage
• setAlpha
• setBox
• setCappingColor
• setCenterPoint
• setColor
• setDraggerTransform
• setDrawPlane
• setEdgeColor
• setEffect
• setEnable
• setFaceColor
• setFrontShow
• setId
• setIsSectionBox
• setName
• setNeedClip
• setNeedUpdate
• setNorPos
• setObjectId
• setOriPos
• setOriShowCappingPlane
• setOriShowClipPlane
• setPlaneParam
• setPosition
• setProgress
• setReverseClip
• setScene
• setSceneBox
• setSectionBox
• setSectionLineColor
• setSelected
• setSelectedModelList
• setSelectedModelPath
• setShaderProgramName
• setShapeType
• setShowCappingPlane
• setShowClipPlane
• setShowCutPlane
• setShowPlaneRect
• setShowSectionLine
• setTransform
• setVisible
• setWorldTransform
• update
• updateDrawData

Constructors

constructor

• new SectionPlane(origin, normal, uDir, vDir): SectionPlane

Parameters

Name	Type
origin	Vector3
normal	Vector3
uDir	Vector3
vDir	Vector3

Returns

SectionPlane

Description

构造函数

Overrides

RenderableShape.constructor

• new SectionPlane(origin, normal): SectionPlane

Parameters

Name	Type
origin	Vector3
normal	Vector3

Returns

SectionPlane

Description

构造函数

Overrides

RenderableShape.constructor

• new SectionPlane(): SectionPlane

Returns

SectionPlane

Overrides

RenderableShape.constructor

Properties

absNormal

• absNormal: Vector3

---

crossSections

• crossSections: CrossSection[]

---

d

• d: number

---

dirtyEdge

• dirtyEdge: number

---

figureSectionLines

• figureSectionLines: FigureSectionLine

---

id

• id: number

Inherited from

RenderableShape.id

---

sectionLineRoot

• sectionLineRoot: SectionLine

---

sectionLinesDataBase

• sectionLinesDataBase: SectionDataBase

---

showEdge

• showEdge: boolean

---

count

▪ Static count: number

Inherited from

RenderableShape.count

---

isProto

▪ Static isProto: string

Inherited from

RenderableShape.isProto

---

pVertexHeader

▪ Static pVertexHeader: string

Inherited from

RenderableShape.pVertexHeader

Accessors

isProto

• get isProto(): boolean

Returns

boolean

Description

获取是否为原型对象

Inherited from

RenderableShape.isProto

• set isProto(v): void

Parameters

Name	Type
v	boolean

Returns

void

Description

设置是否为原型对象

Inherited from

RenderableShape.isProto

Methods

addEffect

▸ addEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

添加特效效果

Inherited from

RenderableShape.addEffect

---

calMatrixByPntXZAxis

▸ calMatrixByPntXZAxis(point, nvec, baseX, matrix): number

Parameters

Name	Type
point	number[]
nvec	number[]
baseX	number[]
matrix	Matrix3x4

Returns

number

Deprecated

---

clearFigureSectionLines

▸ clearFigureSectionLines(): void

Returns

void

Description

清除剖切轮廓线数据

---

clearSectionLineDataBse

▸ clearSectionLineDataBse(): void

Returns

void

Description

清除剖切线数据库的数据

---

copy

▸ copy(sectionPlane): void

Parameters

Name	Type
sectionPlane	SectionPlane

Returns

void

Description

剖切面数据拷贝

---

expandClpPlane

▸ expandClpPlane(sbMinPnt, sbMaxPnt): void

Parameters

Name	Type
sbMinPnt	Vector3
sbMaxPnt	Vector3

Returns

void

Deprecated

扩展剖切平面

---

getAlpha

▸ getAlpha(): number

Returns

number

Description

获取透明度

Inherited from

RenderableShape.getAlpha

---

getBoundingBox

▸ getBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取包围盒

Overrides

RenderableShape.getBoundingBox

---

getCappingColor

▸ getCappingColor(): Color

Returns

Color

Description

获取剖切盖面颜色

---

getCenterPoint

▸ getCenterPoint(): Vector3

Returns

Vector3

Description

获取中心点

---

getColor

▸ getColor(): Color

Returns

Color

Description

获取颜色

Inherited from

RenderableShape.getColor

---

getDrawables

▸ getDrawables(): void

Returns

void

Description

获取渲染数据

Inherited from

RenderableShape.getDrawables

---

getEdgeColor

▸ getEdgeColor(): Color

Returns

Color

Description

获取剖切面边线的颜色

---

getEffect

▸ getEffect(): number

Returns

number

Description

获取效果

Inherited from

RenderableShape.getEffect

---

getEnable

▸ getEnable(): boolean

Returns

boolean

Description

获取是否显示

---

getEquation

▸ getEquation(): number[]

Returns

number[]

Description

获取平面参数，用于glClipPlane

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

RenderableShape.getEvents

---

getFaceColor

▸ getFaceColor(): Color

Returns

Color

Description

获取剖切面的颜色

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

RenderableShape.getId

---

getInsectPnt

▸ getInsectPnt(origin, dir): Vector3

Parameters

Name	Type
origin	Vector3
dir	Vector3

Returns

Vector3

Description

获取交点

---

getIsDirty

▸ getIsDirty(): boolean

Returns

boolean

Description

获取脏标记

---

getIsFrontShow

▸ getIsFrontShow(): boolean

Returns

boolean

Description

获取是否前端显示

Inherited from

RenderableShape.getIsFrontShow

---

getIsSectionBox

▸ getIsSectionBox(): boolean

Returns

boolean

Description

获取是否为Box剖切

---

getLocalTransform

▸ getLocalTransform(): Matrix4

Returns

Matrix4

Description

获取shape的局部矩阵

Inherited from

RenderableShape.getLocalTransform

---

getModelWidthAndLength

▸ getModelWidthAndLength(): Map<string, number>

Returns

Map<string, number>

Description

获取模型长宽高

---

getName

▸ getName(): string

Returns

string

Description

获取剖切面名称

Overrides

RenderableShape.getName

---

getNeedClip

▸ getNeedClip(): boolean

Returns

boolean

Description

获取是否需要剖切

Inherited from

RenderableShape.getNeedClip

---

getNormalArray

▸ getNormalArray(): Vector3[]

Returns

Vector3[]

Description

得到显示面的顶点法线值

---

getObjectId

▸ getObjectId(): number

Returns

number

Description

获取ObjectId

Inherited from

RenderableShape.getObjectId

---

getOriShowCappingPlane

▸ getOriShowCappingPlane(): boolean

Returns

boolean

Description

获取剖切盖面的初始显示标示

---

getOriShowClipPlane

▸ getOriShowClipPlane(): boolean

Returns

boolean

Description

获取剖切盖面的初始显示标示

---

getParam

▸ getParam(): void

Returns

void

Description

根据法线计算参数

---

getParameters

▸ getParameters(): ShapeParameter[]

Returns

ShapeParameter[]

Description

获取渲染参数

Inherited from

RenderableShape.getParameters

---

getPointArray

▸ getPointArray(): Vector3[]

Returns

Vector3[]

Description

得到要显示面的顶点坐标值

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Description

获取剖面位置

Overrides

RenderableShape.getPosition

---

getProgress

▸ getProgress(): number

Returns

number

Description

获取剖切进度

---

getProperties

▸ getProperties(): PropertySet

Returns

PropertySet

Description

获取属性管理器

Inherited from

RenderableShape.getProperties

---

getProto

▸ getProto(): Shape

Returns

Shape

Description

获取原型

Inherited from

RenderableShape.getProto

---

getRenderShapes

▸ getRenderShapes(): RenderableShape[]

Returns

RenderableShape[]

Description

获取可绘制对象列表

Inherited from

RenderableShape.getRenderShapes

---

getReverseClip

▸ getReverseClip(): boolean

Returns

boolean

Description

获取是否反向剖切

---

getRotation

▸ getRotation(): Quaternion

Returns

Quaternion

Description

获取旋转四元数

Overrides

RenderableShape.getRotation

---

getScene

▸ getScene(): Scene

Returns

Scene

场景对象

Description

获取场景对象

Inherited from

RenderableShape.getScene

---

getSceneBox

▸ getSceneBox(): BoundingBox

Returns

BoundingBox

Description

获取场景包围盒

---

getSectionBox

▸ getSectionBox(): SectionBox

Returns

SectionBox

Description

获取Box剖切对象

---

getSectionLine

▸ getSectionLine(): FigureSectionLine

Returns

FigureSectionLine

Description

获取轮廓线

---

getSectionLineColor

▸ getSectionLineColor(): Color

Returns

Color

Description

获取剖切轮廓线颜色

---

getSectionLineInfo

▸ getSectionLineInfo(): Map<string, number>

Returns

Map<string, number>

Description

获取剖切轮廓线数据信息

---

getSelectedModelList

▸ getSelectedModelList(): Shape[]

Returns

Shape[]

Description

获取指定剖切的模型集

---

getSelectedModelPath

▸ getSelectedModelPath(): any

Returns

any

Description

获取指定剖模型路径

---

getShaderProgramName

▸ getShaderProgramName(): string

Returns

string

Description

获取渲染用program名字

Inherited from

RenderableShape.getShaderProgramName

---

getShapeType

▸ getShapeType(): ShapeType

Returns

ShapeType

Description

获取Shape类型

Inherited from

RenderableShape.getShapeType

---

getShowCappingPlane

▸ getShowCappingPlane(): boolean

Returns

boolean

Description

获取剖切盖面的显示标示

---

getShowClipPlane

▸ getShowClipPlane(): boolean

Returns

boolean

Description

获取剖切盖面的显示标示

---

getShowCutPlane

▸ getShowCutPlane(): boolean

Returns

boolean

Description

获取是否显示剖切面

---

getShowPlaneRect

▸ getShowPlaneRect(): boolean

Returns

boolean

Description

获取剖切面的辅助面的显示标示

---

getShowSectionLine

▸ getShowSectionLine(): boolean

Returns

boolean

Description

获取是否显示轮廓线

---

getStates

▸ getStates(): ShapeParameter[]

Returns

ShapeParameter[]

Description

获取状态

Inherited from

RenderableShape.getStates

---

getTextureObject

▸ getTextureObject(): ShapeParameter[]

Returns

ShapeParameter[]

Description

获取纹理数据

Inherited from

RenderableShape.getTextureObject

---

getTransformPlaneParam

▸ getTransformPlaneParam(): number[]

Returns

number[]

Description

获取剖切面变换参数

---

getType

▸ getType(): ShapeType

Returns

ShapeType

Description

获取类型

---

getVertexHeader

▸ getVertexHeader(): VertexHeader

Returns

VertexHeader

Description

获取vertexHeader

Overrides

RenderableShape.getVertexHeader

---

getVertexSet

▸ getVertexSet(): VertexSet

Returns

VertexSet

Description

获取vertexSet

Overrides

RenderableShape.getVertexSet

---

getWorldBoundingBox

▸ getWorldBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取世界包围盒

Inherited from

RenderableShape.getWorldBoundingBox

---

getWorldTransform

▸ getWorldTransform(): Matrix4

Returns

Matrix4

Description

获取shape的世界矩阵

Inherited from

RenderableShape.getWorldTransform

---

init

▸ init(): void

Returns

void

Description

初始化剖切面

---

intersect

▸ intersect(ray, intersectPnt): boolean

Parameters

Name	Type
ray	Ray
intersectPnt	Vector3

Returns

boolean

Deprecated

Description

判断剖切面与射线是否相交

---

isNeedUpdate

▸ isNeedUpdate(): boolean

Returns

boolean

Description

获取是否需要更新Buffer数据

Inherited from

RenderableShape.isNeedUpdate

---

isPlaneAvaliable

▸ isPlaneAvaliable(): boolean

Returns

boolean

Description

获取平面是否可用

---

isPreSelected

▸ isPreSelected(): boolean

Returns

boolean

Description

是否预选中

Inherited from

RenderableShape.isPreSelected

---

isSelected

▸ isSelected(): boolean

Returns

boolean

Description

是否被选中

Inherited from

RenderableShape.isSelected

---

isVisible

▸ isVisible(orginVisible?): boolean

Parameters

Name	Type	Description
orginVisible?	boolean	是否获取原始可见性

Returns

boolean

Description

获取可见性

Inherited from

RenderableShape.isVisible

---

markDirty

▸ markDirty(): void

Returns

void

Description

设置脏标记

---

post

▸ post(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

RenderableShape.post

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

RenderableShape.registerEvent

---

removeEffect

▸ removeEffect(effectType): void

Parameters

Name	Type
effectType	EffectType

Returns

void

Description

移除效果

Inherited from

RenderableShape.removeEffect

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

RenderableShape.removeEvent

---

send

▸ send(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

RenderableShape.send

---

sendClipMessage

▸ sendClipMessage(): void

Returns

void

Description

发送剖切更新消息

Inherited from

RenderableShape.sendClipMessage

---

sendEffectMessage

▸ sendEffectMessage(): void

Returns

void

Description

发送特效更新消息

Inherited from

RenderableShape.sendEffectMessage

---

sendUpdateMessage

▸ sendUpdateMessage(): void

Returns

void

Description

发送剖切更新消息

---

setAlpha

▸ setAlpha(alpha): void

Parameters

Name	Type
alpha	number

Returns

void

Description

设置透明度

Inherited from

RenderableShape.setAlpha

---

setBox

▸ setBox(box): void

Parameters

Name	Type
box	BoundingBox

Returns

void

Description

设置包围盒

---

setCappingColor

▸ setCappingColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置剖切盖面颜色

---

setCenterPoint

▸ setCenterPoint(centerPoint): void

Parameters

Name	Type
centerPoint	Vector3

Returns

void

Description

设置中心点

---

setColor

▸ setColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置颜色

Inherited from

RenderableShape.setColor

---

setDraggerTransform

▸ setDraggerTransform(transform): void

Parameters

Name	Type
transform	Matrix3x4

Returns

void

Description

通过矩阵变换剖面的位置

---

setDrawPlane

▸ setDrawPlane(box): any

Parameters

Name	Type
box	BoundingBox

Returns

any

Description

设置绘制平面

▸ setDrawPlane(center, size): any

Parameters

Name	Type
center	Vector3
size	Vector2

Returns

any

Description

设置绘制平面

---

setEdgeColor

▸ setEdgeColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置剖切面边线的颜色

---

setEffect

▸ setEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

设置效果，包括高亮、轮廓等

Inherited from

RenderableShape.setEffect

---

setEnable

▸ setEnable(enable): void

Parameters

Name	Type
enable	boolean

Returns

void

Description

获取是否显示

---

setFaceColor

▸ setFaceColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置剖切面的颜色

---

setFrontShow

▸ setFrontShow(frontShow): void

Parameters

Name	Type
frontShow	boolean

Returns

void

Description

设置是否前端显示

Inherited from

RenderableShape.setFrontShow

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

RenderableShape.setId

---

setIsSectionBox

▸ setIsSectionBox(value): void

Parameters

Name	Type
value	boolean

Returns

void

Description

设置是否为Box剖切

---

setName

▸ setName(name): void

Parameters

Name	Type
name	string

Returns

void

Description

设置剖切面名称

Overrides

RenderableShape.setName

---

setNeedClip

▸ setNeedClip(isClip): void

Parameters

Name	Type
isClip	boolean

Returns

void

Description

设置是否需要剖切

Inherited from

RenderableShape.setNeedClip

---

setNeedUpdate

▸ setNeedUpdate(update): void

Parameters

Name	Type
update	boolean

Returns

void

Description

设置是否需要更新Buffer数据

Inherited from

RenderableShape.setNeedUpdate

---

setNorPos

▸ setNorPos(pos): void

Parameters

Name	Type
pos	Vector3

Returns

void

Description

设置剖切面法向

---

setObjectId

▸ setObjectId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

设置ObjectId

Inherited from

RenderableShape.setObjectId

---

setOriPos

▸ setOriPos(pos): void

Parameters

Name	Type
pos	Vector3

Returns

void

Description

设置剖切面原始位置

---

setOriShowCappingPlane

▸ setOriShowCappingPlane(flag): void

Parameters

Name	Type
flag	boolean

Returns

void

Description

设置剖切盖面的初始显示标示

---

setOriShowClipPlane

▸ setOriShowClipPlane(flag): void

Parameters

Name	Type
flag	boolean

Returns

void

Description

设置剖切盖面的初始显示标示

---

setPlaneParam

▸ setPlaneParam(a, b, c, d): void

Parameters

Name	Type
a	number
b	number
c	number
d	number

Returns

void

Description

设置平面参数

---

setPosition

▸ setPosition(position): void

Parameters

Name	Type
position	Vector3

Returns

void

Description

设置剖面位置

Overrides

RenderableShape.setPosition

---

setProgress

▸ setProgress(value): void

Parameters

Name	Type
value	number

Returns

void

Description

设置剖切进度

---

setReverseClip

▸ setReverseClip(flag): void

Parameters

Name	Type
flag	boolean

Returns

void

Description

设置是否反向剖切

---

setScene

▸ setScene(scene): void

Parameters

Name	Type
scene	Scene

Returns

void

Description

设置场景

Overrides

RenderableShape.setScene

---

setSceneBox

▸ setSceneBox(box): void

Parameters

Name	Type
box	BoundingBox

Returns

void

Description

设置场景包围盒

---

setSectionBox

▸ setSectionBox(value): void

Parameters

Name	Type
value	SectionBox

Returns

void

Description

设置Box剖切对象

---

setSectionLineColor

▸ setSectionLineColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置剖切轮廓线颜色

---

setSelected

▸ setSelected(selected): void

Parameters

Name	Type
selected	boolean

Returns

void

Description

设置是否被选中

Inherited from

RenderableShape.setSelected

---

setSelectedModelList

▸ setSelectedModelList(modelList): void

Parameters

Name	Type
modelList	Shape[]

Returns

void

Description

设置指定剖切模型集合

---

setSelectedModelPath

▸ setSelectedModelPath(selectedModelPath): void

Parameters

Name	Type
selectedModelPath	any

Returns

void

Description

设置指定剖模型路径

---

setShaderProgramName

▸ setShaderProgramName(name): void

Parameters

Name	Type
name	string

Returns

void

Description

设置渲染用program名字

Inherited from

RenderableShape.setShaderProgramName

---

setShapeType

▸ setShapeType(v): void

Parameters

Name	Type	Description
v	ShapeType	类型

Returns

void

Description

设置类型

Inherited from

RenderableShape.setShapeType

---

setShowCappingPlane

▸ setShowCappingPlane(flag): void

Parameters

Name	Type
flag	boolean

Returns

void

Description

设置剖切盖面显示标示

---

setShowClipPlane

▸ setShowClipPlane(flag): void

Parameters

Name	Type
flag	boolean

Returns

void

Description

设置剖切盖面的显示标示

---

setShowCutPlane

▸ setShowCutPlane(flag): void

Parameters

Name	Type
flag	boolean

Returns

void

Description

设置是否显示剖切面

---

setShowPlaneRect

▸ setShowPlaneRect(flag): void

Parameters

Name	Type
flag	boolean

Returns

void

Description

设置剖切面的辅助面显示标示

---

setShowSectionLine

▸ setShowSectionLine(isShow): void

Parameters

Name	Type
isShow	boolean

Returns

void

Description

设置是否显示轮廓线

---

setTransform

▸ setTransform(position, rotation): any

Parameters

Name	Type
position	Vector3
rotation	Quaternion

Returns

any

Description

设置变换参数

▸ setTransform(position, rotation, scale): any

Parameters

Name	Type
position	Vector3
rotation	Quaternion
scale	number

Returns

any

Description

设置变换参数

▸ setTransform(position, rotation, scale): any

Parameters

Name	Type
position	Vector3
rotation	Quaternion
scale	Vector3

Returns

any

Description

设置变换参数

▸ setTransform(transform): any

Parameters

Name	Type
transform	Matrix3x4

Returns

any

Description

设置变换参数

---

setVisible

▸ setVisible(visible, originVisible?): void

Parameters

Name	Type	Description
visible	boolean	是否可见 boolean类型
originVisible?	boolean	-

Returns

void

Description

设置是否可见

Inherited from

RenderableShape.setVisible

---

setWorldTransform

▸ setWorldTransform(matrix): void

Parameters

Name	Type
matrix	Matrix4

Returns

void

Description

设置世界矩阵

Inherited from

RenderableShape.setWorldTransform

---

update

▸ update(msg): void

Parameters

Name	Type	Description
msg	M3DMessage	消息信息

Returns

void

Description

更新消息

Implementation of

Subscriber.update

Overrides

RenderableShape.update

---

updateDrawData

▸ updateDrawData(): void

Returns

void

Description

更新绘制数据