Api - exporter Module

Index

Classes

Interfaces

Variables

Functions

Variables

Private chainLinkToPathDataMap

chainLinkToPathDataMap: IChainLinkToPathDataMap

Private dxfUnit

dxfUnit: object

Type declaration

[unitType: string]: number

Private svgPathDataMap

svgPathDataMap: ISvgPathDataMap

svgUnit

svgUnit: svgUnitConversion

Map of MakerJs unit system to SVG unit system

Functions

chainToSVGPathData

chainToSVGPathData(chain: IChain, offset: IPoint): string

- Defined in core/svg.ts:56
Convert a chain to SVG path data.

Parameters
- chain: IChain
- offset: IPoint
Returns string

exportFromOptionsMap

exportFromOptionsMap(modelToExport: IModel, optionsMap: IOpenJsCadOptionsMap): string

- Defined in core/openjscad.ts:196
Parameters
- modelToExport: IModel
- optionsMap: IOpenJsCadOptionsMap
Returns string

Private facetSizeToResolution

facetSizeToResolution(arcOrCircle: IPathCircle, facetSize: number): number

- Defined in core/openjscad.ts:31
Parameters
- arcOrCircle: IPathCircle
- facetSize: number
Returns number

Private getBezierModelsWithPaths

getBezierModelsWithPaths(modelToExport: IModel): IWalkModel[]

- Defined in core/svg.ts:166
Parameters
- modelToExport: IModel
Returns IWalkModel[]

Private getPathDataByLayer

getPathDataByLayer(modelToExport: IModel, offset: IPoint, options: IFindChainsOptions): IPathDataMap

- Defined in core/svg.ts:204
Parameters
- modelToExport: IModel
- offset: IPoint
- options: IFindChainsOptions
Returns IPathDataMap

pathToSVGPathData

pathToSVGPathData(pathToExport: IPath, offset: IPoint, offset2: IPoint): string

- Defined in core/svg.ts:148
Convert a path to SVG path data.

Parameters
- pathToExport: IPath
- offset: IPoint
- offset2: IPoint
Returns string

Private pathsToOpenJsCad

pathsToOpenJsCad(modelContext: IModel, facetSize?: number): string

- Defined in core/openjscad.ts:45
Parameters
- modelContext: IModel
- Optional facetSize: number
Returns string

Private startSvgPathData

startSvgPathData(start: IPoint, d: ISvgPathData): ISvgPathData

- Defined in core/svg.ts:93
Parameters
- start: IPoint
- d: ISvgPathData
Returns ISvgPathData

Private svgArcData

svgArcData(d: ISvgPathData, radius: number, endPoint: IPoint, largeArc?: boolean, decreasing?: boolean): void

- Defined in core/svg.ts:607
Parameters
- d: ISvgPathData
- radius: number
- endPoint: IPoint
- Optional largeArc: boolean
- Optional decreasing: boolean
Returns void

Private svgBezierData

svgBezierData(d: ISvgPathData, seed: IPathBezierSeed, reversed?: boolean): void

- Defined in core/svg.ts:593
Parameters
- d: ISvgPathData
- seed: IPathBezierSeed
- Optional reversed: boolean
Returns void

Private svgCircleData

svgCircleData(radius: number): ISvgPathData

- Defined in core/svg.ts:573
Parameters
- radius: number
Returns ISvgPathData

Private svgCoords

svgCoords(p: IPoint): IPoint

- Defined in core/svg.ts:49
Parameters
- p: IPoint
Returns IPoint

toDXF

toDXF(modelToExport: IModel, options?: IDXFRenderOptions): string
toDXF(pathsToExport: IPath[], options?: IDXFRenderOptions): string
toDXF(pathToExport: IPath, options?: IDXFRenderOptions): string

- Defined in core/dxf.ts:3
Renders an item in AutoDesk DFX file format.

Parameters
- modelToExport: IModel
- Optional options: IDXFRenderOptions
  
  Rendering options object.
Returns string

String of DXF content.
- Defined in core/dxf.ts:4
Renders an item in AutoDesk DFX file format.

Parameters
- pathsToExport: IPath[]
- Optional options: IDXFRenderOptions
  
  Rendering options object.
Returns string

String of DXF content.
- Defined in core/dxf.ts:5
Renders an item in AutoDesk DFX file format.

Parameters
- pathToExport: IPath
- Optional options: IDXFRenderOptions
  
  Rendering options object.
Returns string

String of DXF content.

toOpenJsCad

toOpenJsCad(modelToExport: IModel, options?: IOpenJsCadOptions): string
toOpenJsCad(pathsToExport: IPath[], options?: IOpenJsCadOptions): string
toOpenJsCad(pathToExport: IPath, options?: IOpenJsCadOptions): string

- Defined in core/openjscad.ts:132
Creates a string of JavaScript code for execution with the OpenJsCad engine.

Parameters
- modelToExport: IModel
  
  Model object to export.
- Optional options: IOpenJsCadOptions
  
  Export options object.
Returns string

String of JavaScript containing a main() function for OpenJsCad.
- Defined in core/openjscad.ts:133
Creates a string of JavaScript code for execution with the OpenJsCad engine.

Parameters
- pathsToExport: IPath[]
- Optional options: IOpenJsCadOptions
  
  Export options object.
Returns string

String of JavaScript containing a main() function for OpenJsCad.
- Defined in core/openjscad.ts:134
Creates a string of JavaScript code for execution with the OpenJsCad engine.

Parameters
- pathToExport: IPath
- Optional options: IOpenJsCadOptions
  
  Export options object.
Returns string

String of JavaScript containing a main() function for OpenJsCad.

toPDF

toPDF(doc: PDFDocument, modelToExport: IModel, options?: IPDFRenderOptions): void

- Defined in core/pdf.ts:10
Injects drawing into a PDFKit document.

Parameters
- doc: PDFDocument
- modelToExport: IModel
  
  Model object to export.
- Optional options: IPDFRenderOptions
  
  Export options object.
Returns void

String of PDF file contents.

toSTL

toSTL(modelToExport: IModel, options?: IOpenJsCadOptions): string

- Defined in core/openjscad.ts:234
Executes a JavaScript string with the OpenJsCad engine - converts 2D to 3D.

Parameters
- modelToExport: IModel
  
  Model object to export.
- Default value options: IOpenJsCadOptions = {}
  
  Export options object.
Returns string

String of STL format of 3D object.

toSVG

toSVG(modelToExport: IModel, options?: ISVGRenderOptions): string
toSVG(pathsToExport: IPath[], options?: ISVGRenderOptions): string
toSVG(pathToExport: IPath, options?: ISVGRenderOptions): string

- Defined in core/svg.ts:268
Renders an item in SVG markup.

Parameters
- modelToExport: IModel
- Optional options: ISVGRenderOptions
  
  Rendering options object.
Returns string

String of XML / SVG content.
- Defined in core/svg.ts:269
Renders an item in SVG markup.

Parameters
- pathsToExport: IPath[]
- Optional options: ISVGRenderOptions
  
  Rendering options object.
Returns string

String of XML / SVG content.
- Defined in core/svg.ts:270
Renders an item in SVG markup.

Parameters
- pathToExport: IPath
- Optional options: ISVGRenderOptions
  
  Rendering options object.
Returns string

String of XML / SVG content.

Private tryGetModelUnits

tryGetModelUnits(itemToExport: any): string

- Defined in core/exporter.ts:17
Try to get the unit system from a model

Parameters
- itemToExport: any
Returns string

Private wrap

wrap(prefix: string, content: string, condition: any): string

- Defined in core/openjscad.ts:20
Parameters
- prefix: string
- content: string
- condition: any
Returns string

Generated using TypeDoc

Api - exporter Module

Index

Classes

Interfaces

Variables

Functions

Variables

Private chainLinkToPathDataMap

Private dxfUnit

Type declaration

[unitType: string]: number

Private svgPathDataMap

svgUnit

Functions

chainToSVGPathData

Parameters

chain: IChain

offset: IPoint

Returns string

exportFromOptionsMap

Parameters

modelToExport: IModel

optionsMap: IOpenJsCadOptionsMap

Returns string

Private facetSizeToResolution

Parameters

arcOrCircle: IPathCircle

facetSize: number

Returns number

Private getBezierModelsWithPaths

Parameters

modelToExport: IModel

Returns IWalkModel[]

Private getPathDataByLayer

Parameters

modelToExport: IModel

offset: IPoint

options: IFindChainsOptions

Returns IPathDataMap

pathToSVGPathData

Parameters

pathToExport: IPath

offset: IPoint

offset2: IPoint

Returns string

Private pathsToOpenJsCad

Parameters

modelContext: IModel

Optional facetSize: number

Returns string

Private startSvgPathData

Parameters

start: IPoint

d: ISvgPathData

Returns ISvgPathData

Private svgArcData

Parameters

d: ISvgPathData

radius: number

endPoint: IPoint

Optional largeArc: boolean

Optional decreasing: boolean

Returns void

Private svgBezierData

Parameters

d: ISvgPathData

seed: IPathBezierSeed

Optional reversed: boolean

Returns void

Private svgCircleData

Parameters

radius: number

Returns ISvgPathData

Private svgCoords

Parameters

p: IPoint

Returns IPoint

toDXF

Parameters

modelToExport: IModel