@indoor-map/fmap-js • Docs
特效管理类 提供各类场景特效的创建与管理
Constructors
new FMapEffect()
new FMapEffect(
fmap):FMapEffect
Parameters
• fmap: FMap
Returns
Methods
addBloom()
addBloom(
options?):FMBloom
添加发光效果(Bloom)
Parameters
• options?: Record<string, unknown>
发光参数
Returns
FMBloom
发光效果实例
addDiffusion()
addDiffusion(
target,options?):FMDiffusion
添加扩散效果
Parameters
• target: unknown
目标标注（FMSphereMarker）
• options?: Record<string, unknown>
扩散参数
Returns
FMDiffusion
扩散实例
addFire()
addFire(
options):FMFireMarker
添加火焰效果
Parameters
• options: Record<string, unknown> & object
火焰配置
Returns
FMFireMarker
火焰实例
addFlow()
addFlow(
target,options?):FMFlow
添加流光效果
Parameters
• target: unknown
目标标注（FMLine3dMarker/FMWallMarker/FMTubeMarker）
• options?: Record<string, unknown>
流光参数
Returns
FMFlow
流光实例
addFog()
addFog(
options?):FMFog
添加雾气效果
Parameters
• options?: Record<string, unknown>
雾气参数
Returns
FMFog
雾气实例
addOutline()
addOutline(
options?):FMOutline
添加高亮轮廓线
Parameters
• options?
轮廓线配置
• options.color?: string
• options.opacity?: number
• options.thickness?: number
Returns
FMOutline
轮廓线实例
addParticle()
addParticle(
options):FMParticle
添加粒子效果
Parameters
• options
粒子配置
• options.color?: string
• options.count?: number
• options.level?: number
• options.size?: number
• options.type?: string
• options.x?: number
• options.y?: number
• options.z?: number
Returns
FMParticle
粒子实例
addSAO()
addSAO(
options?):FMSAO
添加SAO效果
Parameters
• options?: Record<string, unknown>
SAO参数
Returns
FMSAO
SAO实例
addSkybox()
addSkybox(
options):FMSky
添加天空盒效果
Parameters
• options: Record<string, unknown>
天空盒参数
Returns
FMSky
天空盒实例
addSweep()
addSweep(
type,options?):FMSweep
添加扫光效果
Parameters
• type: "circle" | "annulus" = 'circle'
扫光类型: 'circle' | 'annulus'
• options?: Record<string, unknown>
扫光参数
Returns
FMSweep
扫光实例
addWater()
addWater(
options):FMWater
添加水波纹效果
Parameters
• options
水波纹配置
• options.color?: string
• options.count?: number
• options.height?: number
• options.level?: number
• options.opacity?: number
• options.radius?: number
• options.url?: string
• options.x: number
• options.y: number
Returns
FMWater
水波纹实例
clearAll()
clearAll():
void
清除所有特效（单个特效清理失败不影响其余特效）
Returns
void