M3D / M3D / Shapes / Texts2D

Class: Texts2D

M3D.Shapes.Texts2D

Memberof

M3D.Shapes

Description

2D文本

Date

2022-1-12

Version

1.0

Copyright

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

Hierarchy

• Shape2D

  ↳ Texts2D

Table of contents

Constructors

• constructor

Properties

• id
• count
• isProto
• pVertexHeader

Accessors

• isProto

Methods

• addEffect
• addShape
• getAlpha
• getBackground
• getBoundingBox
• getColor
• getDrawables
• getEffect
• getEvents
• getFont
• getFontColor
• getFontName
• getId
• getIsFrontShow
• getLocalTransform
• getName
• getNeedClip
• getObjectId
• getPosition
• getProperties
• getProto
• getRenderShapes
• getRotation
• getScene
• getShapeType
• getShapes
• getSize
• getStart
• getTexts
• getWorldBoundingBox
• getWorldTransform
• isAlignCenter
• isPreSelected
• isSelected
• isVisible
• post
• registerEvent
• removeEffect
• removeEvent
• send
• sendClipMessage
• sendEffectMessage
• setAlignCenter
• setAlpha
• setBackground
• setColor
• setEffect
• setFont
• setFontColor
• setFontName
• setFrontShow
• setId
• setName
• setNeedClip
• setObjectId
• setPosition
• setScene
• setSelected
• setShapeType
• setShapes
• setSize
• setStart
• setTexts
• setVisible
• setWorldTransform
• toString
• update

Constructors

constructor

• new Texts2D(): Texts2D

Returns

Texts2D

Description

构造函数

Inherited from

Shape2D.constructor

Properties

id

• id: number

Inherited from

Shape2D.id

---

count

▪ Static count: number

Inherited from

Shape2D.count

---

isProto

▪ Static isProto: string

Inherited from

Shape2D.isProto

---

pVertexHeader

▪ Static pVertexHeader: string

Inherited from

Shape2D.pVertexHeader

Accessors

isProto

• get isProto(): boolean

Returns

boolean

Description

获取是否为原型对象

Inherited from

Shape2D.isProto

• set isProto(v): void

Parameters

Name	Type
v	boolean

Returns

void

Description

设置是否为原型对象

Inherited from

Shape2D.isProto

Methods

addEffect

▸ addEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

添加特效效果

Inherited from

Shape2D.addEffect

---

addShape

▸ addShape(shape2d): boolean

Parameters

Name	Type
shape2d	Shape2D

Returns

boolean

Description

添加可见对象

Inherited from

Shape2D.addShape

---

getAlpha

▸ getAlpha(): number

Returns

number

Description

获取透明度

Inherited from

Shape2D.getAlpha

---

getBackground

▸ getBackground(): Color

Returns

Color

颜色

Description

获取背景颜色

---

getBoundingBox

▸ getBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取包围盒

Inherited from

Shape2D.getBoundingBox

---

getColor

▸ getColor(): Color

Returns

Color

颜色

Description

获取颜色

Inherited from

Shape2D.getColor

---

getDrawables

▸ getDrawables(): void

Returns

void

Description

获取渲染数据

Inherited from

Shape2D.getDrawables

---

getEffect

▸ getEffect(): number

Returns

number

Description

获取效果

Inherited from

Shape2D.getEffect

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

Shape2D.getEvents

---

getFont

▸ getFont(): Font

Returns

Font

Description

获取字体对象

---

getFontColor

▸ getFontColor(): Color

Returns

Color

Description

获取文本颜色

---

getFontName

▸ getFontName(): string

Returns

string

Description

获取字体

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

Shape2D.getId

---

getIsFrontShow

▸ getIsFrontShow(): boolean

Returns

boolean

Description

获取是否前端显示

Inherited from

Shape2D.getIsFrontShow

---

getLocalTransform

▸ getLocalTransform(): Matrix4

Returns

Matrix4

Description

获取shape的局部矩阵

Inherited from

Shape2D.getLocalTransform

---

getName

▸ getName(): string

Returns

string

Description

获取实例名称

Inherited from

Shape2D.getName

---

getNeedClip

▸ getNeedClip(): boolean

Returns

boolean

Description

获取是否需要剖切

Inherited from

Shape2D.getNeedClip

---

getObjectId

▸ getObjectId(): number

Returns

number

Description

获取ObjectId

Inherited from

Shape2D.getObjectId

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Description

获取位置

Inherited from

Shape2D.getPosition

---

getProperties

▸ getProperties(): PropertySet

Returns

PropertySet

Description

获取属性管理器

Inherited from

Shape2D.getProperties

---

getProto

▸ getProto(): Shape

Returns

Shape

Description

获取原型

Inherited from

Shape2D.getProto

---

getRenderShapes

▸ getRenderShapes(): RenderableShape[]

Returns

RenderableShape[]

Description

获取可绘制对象列表

Inherited from

Shape2D.getRenderShapes

---

getRotation

▸ getRotation(): Quaternion

Returns

Quaternion

Description

获取空间旋转信息

Inherited from

Shape2D.getRotation

---

getScene

▸ getScene(): Scene

Returns

Scene

场景对象

Description

获取场景对象

Inherited from

Shape2D.getScene

---

getShapeType

▸ getShapeType(): ShapeType

Returns

ShapeType

Description

获取Shape类型

Inherited from

Shape2D.getShapeType

---

getShapes

▸ getShapes(): Shape2D[]

Returns

Shape2D[]

Description

获取所有对象

Inherited from

Shape2D.getShapes

---

getSize

▸ getSize(): number

Returns

number

Description

获取尺寸

---

getStart

▸ getStart(): Vector2

Returns

Vector2

Description

获取起始点

---

getTexts

▸ getTexts(): string

Returns

string

Description

获取文本内容

---

getWorldBoundingBox

▸ getWorldBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取世界包围盒

Inherited from

Shape2D.getWorldBoundingBox

---

getWorldTransform

▸ getWorldTransform(): Matrix4

Returns

Matrix4

Description

获取shape的世界矩阵

Inherited from

Shape2D.getWorldTransform

---

isAlignCenter

▸ isAlignCenter(): boolean

Returns

boolean

Description

获取是否居中显示

---

isPreSelected

▸ isPreSelected(): boolean

Returns

boolean

Description

是否预选中

Inherited from

Shape2D.isPreSelected

---

isSelected

▸ isSelected(): boolean

Returns

boolean

Description

是否被选中

Inherited from

Shape2D.isSelected

---

isVisible

▸ isVisible(orginVisible?): boolean

Parameters

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

Returns

boolean

Description

获取可见性

Inherited from

Shape2D.isVisible

---

post

▸ post(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

Shape2D.post

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

Shape2D.registerEvent

---

removeEffect

▸ removeEffect(effectType): void

Parameters

Name	Type
effectType	EffectType

Returns

void

Description

移除效果

Inherited from

Shape2D.removeEffect

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

Shape2D.removeEvent

---

send

▸ send(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

Shape2D.send

---

sendClipMessage

▸ sendClipMessage(): void

Returns

void

Description

发送剖切更新消息

Inherited from

Shape2D.sendClipMessage

---

sendEffectMessage

▸ sendEffectMessage(): void

Returns

void

Description

发送特效更新消息

Inherited from

Shape2D.sendEffectMessage

---

setAlignCenter

▸ setAlignCenter(alignCenter): void

Parameters

Name	Type
alignCenter	boolean

Returns

void

Description

设置是否居中显示

---

setAlpha

▸ setAlpha(alpha): void

Parameters

Name	Type
alpha	number

Returns

void

Description

设置透明度

Inherited from

Shape2D.setAlpha

---

setBackground

▸ setBackground(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置背景颜色

---

setColor

▸ setColor(color): void

Parameters

Name	Type	Description
color	Color	颜色

Returns

void

Description

设置颜色

Inherited from

Shape2D.setColor

---

setEffect

▸ setEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

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

Inherited from

Shape2D.setEffect

---

setFont

▸ setFont(font): void

Parameters

Name	Type
font	Font

Returns

void

Description

设置字体对象

---

setFontColor

▸ setFontColor(color): void

Parameters

Name	Type	Description
color	Color	颜色

Returns

void

Description

设置文本颜色

---

setFontName

▸ setFontName(fontName): void

Parameters

Name	Type
fontName	string

Returns

void

Description

设置字体

---

setFrontShow

▸ setFrontShow(frontShow): void

Parameters

Name	Type
frontShow	boolean

Returns

void

Description

设置是否前端显示

Inherited from

Shape2D.setFrontShow

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

Shape2D.setId

---

setName

▸ setName(name): void

Parameters

Name	Type	Description
name	string	名称

Returns

void

Description

设置实例名称

Inherited from

Shape2D.setName

---

setNeedClip

▸ setNeedClip(isClip): void

Parameters

Name	Type
isClip	boolean

Returns

void

Description

设置是否需要剖切

Inherited from

Shape2D.setNeedClip

---

setObjectId

▸ setObjectId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

设置ObjectId

Inherited from

Shape2D.setObjectId

---

setPosition

▸ setPosition(postion): void

Parameters

Name	Type	Description
postion	Vector3	位置

Returns

void

Description

设置位置

Inherited from

Shape2D.setPosition

---

setScene

▸ setScene(scene): void

Parameters

Name	Type	Description
scene	Scene	场景对象

Returns

void

Description

设置场景对象

Inherited from

Shape2D.setScene

---

setSelected

▸ setSelected(selected): void

Parameters

Name	Type
selected	boolean

Returns

void

Description

设置是否被选中

Inherited from

Shape2D.setSelected

---

setShapeType

▸ setShapeType(v): void

Parameters

Name	Type	Description
v	ShapeType	类型

Returns

void

Description

设置类型

Inherited from

Shape2D.setShapeType

---

setShapes

▸ setShapes(shape2ds): void

Parameters

Name	Type
shape2ds	Shape2D[]

Returns

void

Description

设置可见对象

Inherited from

Shape2D.setShapes

---

setSize

▸ setSize(size): void

Parameters

Name	Type
size	number

Returns

void

Description

设置尺寸

---

setStart

▸ setStart(start): void

Parameters

Name	Type
start	Vector2

Returns

void

Description

设置起始点

---

setTexts

▸ setTexts(texts): void

Parameters

Name	Type
texts	string

Returns

void

Description

设置文本内容

---

setVisible

▸ setVisible(visible, originVisible?): void

Parameters

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

Returns

void

Description

设置是否可见

Inherited from

Shape2D.setVisible

---

setWorldTransform

▸ setWorldTransform(matrix): void

Parameters

Name	Type
matrix	Matrix4

Returns

void

Description

设置世界矩阵

Inherited from

Shape2D.setWorldTransform

---

toString

▸ toString(): any

Returns

any

Deprecated

---

update

▸ update(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息接收者必须实现方法

Inherited from

Shape2D.update