Class RichSurface

constructor

• new RichSurface(): RichSurface

• Returns RichSurface

_actorId

Optional _options

maxVisibleValue

• get maxVisibleValue(): number

• 获取当前最大可视距离，单位 cm

  Returns number
• set maxVisibleValue(val): void

• 设置最大可视距离，单位 cm

  Parameters

  • val: number

  Returns void

minVisibleValue

• get minVisibleValue(): number

• 获取当前最小可视距离，单位 cm

  Returns number
• set minVisibleValue(val): void

• 设置最小可视距离，单位 cm

  Parameters

  • val: number

  Returns void

type

• get type(): undefined | XVideoSource | XStaticTextureSource | XTextSource | XSpriteImgSource

• Returns undefined | XVideoSource | XStaticTextureSource | XTextSource | XSpriteImgSource

addMeshAsync

• addMeshAsync(option): Promise<string | XStaticMeshActor<IStaticMeshActorEvents>>

• 添加richsurface模型

  Parameters

  • option: IAddMeshOption

    添加模型时的配置信息

  Returns Promise<string | XStaticMeshActor<IStaticMeshActorEvents>>

  Throws

  模型加载时出现异常\错误

change

• change(media, mediaOptions?): Promise<void>

• 切换richsurface挂载的资源

  Parameters

  • media: string | HTMLVideoElement

    富媒体资源

  • Optional mediaOptions: any

    若不传，则保留之前设置

  Returns Promise<void>

  Deprecated

  已废弃，请使用changeMediaSource

changeMediaSource

• changeMediaSource(mediaData, options?): Promise<void>

• 切换mediaSource和media 如果只传入mediaData则只切换media 传入options则判定类型有无改变，有改变就创建新的mediaSource并设置其media

  Parameters

  • mediaData: string | HTMLVideoElement

    mediaData，IRichsurfaceTextureOption/ISpriteImgOptions对应url， ITextSourceOption对应文本，IVideoOptions对应videoElement

  • Optional options: IChangeOptions

    选项，查看 IChangeOptions 定义

  Returns Promise<void>

create

• create(richSurfaceOptions): Promise<void>

• Parameters

  • richSurfaceOptions: IRichSurfaceOptions

    type richSurface挂载的资源类型,EMediaSourceType枚举类型中共包括XVideoSource,XStaticTextureSource,XTextSource,XSpriteImgSource 4种类型 mediaData richSufrace挂载的富媒体资源 addMeshOption richSufrac模型参数,包含模型url及options详见IAddMeshOption类型 mediaOptions 富媒体资源配置信息,不同资源类型对应不同类型options textCanvasOptions 设置文本canvas,当type为XTextSource时需传入

  Returns Promise<void>

dispose

• dispose(): void

• 释放RichSurface,包括richsuface对象,

  Returns void

generateUuid

• generateUuid(): string

• Returns string

getMediaSource

• getMediaSource(): Nullable<XMediaSource>

• 获取mediaSource

  Returns Nullable<XMediaSource>

getWorld

• getWorld(): World

• Returns World

setMediaSource

• setMediaSource(mediaSource): void

• 设置材质

  Parameters

  • mediaSource: XMediaSource

    可用于richsurface的媒体资源

  Returns void

  Throws

  设置meida资源时可能出错

setUuid

• setUuid(id): void

• Parameters

  • id: string

  Returns void