Class SVGRenderer

Hierarchy

SVGRenderer

Index

Constructors

Properties

drawHandler viewmap

Methods

addPass clearPasses generateSVG removePass exportSVG

Constructors

constructor

new SVGRenderer(vOptions?: ViewmapOptions, sOptions?: SVGDrawOptions): SVGRenderer
Parameters
- Optional vOptions: ViewmapOptions
- Optional sOptions: SVGDrawOptions
Returns SVGRenderer
- Defined in SVGRenderer.ts:48

Properties

`Readonly` drawHandler

drawHandler: SVGDrawHandler

`Readonly` viewmap

viewmap: Viewmap

Methods

addPass

addPass(pass: DrawPass): void
Adds a pass to the SVG rendering pipeline.
Parameters
- pass: DrawPass
Returns void
- Defined in SVGRenderer.ts:94

clearPasses

clearPasses(): void
Removes all the passes from the SVG rendering pipeline.

Returns void
- Defined in SVGRenderer.ts:111

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.

Returns
SVG object from the Svgdotjs lib
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>
- Defined in SVGRenderer.ts:63

removePass

removePass(pass: DrawPass): void
Removes a pass from the SVG rendering pipeline
Parameters
- pass: DrawPass
Returns void
- Defined in SVGRenderer.ts:104

`Static` exportSVG

exportSVG(svg: Svg, filename: string, options?: ExportOptions): void
Parameters
- svg: Svg
- filename: string
- Optional options: ExportOptions
Returns void
- Defined in SVGRenderer.ts:116

Generated using TypeDoc