M3D / M3D / Shapes / BillBoard

Class: BillBoard

M3D.Shapes.BillBoard

Memberof

M3D.Shapes

Description

Billboard

Date

2022-08-17

Version

1.0

Copyright

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

Hierarchy

• Shape

  ↳ BillBoard

Table of contents

Constructors

• constructor

Properties

• id
• count
• isProto
• pVertexHeader

Accessors

• isProto

Methods

• addEffect
• getAlpha
• getBoundingBox
• getCenter
• getColor
• getDrawables
• getEffect
• getEvents
• getId
• getIsFrontShow
• getLocalTransform
• getName
• getNeedClip
• getObjectId
• getPosition
• getProperties
• getProto
• getRenderShapes
• getRotation
• getScene
• getShapeType
• getWorldBoundingBox
• getWorldMatrix
• getWorldTransform
• isAllowRotate
• isAllowScale
• isAllowTran
• isPreSelected
• isSelected
• isVisible
• post
• registerEvent
• removeEffect
• removeEvent
• send
• sendClipMessage
• sendEffectMessage
• setAllowRotate
• setAllowScale
• setAllowTran
• setAlpha
• setCenter
• setColor
• setEffect
• setFrontShow
• setId
• setName
• setNeedClip
• setObjectId
• setPosition
• setScaleLimits
• setScene
• setSelected
• setShapeType
• setVisible
• setWorldTransform
• update
• getFitShowScale

Constructors

constructor

• new BillBoard(): BillBoard

Returns

BillBoard

Description

构造函数

Overrides

Shape.constructor

Properties

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

addEffect

▸ addEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

添加特效效果

Inherited from

Shape.addEffect

---

getAlpha

▸ getAlpha(): number

Returns

number

Description

获取透明度

Inherited from

Shape.getAlpha

---

getBoundingBox

▸ getBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取包围盒

Inherited from

Shape.getBoundingBox

---

getCenter

▸ getCenter(): Vector3

Returns

Vector3

Description

获取中心坐标

---

getColor

▸ getColor(): Color

Returns

Color

Description

获取颜色

Inherited from

Shape.getColor

---

getDrawables

▸ getDrawables(): void

Returns

void

Description

获取渲染数据

Inherited from

Shape.getDrawables

---

getEffect

▸ getEffect(): number

Returns

number

Description

获取效果

Inherited from

Shape.getEffect

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

Shape.getEvents

---

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

---

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

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Description

获取位置

Inherited from

Shape.getPosition

---

getProperties

▸ getProperties(): PropertySet

Returns

PropertySet

Description

获取属性管理器

Inherited from

Shape.getProperties

---

getProto

▸ getProto(): Shape

Returns

Shape

Description

获取原型

Inherited from

Shape.getProto

---

getRenderShapes

▸ getRenderShapes(): RenderableShape[]

Returns

RenderableShape[]

Description

获取可绘制对象列表

Inherited from

Shape.getRenderShapes

---

getRotation

▸ getRotation(): Quaternion

Returns

Quaternion

Description

获取空间旋转信息

Inherited from

Shape.getRotation

---

getScene

▸ getScene(): Scene

Returns

Scene

场景对象

Description

获取场景对象

Inherited from

Shape.getScene

---

getShapeType

▸ getShapeType(): ShapeType

Returns

ShapeType

Description

获取Shape类型

Inherited from

Shape.getShapeType

---

getWorldBoundingBox

▸ getWorldBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取世界包围盒

Inherited from

Shape.getWorldBoundingBox

---

getWorldMatrix

▸ getWorldMatrix(camera, modelViewMatrix, value?): Matrix4

Parameters

Name	Type	Description
camera	Camera
modelViewMatrix	Matrix3x4	外部变换矩阵
value?	boolean	外部变换矩阵是否改变本地矩阵

Returns

Matrix4

Description

获取世界变换矩阵

---

getWorldTransform

▸ getWorldTransform(): Matrix4

Returns

Matrix4

Description

获取shape的世界矩阵

Inherited from

Shape.getWorldTransform

---

isAllowRotate

▸ isAllowRotate(): boolean

Returns

boolean

true允许 false不允许

Description

返回允许旋转状态

---

isAllowScale

▸ isAllowScale(): boolean

Returns

boolean

true允许 false不允许

Description

返回允许缩放状态

---

isAllowTran

▸ isAllowTran(): boolean

Returns

boolean

true允许 false不允许

Description

返回允许平移状态

---

isPreSelected

▸ isPreSelected(): boolean

Returns

boolean

Description

是否预选中

Inherited from

Shape.isPreSelected

---

isSelected

▸ isSelected(): boolean

Returns

boolean

Description

是否被选中

Inherited from

Shape.isSelected

---

isVisible

▸ isVisible(orginVisible?): boolean

Parameters

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

Returns

boolean

Description

获取可见性

Inherited from

Shape.isVisible

---

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

发送特效更新消息

Inherited from

Shape.sendEffectMessage

---

setAllowRotate

▸ setAllowRotate(allow): void

Parameters

Name	Type	Description
allow	boolean	true允许 false不允许

Returns

void

Description

是否允许旋转

---

setAllowScale

▸ setAllowScale(allow): void

Parameters

Name	Type	Description
allow	boolean	true允许 false不允许

Returns

void

Description

是否允许缩放

---

setAllowTran

▸ setAllowTran(allow): void

Parameters

Name	Type	Description
allow	boolean	true允许 false不允许

Returns

void

Description

是否允许平移

---

setAlpha

▸ setAlpha(alpha): void

Parameters

Name	Type
alpha	number

Returns

void

Description

设置透明度

Inherited from

Shape.setAlpha

---

setCenter

▸ setCenter(center): void

Parameters

Name	Type
center	Vector3

Returns

void

Description

设置中心

---

setColor

▸ setColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置颜色

Inherited from

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

---

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

---

setPosition

▸ setPosition(postion): void

Parameters

Name	Type	Description
postion	Vector3	位置

Returns

void

Description

设置位置

Inherited from

Shape.setPosition

---

setScaleLimits

▸ setScaleLimits(min, max): void

Parameters

Name	Type
min	number
max	number

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

---

setVisible

▸ setVisible(visible, originVisible?): void

Parameters

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

Returns

void

Description

设置是否可见

Inherited from

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

---

getFitShowScale

▸ getFitShowScale(camera, position): number

Parameters

Name	Type
camera	Camera
position	Vector3

Returns

number

Description

获取合适的缩放比例