M3D / M3D / Render / OutlineEffect

Class: OutlineEffect

M3D.Render.OutlineEffect

Memberof

M3D.Render

Description

轮廓效果

Author

ZYC

Date

2023-1-05

Version

1.0

Copyright

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

Hierarchy

• Effect

  ↳ OutlineEffect

Table of contents

Constructors

• constructor

Properties

• id
• count

Methods

• getEdgeEffect
• getEffectType
• getEvents
• getId
• getLineColor
• getLineWidth
• getRenderContext
• registerEvent
• removeEvent
• setEdgeEffect
• setEffectType
• setId
• setLineColor
• setLineWidth
• setRenderContext

Constructors

constructor

• new OutlineEffect(): OutlineEffect

Returns

OutlineEffect

Description

构造函数

Overrides

Effect.constructor

• new OutlineEffect(width): OutlineEffect

Parameters

Name	Type	Description
width	number	轮廓宽度

Returns

OutlineEffect

Description

构造函数

Overrides

Effect.constructor

• new OutlineEffect(color): OutlineEffect

Parameters

Name	Type	Description
color	Color	轮廓颜色

Returns

OutlineEffect

Description

构造函数

Overrides

Effect.constructor

• new OutlineEffect(width, color): OutlineEffect

Parameters

Name	Type	Description
width	number	轮廓宽度
color	Color	轮廓颜色

Returns

OutlineEffect

Description

构造函数

Overrides

Effect.constructor

Properties

id

• id: number

Inherited from

Effect.id

---

count

▪ Static count: number

Inherited from

Effect.count

Methods

getEdgeEffect

▸ getEdgeEffect(): ColorEffect

Returns

ColorEffect

边界线颜色效果

Description

获取边界线效果

---

getEffectType

▸ getEffectType(): EffectType

Returns

EffectType

特效类型

Description

获取特效类型

Inherited from

Effect.getEffectType

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

Effect.getEvents

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

Effect.getId

---

getLineColor

▸ getLineColor(): Color

Returns

Color

轮廓线颜色

Description

获取轮廓线颜色

---

getLineWidth

▸ getLineWidth(): number

Returns

number

轮廓线宽

Description

获取轮廓线宽

---

getRenderContext

▸ getRenderContext(): RenderContext

Returns

RenderContext

渲染上下文

Description

获取渲染上下文

Inherited from

Effect.getRenderContext

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

Effect.registerEvent

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

Effect.removeEvent

---

setEdgeEffect

▸ setEdgeEffect(effect): void

Parameters

Name	Type	Description
effect	ColorEffect	边界线效果

Returns

void

Description

设置边界线效果

---

setEffectType

▸ setEffectType(effectType): void

Parameters

Name	Type	Description
effectType	EffectType	特效类型

Returns

void

Description

设置特效类型

Inherited from

Effect.setEffectType

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

Effect.setId

---

setLineColor

▸ setLineColor(color): void

Parameters

Name	Type	Description
color	Color	轮廓线颜色

Returns

void

Description

设置轮廓线颜色

---

setLineWidth

▸ setLineWidth(width): void

Parameters

Name	Type	Description
width	number	轮廓线宽

Returns

void

Description

设置轮廓线宽

---

setRenderContext

▸ setRenderContext(v): void

Parameters

Name	Type	Description
v	RenderContext	渲染上下文

Returns

void

Description

设置GL

Inherited from

Effect.setRenderContext