M3D / M3D / Shapes / Face

Class: Face

M3D.Shapes.Face

Memberof

M3D.Shapes

Description

面对象

Author

YW

Date

2022-1-12

Version

1.0

Copyright

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

Hierarchy

• RenderableShape

  ↳ Face

Table of contents

Constructors

• constructor

Properties

• id
• count
• isProto
• pVertexHeader

Accessors

• isProto

Methods

• addEffect
• computeBox
• getAlpha
• getBody
• getBoundingBox
• getColor
• getDrawables
• getEffect
• getEvents
• getFaceId
• getGeometryFeature
• getId
• getIndexLength
• getIndexOffset
• getIsFrontShow
• getLODData
• getLocalTransform
• getMaterial
• getMaterialId
• getModel
• getName
• getNeedClip
• getObjectId
• getParameters
• getPosition
• getProperties
• getProto
• getRenderColor
• getRenderMaterial
• getRenderShapes
• getRotation
• getScene
• getShaderProgramName
• getShapeType
• getStates
• getTextureObject
• getVertexHeader
• getVertexSet
• getVolumeAndArea
• getWorldBoundingBox
• getWorldTransform
• isNeedUpdate
• isPreSelected
• isSelected
• isVisible
• post
• registerEvent
• removeEffect
• removeEvent
• send
• sendClipMessage
• sendEffectMessage
• setAlpha
• setBody
• setColor
• setEffect
• setFaceId
• setFrontShow
• setGeometryFeature
• setId
• setIndexLength
• setIndexOffset
• setLODData
• setMaterial
• setMaterialId
• setModel
• setName
• setNeedClip
• setNeedUpdate
• setObjectId
• setPosition
• setProto
• setRenderMaterial
• setScene
• setSelected
• setShaderProgramName
• setShapeType
• setVertexHeader
• setVisible
• setWorldTransform
• update
• updateRenderMaterial

Constructors

constructor

• new Face(): Face

Returns

Face

Description

构造函数

Overrides

RenderableShape.constructor

• new Face(proto): Face

Parameters

Name	Type
proto	Face

Returns

Face

Description

构造函数

Overrides

RenderableShape.constructor

• new Face(indexOffset, indexLength): Face

Parameters

Name	Type	Description
indexOffset	number	有效数据偏移量
indexLength	number	有效数据偏长度

Returns

Face

Description

构造函数

Overrides

RenderableShape.constructor

• new Face(indexOffset, indexLength, lodData): Face

Parameters

Name	Type	Description
indexOffset	number	有效数据偏移量
indexLength	number	有效数据偏长度
lodData	LODData	原型对象

Returns

Face

Description

构造函数

Overrides

RenderableShape.constructor

Properties

id

• id: number

Inherited from

RenderableShape.id

---

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

---

computeBox

▸ computeBox(): void

Returns

void

Description

计算面的包围盒

---

getAlpha

▸ getAlpha(): number

Returns

number

Description

获取透明度

Inherited from

RenderableShape.getAlpha

---

getBody

▸ getBody(): Body

Returns

Body

Description

设置Body

---

getBoundingBox

▸ getBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取包围盒

Overrides

RenderableShape.getBoundingBox

---

getColor

▸ getColor(): Color

Returns

Color

Description

获取材质颜色

Overrides

RenderableShape.getColor

---

getDrawables

▸ getDrawables(): void

Returns

void

Description

获取渲染数据

Inherited from

RenderableShape.getDrawables

---

getEffect

▸ getEffect(): number

Returns

number

Description

获取效果

Inherited from

RenderableShape.getEffect

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

RenderableShape.getEvents

---

getFaceId

▸ getFaceId(): number

Returns

number

Description

获取面的id

---

getGeometryFeature

▸ getGeometryFeature(): GeometryFeature

Returns

GeometryFeature

Description

获取面的几何特征

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

RenderableShape.getId

---

getIndexLength

▸ getIndexLength(): number

Returns

number

Description

获取有效数据长度

---

getIndexOffset

▸ getIndexOffset(): number

Returns

number

Description

获取有效数据偏移量

---

getIsFrontShow

▸ getIsFrontShow(): boolean

Returns

boolean

Description

获取是否前端显示

Inherited from

RenderableShape.getIsFrontShow

---

getLODData

▸ getLODData(): LODData

Returns

LODData

Description

获取面所在的LODData

---

getLocalTransform

▸ getLocalTransform(): Matrix4

Returns

Matrix4

Description

获取shape的局部矩阵

Inherited from

RenderableShape.getLocalTransform

---

getMaterial

▸ getMaterial(): BaseMaterial

Returns

BaseMaterial

Description

获取材质

---

getMaterialId

▸ getMaterialId(): number

Returns

number

Description

获取材质id

---

getModel

▸ getModel(): Model

Returns

Model

Description

获取面所在模型

---

getName

▸ getName(): string

Returns

string

Description

获取实例名称

Inherited from

RenderableShape.getName

---

getNeedClip

▸ getNeedClip(): boolean

Returns

boolean

Description

获取是否需要剖切

Inherited from

RenderableShape.getNeedClip

---

getObjectId

▸ getObjectId(): number

Returns

number

Description

获取ObjectId

Inherited from

RenderableShape.getObjectId

---

getParameters

▸ getParameters(): ShapeParameter[]

Returns

ShapeParameter[]

Description

获取渲染参数

Inherited from

RenderableShape.getParameters

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Description

获取位置

Inherited from

RenderableShape.getPosition

---

getProperties

▸ getProperties(): PropertySet

Returns

PropertySet

Description

获取属性管理器

Inherited from

RenderableShape.getProperties

---

getProto

▸ getProto(): Face

Returns

Face

Description

获取原型

Overrides

RenderableShape.getProto

---

getRenderColor

▸ getRenderColor(): Color

Returns

Color

Description

获取渲染材质颜色

---

getRenderMaterial

▸ getRenderMaterial(): BaseMaterial

Returns

BaseMaterial

当前材质

Description

获取当前材质

---

getRenderShapes

▸ getRenderShapes(): RenderableShape[]

Returns

RenderableShape[]

Description

获取可绘制对象列表

Inherited from

RenderableShape.getRenderShapes

---

getRotation

▸ getRotation(): Quaternion

Returns

Quaternion

Description

获取空间旋转信息

Inherited from

RenderableShape.getRotation

---

getScene

▸ getScene(): Scene

Returns

Scene

场景对象

Description

获取场景对象

Inherited from

RenderableShape.getScene

---

getShaderProgramName

▸ getShaderProgramName(): string

Returns

string

Description

获取渲染用program名字

Inherited from

RenderableShape.getShaderProgramName

---

getShapeType

▸ getShapeType(): ShapeType

Returns

ShapeType

Description

获取Shape类型

Inherited from

RenderableShape.getShapeType

---

getStates

▸ getStates(): ShapeParameter[]

Returns

ShapeParameter[]

Description

获取状态

Inherited from

RenderableShape.getStates

---

getTextureObject

▸ getTextureObject(): ShapeParameter[]

Returns

ShapeParameter[]

Description

获取纹理数据

Inherited from

RenderableShape.getTextureObject

---

getVertexHeader

▸ getVertexHeader(): VertexHeader

Returns

VertexHeader

Description

获取VertexHeader

Overrides

RenderableShape.getVertexHeader

---

getVertexSet

▸ getVertexSet(): VertexSet

Returns

VertexSet

Description

获取vertexSet

Inherited from

RenderableShape.getVertexSet

---

getVolumeAndArea

▸ getVolumeAndArea(): number[]

Returns

number[]

Description

获取体积和面积

---

getWorldBoundingBox

▸ getWorldBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取世界包围盒

Inherited from

RenderableShape.getWorldBoundingBox

---

getWorldTransform

▸ getWorldTransform(): Matrix4

Returns

Matrix4

Description

获取shape的世界矩阵

Inherited from

RenderableShape.getWorldTransform

---

isNeedUpdate

▸ isNeedUpdate(): boolean

Returns

boolean

Description

获取是否需要更新Buffer数据

Inherited from

RenderableShape.isNeedUpdate

---

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

---

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

---

setAlpha

▸ setAlpha(alpha): void

Parameters

Name	Type
alpha	number

Returns

void

Description

设置透明度

Inherited from

RenderableShape.setAlpha

---

setBody

▸ setBody(body): void

Parameters

Name	Type
body	Body

Returns

void

Description

获取所属的Body

---

setColor

▸ setColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置材质颜色

Overrides

RenderableShape.setColor

---

setEffect

▸ setEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

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

Inherited from

RenderableShape.setEffect

---

setFaceId

▸ setFaceId(faceId): void

Parameters

Name	Type
faceId	number

Returns

void

Description

设置面的id

---

setFrontShow

▸ setFrontShow(frontShow): void

Parameters

Name	Type
frontShow	boolean

Returns

void

Description

设置是否前端显示

Inherited from

RenderableShape.setFrontShow

---

setGeometryFeature

▸ setGeometryFeature(gf): void

Parameters

Name	Type
gf	GeometryFeature

Returns

void

Description

设置几何特征

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

RenderableShape.setId

---

setIndexLength

▸ setIndexLength(indexLength): void

Parameters

Name	Type
indexLength	number

Returns

void

Description

设置有效数据长度

---

setIndexOffset

▸ setIndexOffset(indexOffset): void

Parameters

Name	Type
indexOffset	number

Returns

void

Description

设置有效数据偏移量

---

setLODData

▸ setLODData(lodData): void

Parameters

Name	Type
lodData	LODData

Returns

void

Description

设置面所在LODData

---

setMaterial

▸ setMaterial(material): void

Parameters

Name	Type
material	BaseMaterial

Returns

void

Description

设置原始材质

---

setMaterialId

▸ setMaterialId(materialId): void

Parameters

Name	Type	Description
materialId	number	材质id

Returns

void

Description

设置材质id

---

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

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

---

setObjectId

▸ setObjectId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

设置ObjectId

Inherited from

RenderableShape.setObjectId

---

setPosition

▸ setPosition(postion): void

Parameters

Name	Type	Description
postion	Vector3	位置

Returns

void

Description

设置位置

Inherited from

RenderableShape.setPosition

---

setProto

▸ setProto(fp): void

Parameters

Name	Type
fp	Face

Returns

void

Description

设置原型

---

setRenderMaterial

▸ setRenderMaterial(material): void

Parameters

Name	Type
material	BaseMaterial

Returns

void

Description

设置当前材质

---

setScene

▸ setScene(scene): void

Parameters

Name	Type	Description
scene	Scene	场景对象

Returns

void

Description

设置场景对象

Inherited from

RenderableShape.setScene

---

setSelected

▸ setSelected(selected): void

Parameters

Name	Type
selected	boolean

Returns

void

Description

设置是否被选中

Inherited from

RenderableShape.setSelected

---

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

---

setVertexHeader

▸ setVertexHeader(vertexHeader): void

Parameters

Name	Type
vertexHeader	VertexHeader

Returns

void

Description

设置VertexHeader

---

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
msg	M3DMessage

Returns

void

Description

消息接收者必须实现方法

Inherited from

RenderableShape.update

---

updateRenderMaterial

▸ updateRenderMaterial(): void

Returns

void

Description

更新面材质