M3D / M3D / Shapes / Body

Class: Body

M3D.Shapes.Body

Memberof

M3D.Shapes

Description

Body

Date

2022-7-26

Version

1.0

Copyright

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

Hierarchy

• Shape

  ↳ Body

Table of contents

Constructors

• constructor

Properties

• faceArray
• id
• count
• isProto
• pVertexHeader

Accessors

• isProto

Methods

• addEdge
• addEffect
• addFace
• clearEdge
• computeBoundingBox
• getAlpha
• getBoundingBox
• getColor
• getDrawables
• getEdges
• getEffect
• getEvents
• getFaceCount
• getFaces
• getId
• getIsFrontShow
• getLocalTransform
• getMaterial
• getModel
• getName
• getNeedClip
• getObjectId
• getPolyLine
• getPosition
• getProperties
• getProto
• getRenderShapes
• getRotation
• getScene
• getShapeType
• getVertexCount
• getVertexSet
• getWorldBoundingBox
• getWorldTransform
• isPreSelected
• isRegenDrawData
• isSelected
• isVisible
• markRegenDrawDataState
• post
• registerEvent
• removeEffect
• removeEvent
• send
• sendClipMessage
• sendEffectMessage
• setAlpha
• setBoundingBox
• setColor
• setEffect
• setFrontShow
• setId
• setModel
• setName
• setNeedClip
• setObjectId
• setPolyLine
• setPosition
• setProto
• setScene
• setSelected
• setShapeType
• setVertexSet
• setVisible
• setWorldTransform
• update
• clone

Constructors

constructor

• new Body(): Body

Returns

Body

Description

构造函数

Overrides

Shape.constructor

• new Body(proto): Body

Parameters

Name	Type
proto	Body

Returns

Body

Description

构造函数

Overrides

Shape.constructor

Properties

faceArray

• faceArray: Face[]

---

id

• id: number

Inherited from

Shape.id

---

count

▪ Static count: number

Inherited from

Shape.count

---

isProto

▪ Static isProto: string

Inherited from

Shape.isProto

---

pVertexHeader

▪ Static pVertexHeader: string

Inherited from

Shape.pVertexHeader

Accessors

isProto

• get isProto(): boolean

Returns

boolean

Description

获取是否为原型对象

Inherited from

Shape.isProto

• set isProto(v): void

Parameters

Name	Type
v	boolean

Returns

void

Description

设置是否为原型对象

Inherited from

Shape.isProto

Methods

addEdge

▸ addEdge(edge): void

Parameters

Name	Type
edge	Edge

Returns

void

Description

新增一个Edge对象

---

addEffect

▸ addEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

添加特效效果

Inherited from

Shape.addEffect

---

addFace

▸ addFace(face): void

Parameters

Name	Type
face	Face

Returns

void

Description

新增一个Face对象

---

clearEdge

▸ clearEdge(): void

Returns

void

Description

清理边界线

---

computeBoundingBox

▸ computeBoundingBox(): void

Returns

void

Description

计算包围盒

---

getAlpha

▸ getAlpha(): number

Returns

number

Description

获取透明度

Inherited from

Shape.getAlpha

---

getBoundingBox

▸ getBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取包围盒

Overrides

Shape.getBoundingBox

---

getColor

▸ getColor(): Color

Returns

Color

Description

获取颜色

Overrides

Shape.getColor

---

getDrawables

▸ getDrawables(): void

Returns

void

Description

获取渲染数据

Inherited from

Shape.getDrawables

---

getEdges

▸ getEdges(): Edge[]

Returns

Edge[]

Description

获取body下的所有Edge

---

getEffect

▸ getEffect(): number

Returns

number

Description

获取效果

Inherited from

Shape.getEffect

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

Shape.getEvents

---

getFaceCount

▸ getFaceCount(): number

Returns

number

Description

统计body下所有面的总数

---

getFaces

▸ getFaces(): Face[]

Returns

Face[]

Description

获取body下的所有Face

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

Shape.getId

---

getIsFrontShow

▸ getIsFrontShow(): boolean

Returns

boolean

Description

获取是否前端显示

Inherited from

Shape.getIsFrontShow

---

getLocalTransform

▸ getLocalTransform(): Matrix4

Returns

Matrix4

Description

获取shape的局部矩阵

Inherited from

Shape.getLocalTransform

---

getMaterial

▸ getMaterial(): BaseMaterial

Returns

BaseMaterial

Description

获取Body的材质（获取body下第一个面的材质）

---

getModel

▸ getModel(): Model

Returns

Model

Description

获取对应的模型

---

getName

▸ getName(): string

Returns

string

Description

获取实例名称

Inherited from

Shape.getName

---

getNeedClip

▸ getNeedClip(): boolean

Returns

boolean

Description

获取是否需要剖切

Inherited from

Shape.getNeedClip

---

getObjectId

▸ getObjectId(): number

Returns

number

Description

获取ObjectId

Inherited from

Shape.getObjectId

---

getPolyLine

▸ getPolyLine(): PolyLine

Returns

PolyLine

Description

获取用来存储edge折线数据的polyLine

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Description

获取位置

Inherited from

Shape.getPosition

---

getProperties

▸ getProperties(): PropertySet

Returns

PropertySet

Description

获取属性管理器

Inherited from

Shape.getProperties

---

getProto

▸ getProto(): Body

Returns

Body

Description

获取原型

Overrides

Shape.getProto

---

getRenderShapes

▸ getRenderShapes(): RenderableShape[]

Returns

RenderableShape[]

Description

获取所有可绘制Shape对象（待完善）

Overrides

Shape.getRenderShapes

---

getRotation

▸ getRotation(): Quaternion

Returns

Quaternion

Description

获取空间旋转信息

Inherited from

Shape.getRotation

---

getScene

▸ getScene(): Scene

Returns

Scene

Description

获取Body所在的场景

Overrides

Shape.getScene

---

getShapeType

▸ getShapeType(): ShapeType

Returns

ShapeType

Description

获取Shape类型

Inherited from

Shape.getShapeType

---

getVertexCount

▸ getVertexCount(): number

Returns

number

Description

统计body下所有顶点的总个数

---

getVertexSet

▸ getVertexSet(): VertexSet

Returns

VertexSet

Description

获取顶点数据

---

getWorldBoundingBox

▸ getWorldBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取世界包围盒

Inherited from

Shape.getWorldBoundingBox

---

getWorldTransform

▸ getWorldTransform(): Matrix4

Returns

Matrix4

Description

获取shape的世界矩阵

Inherited from

Shape.getWorldTransform

---

isPreSelected

▸ isPreSelected(): boolean

Returns

boolean

Description

是否预选中

Inherited from

Shape.isPreSelected

---

isRegenDrawData

▸ isRegenDrawData(): boolean

Returns

boolean

Description

获取Body是否重新生成DrawableData标识

---

isSelected

▸ isSelected(): boolean

Returns

boolean

Description

是否被选中

Inherited from

Shape.isSelected

---

isVisible

▸ isVisible(orginVisible?): boolean

Parameters

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

Returns

boolean

Description

获取可见性

Overrides

Shape.isVisible

---

markRegenDrawDataState

▸ markRegenDrawDataState(state): void

Parameters

Name	Type
state	boolean

Returns

void

Description

标记DrawableData状态

---

post

▸ post(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

Shape.post

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

Shape.registerEvent

---

removeEffect

▸ removeEffect(effectType): void

Parameters

Name	Type
effectType	EffectType

Returns

void

Description

移除效果

Inherited from

Shape.removeEffect

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

Shape.removeEvent

---

send

▸ send(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

Shape.send

---

sendClipMessage

▸ sendClipMessage(): void

Returns

void

Description

发送剖切更新消息

Inherited from

Shape.sendClipMessage

---

sendEffectMessage

▸ sendEffectMessage(): void

Returns

void

Description

发送特效更新消息

Overrides

Shape.sendEffectMessage

---

setAlpha

▸ setAlpha(alpha): void

Parameters

Name	Type
alpha	number

Returns

void

Description

设置透明度

Inherited from

Shape.setAlpha

---

setBoundingBox

▸ setBoundingBox(boundingBox): void

Parameters

Name	Type
boundingBox	BoundingBox

Returns

void

Description

设置包围盒

---

setColor

▸ setColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置颜色

Overrides

Shape.setColor

---

setEffect

▸ setEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

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

Inherited from

Shape.setEffect

---

setFrontShow

▸ setFrontShow(frontShow): void

Parameters

Name	Type
frontShow	boolean

Returns

void

Description

设置是否前端显示

Inherited from

Shape.setFrontShow

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

Shape.setId

---

setModel

▸ setModel(model): void

Parameters

Name	Type
model	Model

Returns

void

Description

设置对应的模型

---

setName

▸ setName(name): void

Parameters

Name	Type	Description
name	string	名称

Returns

void

Description

设置实例名称

Inherited from

Shape.setName

---

setNeedClip

▸ setNeedClip(isClip): void

Parameters

Name	Type
isClip	boolean

Returns

void

Description

设置是否需要剖切

Inherited from

Shape.setNeedClip

---

setObjectId

▸ setObjectId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

设置ObjectId

Inherited from

Shape.setObjectId

---

setPolyLine

▸ setPolyLine(polyLine): void

Parameters

Name	Type
polyLine	PolyLine

Returns

void

Description

设置用来存储edge折线数据的polyLine

---

setPosition

▸ setPosition(postion): void

Parameters

Name	Type	Description
postion	Vector3	位置

Returns

void

Description

设置位置

Inherited from

Shape.setPosition

---

setProto

▸ setProto(body): void

Parameters

Name	Type
body	Body

Returns

void

Description

设置原型

---

setScene

▸ setScene(scene): void

Parameters

Name	Type	Description
scene	Scene	场景对象

Returns

void

Description

设置场景对象

Inherited from

Shape.setScene

---

setSelected

▸ setSelected(selected): void

Parameters

Name	Type
selected	boolean

Returns

void

Description

设置是否被选中

Inherited from

Shape.setSelected

---

setShapeType

▸ setShapeType(v): void

Parameters

Name	Type	Description
v	ShapeType	类型

Returns

void

Description

设置类型

Inherited from

Shape.setShapeType

---

setVertexSet

▸ setVertexSet(vertexSet): void

Parameters

Name	Type
vertexSet	VertexSet

Returns

void

Description

设置Body的VertexSet数据

---

setVisible

▸ setVisible(visible, originVisible?): void

Parameters

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

Returns

void

Description

设置是否可见

Overrides

Shape.setVisible

---

setWorldTransform

▸ setWorldTransform(matrix): void

Parameters

Name	Type
matrix	Matrix4

Returns

void

Description

设置世界矩阵

Inherited from

Shape.setWorldTransform

---

update

▸ update(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息接收者必须实现方法

Inherited from

Shape.update

---

clone

▸ clone(body, model): Body

Parameters

Name	Type
body	Body
model	Model

Returns

Body

Description

复制Body数据