Class SVGRenderer

constructor

• new SVGRenderer(
      vOptions?: ViewmapOptions,
      sOptions?: SVGDrawOptions,
  ): SVGRenderer

• Parameters

  • OptionalvOptions: ViewmapOptions
  • OptionalsOptions: SVGDrawOptions

  Returns SVGRenderer

ReadonlydrawHandler

Readonlyviewmap

addPass

• addPass(pass: DrawPass): void

• Adds a pass to the SVG rendering pipeline.

  Parameters

  • pass: DrawPass

  Returns void

clearPasses

• clearPasses(): void

• Removes all the passes from the SVG rendering pipeline.

  Returns void

generateSVG

• generateSVG(
      meshes: SVGMesh[],
      camera: PerspectiveCamera,
      size: { h: number; w: number },
      info?: SVGRenderInfo,
  ): Promise<Svg>

• Render a SVG file from the given meshes and returns it.

  Parameters

  • meshes: SVGMesh[]

    Mehses to render
  • camera: PerspectiveCamera

    Camera used to compute the perspective
  • size: { h: number; w: number }

    Size of the render (will be scaled by camera aspect ratio)
  • info: SVGRenderInfo = ...

    Object containing info (e.g. times) on the rendering process

  Returns Promise<Svg>

  SVG object from the Svgdotjs lib

removePass

• removePass(pass: DrawPass): void

• Removes a pass from the SVG rendering pipeline

  Parameters

  • pass: DrawPass

  Returns void