Class SVGRenderer

constructor

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

• Parameters

  • Optional vOptions: ViewmapOptions

  • Optional sOptions: SVGDrawOptions

  Returns SVGRenderer

Readonly drawHandler

Readonly viewmap

addPass

• addPass(pass): 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, camera, size, info?): 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)

    • h: number

    • w: number

  • info: SVGRenderInfo = ...

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

  Returns Promise<Svg>

  SVG object from the Svgdotjs lib

removePass

• removePass(pass): void

• Removes a pass from the SVG rendering pipeline

  Parameters

  • pass: DrawPass

  Returns void