M3D / M3D / Render / Effects

Class: Effects

M3D.Render.Effects

Memberof

M3D.Render

Description

效果管理类

Author

ZYC

Date

2023-1-05

Version

1.0

Copyright

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

Table of contents

Constructors

• constructor

Methods

• addEffect
• clear
• getEffectMap
• getEffectsByShapeType
• getOrCreateEffect
• getTransparentEffect
• removeEffect
• removeEffectByType
• setColorEffectTransparent
• setEffectMap
• updateEffect
• updateOpacity

Constructors

constructor

• new Effects(): Effects

Returns

Effects

Description

构造函数

Methods

addEffect

▸ addEffect(shape, effect): void

Parameters

Name	Type	Description
shape	Shape	Shape对象
effect	Effect | Effect[]	效果

Returns

void

Description

添加效果

---

clear

▸ clear(): void

Returns

void

Description

效果管理数据清空

---

getEffectMap

▸ getEffectMap(shape): Map<EffectType, Effect[]>

Parameters

Name	Type	Description
shape	Shape	Shape对象

Returns

Map<EffectType, Effect[]>

特效列表

Description

获取特效列表

---

getEffectsByShapeType

▸ getEffectsByShapeType(shape, effectType, selectorType, viewport, isAdd?): void

Parameters

Name	Type	Description
shape	Shape	Shape对象
effectType	number	效果类型
selectorType	SelectorType	选中类型（选中/预选）
viewport	Viewport	视口
isAdd?	boolean	添加/移除效果，true添加 false移除

Returns

void

Description

根据shape类型获取对应效果

---

getOrCreateEffect

▸ getOrCreateEffect(effectType, selectorType, viewport): Effect

Parameters

Name	Type	Description
effectType	EffectType	效果类型
selectorType	SelectorType	选中类型（选中/预选）
viewport	Viewport	视口

Returns

Effect

效果

Description

获取或生成默认效果

---

getTransparentEffect

▸ getTransparentEffect(viewport): TransparentEffect

Parameters

Name	Type	Description
viewport	Viewport	视口

Returns

TransparentEffect

半透明效果

Description

获取半透明效果

---

removeEffect

▸ removeEffect(shape, effect): void

Parameters

Name	Type	Description
shape	Shape	Shape对象
effect	Effect | Effect[]	特定效果

Returns

void

Description

移除某些特定效果

---

removeEffectByType

▸ removeEffectByType(shape, effectType): void

Parameters

Name	Type	Description
shape	Shape	Shape对象
effectType	EffectType | EffectType[]	效果类型

Returns

void

Description

移除某类效果

---

setColorEffectTransparent

▸ setColorEffectTransparent(transparent, viewport): void

Parameters

Name	Type	Description
transparent	number	透明度
viewport	Viewport	视口

Returns

void

Description

设置颜色效果透明度

---

setEffectMap

▸ setEffectMap(shape, effectMap): void

Parameters

Name	Type	Description
shape	Shape	Shape对象
effectMap	Map<EffectType, Effect[]>	效果Map

Returns

void

Description

设置特效

---

updateEffect

▸ updateEffect(configName, viewport): void

Parameters

Name	Type	Description
configName	string	配置项名称
viewport	Viewport	视口

Returns

void

Description

配置项更新后，已有特效参数更新

---

updateOpacity

▸ updateOpacity(opacity, viewport): void

Parameters

Name	Type	Description
opacity	number	透明度
viewport	Viewport	视口

Returns

void

Description

配置项更新后，已有透明度参数更新