M3D / M3D / Shapes / ShapeHelper

Class: ShapeHelper

M3D.Shapes.ShapeHelper

Memberof

M3D.Shapes

Description

图形帮助类

Table of contents

Constructors

• constructor

Properties

• boundingBox
• children
• color
• edgeLength
• edgeOffset
• faceLength
• faceOffset
• geometryFeature
• material
• needAddModels
• needRemoveModels
• originalMaterial
• originalPlcMatrix
• originalVisible
• parent
• plcId
• plcMatrix
• plcPath
• protoId
• shapeName
• size
• totalBoundingBox
• visible
• worldBoundingBox
• worldMatrix
• worldTotalBoundingBox

Methods

• addModelList
• addModelToScene
• addModelToShapes
• addModelToVisibles
• addPMIToScene
• addRemoveList
• compareModel
• copyAllData
• copyModelEdges
• copyModelRenderData
• getEdgePoints
• getFaceType
• getFitShowScale
• getLineType
• getModelWorldBoundingBox
• getReaderByModel
• getShapeParameter
• getShapeWorldTransform
• getSubModelByInstanceId
• getSubModelByProtoId
• getTopModelByModel
• isCorrelationModelView
• removeModelFromShapes
• removeModelFromVisibles
• replaceModel
• replaceModelAndCopy
• rotateModel
• scaleAssemblyModel
• scaleModel
• transform
• translateModel

Constructors

constructor

• new ShapeHelper(): ShapeHelper

Returns

ShapeHelper

Properties

boundingBox

▪ Static boundingBox: string

---

children

▪ Static children: string

---

color

▪ Static color: string

---

edgeLength

▪ Static edgeLength: string

---

edgeOffset

▪ Static edgeOffset: string

---

faceLength

▪ Static faceLength: string

---

faceOffset

▪ Static faceOffset: string

---

geometryFeature

▪ Static geometryFeature: string

---

material

▪ Static material: string

---

needAddModels

▪ Static needAddModels: Model[]

---

needRemoveModels

▪ Static needRemoveModels: Model[]

---

originalMaterial

▪ Static originalMaterial: string

---

originalPlcMatrix

▪ Static originalPlcMatrix: string

---

originalVisible

▪ Static originalVisible: string

---

parent

▪ Static parent: string

---

plcId

▪ Static plcId: string

---

plcMatrix

▪ Static plcMatrix: string

---

plcPath

▪ Static plcPath: string

---

protoId

▪ Static protoId: string

---

shapeName

▪ Static shapeName: string

---

size

▪ Static size: string

---

totalBoundingBox

▪ Static totalBoundingBox: string

---

visible

▪ Static visible: string

---

worldBoundingBox

▪ Static worldBoundingBox: string

---

worldMatrix

▪ Static worldMatrix: string

---

worldTotalBoundingBox

▪ Static worldTotalBoundingBox: string

Methods

addModelList

▸ addModelList(shape, scene, relSub?): void

Parameters

Name	Type
shape	Model
scene	Scene
relSub?	boolean

Returns

void

---

addModelToScene

▸ addModelToScene(scene): void

Parameters

Name	Type
scene	Scene

Returns

void

---

addModelToShapes

▸ addModelToShapes(shape, scene, relSub?): void

Parameters

Name	Type	Description
shape	Model	model
scene	Scene	场景对象
relSub?	boolean	是否添加子级

Returns

void

Description

往场景的Shapes中添加Model

---

addModelToVisibles

▸ addModelToVisibles(shape, scene, relSub?): void

Parameters

Name	Type	Description
shape	Model	Model对象
scene	Scene	场景对象
relSub?	boolean	是否添加子级

Returns

void

Description

往场景的Visibles里添加Model

---

addPMIToScene

▸ addPMIToScene(scene, pmiMap): void

Parameters

Name	Type
scene	Scene
pmiMap	Map<number, PMI>

Returns

void

---

addRemoveList

▸ addRemoveList(shape, scene, relSub?): void

Parameters

Name	Type
shape	Model
scene	Scene
relSub?	boolean

Returns

void

---

compareModel

▸ compareModel(model, compareModel, isAdd?): void

Parameters

Name	Type	Description
model	Model	shape 模型
compareModel	Model	被比较的模型
isAdd?	boolean	为true时，找不到对应件设置为添加状态；为false时，找不到对应件设置为删除状态

Returns

void

Description

进行模型BOM结构比较

---

copyAllData

▸ copyAllData(sourModel, origModel, withRenderData?): void

Parameters

Name	Type	Description
sourModel	Model	结果模型
origModel	Model	被拷贝的模型
withRenderData?	boolean	-

Returns

void

Description

拷贝model数据

---

copyModelEdges

▸ copyModelEdges(targetModel, resourceModel, withSub): void

Parameters

Name	Type	Description
targetModel	Model	结果模型
resourceModel	Model	被拷贝的模型
withSub	any	-

Returns

void

Description

拷贝模型的边界线数据（edge）

---

copyModelRenderData

▸ copyModelRenderData(targetModel, resourceModel, withSub): void

Parameters

Name	Type	Description
targetModel	Model	结果模型
resourceModel	Model	被拷贝的模型
withSub	any	-

Returns

void

Description

拷贝模型的渲染数据（body/face/edge）

---

getEdgePoints

▸ getEdgePoints(edge): Vector3[]

Parameters

Name	Type
edge	Edge

Returns

Vector3[]

Description

获取边界线的点

---

getFaceType

▸ getFaceType(face): GeoFeatureEnum

Parameters

Name	Type
face	Face

Returns

GeoFeatureEnum

Description

拟合face 填充几何属性

---

getFitShowScale

▸ getFitShowScale(camera, position): number

Parameters

Name	Type
camera	Camera
position	Vector3

Returns

number

Description

计算缩放比例

---

getLineType

▸ getLineType(edge): GeoFeatureEnum

Parameters

Name	Type
edge	Edge

Returns

GeoFeatureEnum

Description

拟合edge 填充几何属性

---

getModelWorldBoundingBox

▸ getModelWorldBoundingBox(model): BoundingBox

Parameters

Name	Type
model	Model

Returns

BoundingBox

Description

获取包围盒

---

getReaderByModel

▸ getReaderByModel(scene, model): Reader

Parameters

Name	Type
scene	Scene
model	Model

Returns

Reader

Description

通过模型获取Reader

---

getShapeParameter

▸ getShapeParameter(name, dataType, value): ShapeParameter

Parameters

Name	Type
name	string
dataType	ParameterType
value	any

Returns

ShapeParameter

Description

根据参数创建shapeParameter

---

getShapeWorldTransform

▸ getShapeWorldTransform(shape): any

Parameters

Name	Type
shape	Model

Returns

any

Description

获取模型对象世界变换矩阵

▸ getShapeWorldTransform(shape): any

Parameters

Name	Type
shape	Face

Returns

any

Description

获取面对象世界变换矩阵

▸ getShapeWorldTransform(shape): any

Parameters

Name	Type
shape	Edge

Returns

any

Description

获取边界线对象世界变换矩阵

---

getSubModelByInstanceId

▸ getSubModelByInstanceId(model, instanceId, relSub?): Model[]

Parameters

Name	Type	Description
model	Model	Model对象
instanceId	number	实例id
relSub?	boolean	是否继续往下查找

Returns

Model[]

Description

根据实例id获取模型下所有的Model对象

---

getSubModelByProtoId

▸ getSubModelByProtoId(model, protoId, relSub?, docId?): Model[]

Parameters

Name	Type	Description
model	Model	Model对象
protoId	number	原型id
relSub?	boolean	是否继续往下查找
docId?	any	-

Returns

Model[]

Description

根据原型id获取模型下所有的实例Model

---

getTopModelByModel

▸ getTopModelByModel(scene, model): Model

Parameters

Name	Type
scene	Scene
model	Model

Returns

Model

Description

获取model对应的topModel

---

isCorrelationModelView

▸ isCorrelationModelView(shape, scene): boolean

Parameters

Name	Type	Description
shape	Shape	shape
scene	Scene	场景对象

Returns

boolean

Description

判断shape是否与视图关联

---

removeModelFromShapes

▸ removeModelFromShapes(shape, scene, relSub?): void

Parameters

Name	Type	Description
shape	Model	Model对象
scene	Scene	场景对象
relSub?	boolean	是否移除子级

Returns

void

Description

从场景的Shapes中移除Model

---

removeModelFromVisibles

▸ removeModelFromVisibles(shape, scene, relSub?): void

Parameters

Name	Type	Description
shape	Model	Model对象
scene	Scene	场景对象
relSub?	boolean	是否移除子级

Returns

void

Description

从场景的Visibles里移除Model

---

replaceModel

▸ replaceModel(targetModel, resourceModel, asmModel, scene): Model

Parameters

Name	Type	Description
targetModel	Model	被替换的模型
resourceModel	Model	替换的模型
asmModel	Model	被替换的模型的父级
scene	Scene	场景对象

Returns

Model

Description

替换模型

---

replaceModelAndCopy

▸ replaceModelAndCopy(targetModel, resourceModel, asmModel, scene, withRenderData?): Model

Parameters

Name	Type	Description
targetModel	Model	被替换的model
resourceModel	Model	需要拷贝的model
asmModel	Model	模型的父级节点
scene	Scene	场景对象
withRenderData?	boolean	-

Returns

Model

Description

copy并且替换模型

---

rotateModel

▸ rotateModel(model, quat): void

Parameters

Name	Type
model	Model
quat	Quaternion

Returns

void

Description

模型旋转

---

scaleAssemblyModel

▸ scaleAssemblyModel(model, scale, plcMat): boolean

Parameters

Name	Type	Description
model	Model	要缩放的模型
scale	Vector3	缩放量
plcMat	Matrix3x4	out 模型配置矩阵

Returns

boolean

Description

缩放装配模型

---

scaleModel

▸ scaleModel(model, scale): void

Parameters

Name	Type
model	Model
scale	Vector3

Returns

void

Description

缩放模型

---

transform

▸ transform(attribute, matrix): boolean

Parameters

Name	Type	Description
attribute	GeometryFeature	待变换的几何属性
matrix	Matrix3x4	变换矩阵

Returns

boolean

true成功 false失败

Description

几何属性变换

---

translateModel

▸ translateModel(model, move): void

Parameters

Name	Type
model	Model
move	Vector3

Returns

void

Description

模型平移