Maker.js

https://maker.js.org/docs
Admin
Maker.js is a JavaScript library for creating and sharing modular line drawings, primarily designed...
Tokens:105,384
Snippets:636
Trust Score:8.1
Update:10 months ago
Show doc for...
Tokens:
Raw
### Maker.js Namespace Initialization

Source: https://maker.js.org/docs/api

This example shows how to get a reference to the Maker.js library using require.

```APIDOC
## Maker.js Namespace Initialization

### Description
Root module for Maker.js. Example: get a reference to Maker.js

### Code Example
```javascript
var makerjs = require('makerjs');
```
```

--------------------------------

### Install Maker.js for Node.js via npm

Source: https://maker.js.org/docs/getting-started

This command installs the Maker.js library as a project dependency for Node.js applications using npm. The `--save` flag ensures it's added to your `package.json` file.

```bash
npm install makerjs --save
```

--------------------------------

### startAt

Source: https://maker.js.org/docs/api/modules/makerjs.chain

Sets the starting point of an endless chain to a specified path's routeKey. It returns the modified IChain for cascading.

```APIDOC
## POST /api/chain/startAt

### Description
Sets the starting point of an endless chain to a specified path's routeKey. It returns the modified IChain for cascading.

### Method
POST

### Endpoint
/api/chain/startAt

### Parameters
#### Request Body
- **chainContext** (IChain) - Required - The chain to set the start point for. Must be endless.
- **routeKey** (string) - Required - The routeKey of the path to start the chain with.

### Response
#### Success Response (200)
- **IChain** (object) - The chainContext for cascading.
```

--------------------------------

### Include Maker.js for Browser via CDN

Source: https://maker.js.org/docs/getting-started

This snippet demonstrates including Maker.js and its optional dependencies (Bezier.js, Opentype.js) for browser use via Content Delivery Network (CDN) links. This is a convenient way to add the library without hosting it locally.

```html
<script src="https://cdn.jsdelivr.net/npm/makerjs@0/target/js/browser.maker.js"></script>
<script src="https://cdn.jsdelivr.net/npm/bezier-js@2/bezier.js"></script>
<script src="https://cdn.jsdelivr.net/npm/opentype.js@0/dist/opentype.js"></script>
```

--------------------------------

### Path API - Zero

Source: https://maker.js.org/docs/api/modules/makerjs.path

Moves a path so that its bounding box starts at the origin [0, 0].

```APIDOC
## GET /websites/maker_js/path/zero

### Description
Moves a path so that its bounding box starts at the origin [0, 0].

### Method
GET

### Endpoint
/websites/maker_js/path/zero

### Parameters
#### Query Parameters
- **pathToZero** (IPath) - Required - The path to zero.

### Response
#### Success Response (200)
- **IPath** - The original path (for cascading).

#### Response Example
```json
{
  "commands": [
    { "type": "move", "point": [0, 0] },
    { "type": "line", "point": [1, 0] }
  ]
}
```
```

--------------------------------

### IModel Interface Example - JavaScript

Source: https://maker.js.org/docs/api/interfaces/makerjs.imodel

This example demonstrates the structure of an IModel object in JavaScript. It shows how to define paths within a model, with each path having a type, origin, and end point. This forms the basis for creating complex drawings.

```javascript
var m = {
  paths: {
    "line1": { type: 'line', origin: [0, 0], end: [1, 1] },
    "line2": { type: 'line', origin: [0, 0], end: [-1, -1] }
  }
};
```

--------------------------------

### Import Maker.js Namespace

Source: https://maker.js.org/docs/api/index

Demonstrates how to get a reference to the Maker.js library using require. This is the root module for the library.

```javascript
var makerjs = require('makerjs');

```

--------------------------------

### MakerJs Namespace Root

Source: https://maker.js.org/docs/api/index

Get a reference to the Maker.js root module. This is the entry point for using the library.

```APIDOC
## Maker.js Namespace Root

Root module for Maker.js. This is the entry point for using the library.

### Example
```javascript
var makerjs = require('makerjs');
```
```

--------------------------------

### Include Maker.js for Browser via Script Tag

Source: https://maker.js.org/docs/getting-started

This snippet shows how to include the Maker.js library in an HTML file using a script tag. It also includes optional script tags for dependencies like Bezier.js and Opentype.js, which are required for specific functionalities like font handling.

```html
<script src="http://maker.js.org/target/js/browser.maker.js" type="text/javascript"></script>
<script src="https://pomax.github.io/bezierjs/bezier.js" type="text/javascript"></script>
<script src="http://opentype.js.org/dist/opentype.js" type="text/javascript"></script>
```

--------------------------------

### Require Maker.js in JavaScript (Browser/Node.js)

Source: https://maker.js.org/docs/getting-started

This snippet shows how to get a reference to the Maker.js library in your JavaScript code using the `require` function. This is common practice in both browserified Node.js modules and Node.js environments.

```javascript
var makerjs = require('makerjs');
```

--------------------------------

### Render a model with paths that form a chain in JavaScript

Source: https://maker.js.org/docs/working-with-chains

This example demonstrates how to create a simple model with three connected line segments forming a chain. It then exports the model to an SVG string and writes it to the document. This is a basic illustration of path creation and SVG export.

```javascript
var makerjs = require('makerjs');

var model = {

  paths: {
    "0": new makerjs.paths.Line([0, 0], [100, 0]),
    "1": new makerjs.paths.Line([100, 0], [100, 100]),
    "2": new makerjs.paths.Line([100, 100], [200, 100])
  }

};

var svg = makerjs.exporter.toSVG(model);

document.write(svg);
```

--------------------------------

### Render House with Windows using Maker.js

Source: https://maker.js.org/docs/basic-drawing

This example demonstrates how to render a simple house shape using ConnectTheDots and add square windows using the Square model. It utilizes the makerjs library for geometric modeling and exports the final model as an SVG string.

```javascript
var makerjs = require('makerjs');

var points = [
  [100, 0], [100, 100], [0, 175], [-100, 100], [-100, 0],
  [-20, 0], [-20, 80], [20, 80], [20, 0]
];

var house = new makerjs.models.ConnectTheDots(true, points);

var window1 = new makerjs.models.Square(40);
window1.origin = [40, 40];

var window2 = new makerjs.models.Square(40);
window2.origin = [-80, 40];

var houseWithWindows = {
  models: { "myHouse": house, "window1": window1, "window2": window2 }
};

var svg = makerjs.exporter.toSVG(houseWithWindows);

document.write(svg);
```

--------------------------------

### Render Circular Adapter Plate using Maker.js

Source: https://maker.js.org/docs/basic-drawing

This example demonstrates the creation of a circular adapter plate using the Ring model for the main body and BoltCircle for positioning bolt holes. The combined model is then exported as an SVG.

```javascript
var makerjs = require('makerjs');

var model = {
  models: {
    ring1: new makerjs.models.Ring(40, 100),
    bc1: new makerjs.models.BoltCircle(90, 4, 10),
    bc2: new makerjs.models.BoltCircle(55, 7, 6, 30)
  }
};

var svg = makerjs.exporter.toSVG(model);

document.write(svg);
```

--------------------------------

### Render Tablet Mount using Maker.js

Source: https://maker.js.org/docs/basic-drawing

This example shows how to create a tablet mount with rounded corners using RoundRectangle, add a buttonhole with Circle, and include bolt holes using BoltRectangle. The models are combined and exported as an SVG.

```javascript
var makerjs = require('makerjs');

var outer = new makerjs.models.RoundRectangle(200, 280, 8);

var inner = new makerjs.models.RoundRectangle(160, 230, 8);
inner.origin = [20, 30];

var buttonhole = new makerjs.paths.Circle([100, 15], 8);

var bolts = new makerjs.models.BoltRectangle(180, 260, 2);
bolts.origin = [10, 10];

var tabletFaceMount = {
  paths: { buttonhole: buttonhole },
  models: { inner: inner, outer: outer, bolts: bolts }
};

var svg = makerjs.exporter.toSVG(tabletFaceMount);

document.write(svg);
```

--------------------------------

### Render a Line Created by a Function with Maker.js

Source: https://maker.js.org/docs/basic-drawing

This example demonstrates creating a line using a constructor function in JavaScript, where properties are assigned using 'this'. An instance of this function is created with 'new' and then exported to SVG via Maker.js. It requires the 'makerjs' module.

```javascript
var makerjs = require('makerjs');

function line() { 
  this.type = 'line', 
  this.origin = [0, 0], 
  this.end = [50, 50] 
 };
 
var svg = makerjs.exporter.toSVG(new line());

document.write(svg);
```

--------------------------------

### Expand Paths of Different Types in maker.js

Source: https://maker.js.org/docs/advanced-drawing

This example shows how to expand individual paths (Line, Arc, Circle) by a specified distance using maker.js. The expanded paths are then combined into a single model and exported as SVG. It demonstrates the `makerjs.path.expand` function.

```javascript
var makerjs = require('makerjs');

var model = {
  paths: {
    p1: new makerjs.paths.Line([0, 2], [10, 2]),
    p2: new makerjs.paths.Arc([20, 0], 5, 0, 180),
    p3: new makerjs.paths.Circle([35, 2], 5)
  }
};

model.models = {
    x1: makerjs.path.expand(model.paths.p1, 2),
    x2: makerjs.path.expand(model.paths.p2, 2),
    x3: makerjs.path.expand(model.paths.p3, 2)
};

var svg = makerjs.exporter.toSVG(model);

document.write(svg);
```

--------------------------------

### Layering Paths in Maker.js

Source: https://maker.js.org/docs/intermediate-drawing

This example demonstrates how to assign layers to paths within a Maker.js model. Layers are used for logical grouping and can influence export formats like DXF and SVG. Different paths can be assigned to different layers.

```javascript
var makerjs = require('makerjs');

var roundRect = new makerjs.models.RoundRectangle(100, 50, 10);
roundRect.layer = "layer1";

roundRect.paths.BottomLeft.layer = "layer2";
roundRect.paths.BottomRight.layer = "layer2";
roundRect.paths.TopRight.layer = "layer2";
roundRect.paths.TopLeft.layer = "layer2";

var svg = makerjs.exporter.toSVG(roundRect);

document.write(svg);
```

--------------------------------

### Layering with Color in Maker.js

Source: https://maker.js.org/docs/intermediate-drawing

This example shows how to use reserved color names as layer names in Maker.js. When exporting to DXF or SVG, these layer names will automatically apply stroke colors. This allows for visual distinction of layered elements.

```javascript
var makerjs = require('makerjs');

var roundRect = new makerjs.models.RoundRectangle(100, 50, 10);
roundRect.layer = "layer1";

roundRect.paths.BottomLeft.layer = "red";
roundRect.paths.BottomRight.layer = "red";
roundRect.paths.TopRight.layer = "blue";
roundRect.paths.TopLeft.layer = "blue";

var svg = makerjs.exporter.toSVG(roundRect);

document.write(svg);
```

--------------------------------

### Layout Child Models on a Chain with maker.js

Source: https://maker.js.org/docs/working-with-chains

This snippet demonstrates how to use a chain as a layout guide for arranging child models. It creates a row of squares and lays them out along a Bezier curve using makerjs.layout.childrenOnChain. Dependencies: makerjs library.

```javascript
//render a row of squares on a chain

var makerjs = require('makerjs');

var square = new makerjs.models.Square(5);

var row = makerjs.layout.cloneToRow(square, 10, 10);

var curve = new makerjs.models.BezierCurve([0, 0], [33, 25], [66, -25], [100, 0]);

var chain = makerjs.model.findSingleChain(curve);

makerjs.layout.childrenOnChain(row, chain, 0.5, false, true);

var model = {
    models: {
        curve: curve,
        row: row
    }
};

curve.layer = "red";

var svg = makerjs.exporter.toSVG(model);

document.write(svg);
```

--------------------------------

### Fillet all interior chains in a truss model using JavaScript

Source: https://maker.js.org/docs/working-with-chains

This example builds upon the truss wireframe by finding all chains within the expanded model, excluding the perimeter. It then iterates through the interior chains, applying fillets to each using `makerjs.chain.fillet` and storing them in the model's `models` object. The final result is exported to SVG.

```javascript
var m = require('makerjs');

function trussWireframe(w, h) {

  this.models = {
    frame: new m.models.ConnectTheDots(true, [ [0, h], [w, 0], [0, 0] ])
  };

  var angled = this.models.frame.paths.ShapeLine1;

  var bracepoints = [
    [0, 0],
    m.point.middle(angled, 1/3),
    [w/2 , 0],
    m.point.middle(angled, 2/3)
  ];

  this.models.brace = new m.models.ConnectTheDots(false, bracepoints);
}

var truss = new trussWireframe(200, 50);
var expansion = m.model.expandPaths(truss, 3, 1);

m.model.originate(expansion);
m.model.simplify(expansion);

//find chains
var chains = m.model.findChains(expansion);

//start at 1 - ignore the longest chain which is the perimeter
for (var i = 1; i < chains.length; i++) {

  //save the fillets in the model tree 
  expansion.models['fillets' + i] = m.chain.fillet(chains[i], 2);
}

var svg = m.exporter.toSVG(expansion);

document.write(svg);
```

--------------------------------

### Add Dogbones to Plus Shapes with maker.js

Source: https://maker.js.org/docs/working-with-chains

This example shows how to add dogbones to the corners of plus shapes to accommodate material thickness. It finds the chains of the pluses, ensures they are clockwise, and applies dogbones to the appropriate corners before exporting to SVG. Dependencies: makerjs library.

```javascript
var makerjs = require('makerjs');

var plus1 = makerjs.model.combineUnion(
  makerjs.model.center(new makerjs.models.Rectangle(50, 100)),
  makerjs.model.center(new makerjs.models.Rectangle(100, 50))
);

var plus2 = makerjs.cloneObject(plus1);
plus2.origin = [150, 0];

var square = makerjs.model.center(new makerjs.models.Square(150));

//find chains for each plus
var chain1 = makerjs.model.findSingleChain(plus1);
var chain2 = makerjs.model.findSingleChain(plus2);

//make sure our chains are clockwise
[chain1, chain2].forEach(chain => {
  if (makerjs.measure.isChainClockwise(chain)) makerjs.chain.reverse(chain);
});

//add dogbones for left and right turns
var dogbones1 = makerjs.chain.dogbone(chain1, { left: 5});
var dogbones2 = makerjs.chain.dogbone(chain2, { right: 5});

var model = {
  models: { plus1, plus2, square, dogbones1, dogbones2 }
}

var svg = makerjs.exporter.toSVG(model);

document.write(svg);
```

--------------------------------

### Add fillets to a chain in a model using JavaScript

Source: https://maker.js.org/docs/working-with-chains

This example shows how to find a single chain within a model and then add fillets to its joints. It defines a model with line paths, finds the chain using `findSingleChain`, applies fillets using `makerjs.chain.fillet`, and then exports the modified model to SVG. This demonstrates chain analysis and modification.

```javascript
var makerjs = require('makerjs');

var model = {

  paths: {
    "0": new makerjs.paths.Line([0, 0], [100, 0]),
    "1": new makerjs.paths.Line([100, 0], [100, 100]),
    "2": new makerjs.paths.Line([100, 100], [200, 100])
  },

  //create a placeholder in the tree for more models
  models: {}

};

//find the chain
var chain = makerjs.model.findSingleChain(model);

//add fillets to the chain
var filletsModel = makerjs.chain.fillet(chain, 10);

//put the fillets in the tree
model.models.fillets = filletsModel;

var svg = makerjs.exporter.toSVG(model);

document.write(svg);
```

--------------------------------

### Get Polygon Points

Source: https://maker.js.org/docs/api/classes/makerjs.models.polygon

A static method to generate the points for a polygon. It requires the number of sides and radius, with optional parameters for the starting angle and circumscription.

```typescript
getPoints(numberOfSides: number, radius: number, firstCornerAngleInDegrees?: number, circumscribed?: boolean): IPoint[]
```

--------------------------------

### Measure Path Extents with Maker.js

Source: https://maker.js.org/docs/basic-drawing

This example shows how to get the bounding box of a path in Maker.js using `makerjs.measure.pathExtents`. It calculates the total width and height of the path and creates a rectangle to visualize the measurement.

```javascript
var makerjs = require('makerjs');

var arc = new makerjs.paths.Arc([0, 0], 100, 45, 135);
var m = makerjs.measure.pathExtents(arc);

console.log('measurement:');
console.log(m);

var totalWidth = m.high[0] - m.low[0];
var totalHeight = m.high[1] - m.low[1];

var measureRect = new makerjs.models.Rectangle(totalWidth, totalHeight);
measureRect.origin = m.low;

var model = {
    paths: {
        arc: arc
    },
    models: {
        measureRect: measureRect
    }
};

var svg = makerjs.exporter.toSVG(model, {useSvgPathOnly: false});

document.write(svg);
```

--------------------------------

### Ring Class Constructor

Source: https://maker.js.org/docs/api/classes/makerjs.models.ring

This section describes the constructor for the Ring class, including its parameters and return type.

```APIDOC
## new Ring(outerRadius: number, innerRadius?: number): Ring

### Description
Constructs a new Ring object.

### Method
CONSTRUCTOR

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "new Ring(10, 5)"
}
```

### Response
#### Success Response (200)
- **Ring** (Ring) - The newly created Ring object.

#### Response Example
```json
{
  "example": "Ring object instance"
}
```
```

--------------------------------

### Render Model with Endless Chain in Maker.js

Source: https://maker.js.org/docs/basic-drawing

Renders a Maker.js model where paths form an endless chain, meaning the chain starts and ends at the same point. This example includes lines and an arc to demonstrate closed-loop chains.

```javascript
var makerjs = require('makerjs');

var model = {

  paths: {
    "v": new makerjs.paths.Line([0, 0], [0, 100]),
    "h": new makerjs.paths.Line([0, 0], [100, 0]),
    "arc":new makerjs.paths.Arc([0, 0], 100, 0, 90)
  }

};

var svg = makerjs.exporter.toSVG(model);

document.write(svg);
```

--------------------------------

### IPathIntersectionBaseOptions Interface

Source: https://maker.js.org/docs/api/interfaces/makerjs.ipathintersectionbaseoptions

Options to configure path intersection calculations in Maker.js.

```APIDOC
## IPathIntersectionBaseOptions Interface

Options to pass to path.intersection()

### Hierarchy
  * IPathIntersectionBaseOptions
    * IPathIntersectionOptions

### Properties

#### Optional excludeTangents
`excludeTangents`: boolean
Optional boolean to only return deep intersections, i.e. not on an end point or tangent.

#### Optional out_AreOverlapped
`out_AreOverlapped`: boolean
Optional output variable which will be set to true if the paths are overlapped.

Generated using TypeDoc
```

--------------------------------

### IPathArc Interface Example - TypeScript and JavaScript

Source: https://maker.js.org/docs/api/interfaces/makerjs.ipatharc

Demonstrates the structure of the IPathArc interface in both TypeScript and JavaScript. This interface defines an arc path with properties for its type, origin, radius, start angle, and end angle. It is part of the Maker.js library.

```typescript
var arc: IPathArc = { type: 'arc', origin: [0, 0], radius: 7, startAngle: 0, endAngle: 45 };
```

```javascript
var arc = { type: 'arc', origin: [0, 0], radius: 7, startAngle: 0, endAngle: 45 };
```

--------------------------------

### IWalkPath Interface

Source: https://maker.js.org/docs/api/interfaces/makerjs.iwalkpath

Documentation for the IWalkPath interface, which represents a path reference in a walk. It details its properties and hierarchy.

```APIDOC
## IWalkPath Interface

### Description
A path reference in a walk.

### Hierarchy
  * IRefPathIdInModel
  * IRouteOffset
    * IWalkPath

### Properties

#### layer
- **layer** (string) - Description of the layer property.

#### modelContext
- **modelContext** (IModel) - Description of the modelContext property.

#### offset
- **offset** (IPoint) - Description of the offset property.

#### pathContext
- **pathContext** (IPath) - Description of the pathContext property.

#### pathId
- **pathId** (string) - Description of the pathId property.

#### route
- **route** (string[]) - Description of the route property.

#### routeKey
- **routeKey** (string) - Description of the routeKey property.
```

--------------------------------

### Construct a Class Instance with Apply and New - JavaScript

Source: https://maker.js.org/docs/api/modules/makerjs.kit

The 'construct' function is a helper to instantiate a class using the JavaScript 'apply' method with the 'new' keyword. It takes a constructor (IKit) and an array of arguments, returning a new instance of the class implementing the IModel interface.

```javascript
/**
 * Helper function to use the JavaScript "apply" function in conjunction with the "new" keyword.
 * @param ctor The constructor for the class which is an IKit.
 * @param args The array of parameters passed to the constructor.
 * @returns A new instance of the class, which implements the IModel interface.
 */
function construct(ctor, args) {
  // Implementation details would go here
  return new ctor(...args);
}
```

--------------------------------

### Line Class Properties

Source: https://maker.js.org/docs/api/classes/makerjs.paths.line

Properties of the Line class representing its start and end points, and type.

```APIDOC
## Line Class Properties

### `end`

**Type**: `IPoint`

**Description**: The end point of the line.

### `origin`

**Type**: `IPoint`

**Description**: The origin (starting) point of the line.

### `type`

**Type**: `string`

**Description**: The type of the path, which is 'line' for instances of this class.
```

--------------------------------

### Ellipse Class - Constructors

Source: https://maker.js.org/docs/api/classes/makerjs.models.ellipse

This section details the different ways to instantiate an Ellipse object.

```APIDOC
## Ellipse Class Constructors

### Constructor Overloads

1.  **`new Ellipse(radiusX: number, radiusY: number, accuracy?: number): Ellipse`**
    *   Creates an Ellipse using two radii and an optional accuracy.
    *   **Parameters:**
        *   `radiusX` (number) - The x radius of the ellipse.
        *   `radiusY` (number) - The y radius of the ellipse.
        *   `accuracy` (number, Optional) - Optional accuracy of the underlying BezierCurve.
    *   **Returns:** `Ellipse`

2.  **`new Ellipse(origin: IPoint, radiusX: number, radiusY: number, accuracy?: number): Ellipse`**
    *   Creates an Ellipse at a specific origin with two radii and an optional accuracy.
    *   **Parameters:**
        *   `origin` (IPoint) - The center of the ellipse.
        *   `radiusX` (number) - The x radius of the ellipse.
        *   `radiusY` (number) - The y radius of the ellipse.
        *   `accuracy` (number, Optional) - Optional accuracy of the underlying BezierCurve.
    *   **Returns:** `Ellipse`

3.  **`new Ellipse(cx: number, cy: number, rx: number, ry: number, accuracy?: number): Ellipse`**
    *   Creates an Ellipse at a specific x, y coordinate with two radii and an optional accuracy.
    *   **Parameters:**
        *   `cx` (number) - The x coordinate of the center of the ellipse.
        *   `cy` (number) - The y coordinate of the center of the ellipse.
        *   `rx` (number) - The x radius of the ellipse.
        *   `ry` (number) - The y radius of the ellipse.
        *   `accuracy` (number, Optional) - Optional accuracy of the underlying BezierCurve.
    *   **Returns:** `Ellipse`
```

--------------------------------

### Extract Initial Parameter Values from a Kit - JavaScript

Source: https://maker.js.org/docs/api/modules/makerjs.kit

The 'getParameterValues' function extracts the initial sample values from a kit's metaParameters. It takes a constructor (IKit) as input and returns an array of these initial sample values.

```javascript
/**
 * Extract just the initial sample values from a kit.
 * @param ctor The constructor for the class which is an IKit.
 * @returns Array of the inital sample values provided in the metaParameters array.
 */
function getParameterValues(ctor) {
  // Implementation details would go here, assuming ctor has metaParameters property
  if (ctor && ctor.metaParameters) {
    return ctor.metaParameters.map(param => param.sample);
  }
  return [];
}
```

--------------------------------

### Get All Captions Offset

Source: https://maker.js.org/docs/api/modules/makerjs.model

Retrieves all Caption objects from a model and its children, returning them in absolute positions.

```APIDOC
## getAllCaptionsOffset /api/websites/maker_js

### Description
Gets all Caption objects, in absolute position, in this model and its children.

### Method
GET (Assumed based on function signature and description)

### Endpoint
/websites/maker_js/getAllCaptionsOffset

### Parameters
#### Path Parameters
* None

#### Query Parameters
* **modelContext** (IModel) - Required - The model to search for Caption objects.

### Request Example
```json
{
  "modelContext": { ... } 
}
```

### Response
#### Success Response (200)
* **(ICaption & object)[]** - Array of Caption objects.

#### Response Example
```json
[
  { "caption": { ... }, "position": { ... } },
  { "caption": { ... }, "position": { ... } }
]
```
```

--------------------------------

### IWalkOptions Interface

Source: https://maker.js.org/docs/api/interfaces/makerjs.iwalkoptions

The IWalkOptions interface defines the available options for customizing the model.walk() method in Maker.js.

```APIDOC
## IWalkOptions Interface

### Description
Options to pass to model.walk().

### Hierarchy
  * IWalkOptions

### Properties

#### Optional `afterChildWalk`
- **afterChildWalk** (IWalkModelCallback) - Callback for every child model in every model, after all of its children have been walked.

#### Optional `beforeChildWalk`
- **beforeChildWalk** (IWalkModelCancellableCallback) - Callback for every child model in every model. Return false to stop walking down further models.

#### Optional `onPath`
- **onPath** (IWalkPathCallback) - Callback for every path in every model.

### Request Example
```json
{
  "afterChildWalk": "function(model) { ... }",
  "beforeChildWalk": "function(model) { return true; }",
  "onPath": "function(path) { ... }"
}
```

### Response Example
```json
{
  "message": "Walk options processed successfully."
}
```
```

--------------------------------

### Layout Paths/Models in a Brick Pattern with Maker.js

Source: https://maker.js.org/docs/intermediate-drawing

Demonstrates arranging items in a brick wall layout using makerjs.layout.cloneToBrick. This function repeats a path or model in a staggered pattern, similar to bricks in a wall, with options for count and margin. Useful for simulating masonry or offset repeating patterns.

```javascript
var m = require('makerjs');

var brick = new m.models.Rectangle(20, 8);

var wall = m.layout.cloneToBrick(brick, 8, 7, 2);

document.write(m.exporter.toSVG(wall));
```

--------------------------------

### Text Constructor

Source: https://maker.js.org/docs/api/classes/makerjs.models.text

Renders text in a given font to a model. Allows for customization of text rendering, including combining characters and centering origins.

```APIDOC
## new Text(font: Font, text: string, fontSize: number, combine?: boolean, centerCharacterOrigin?: boolean, bezierAccuracy?: number, opentypeOptions?: RenderOptions): Text

### Description
Renders text in a given font to a model.

### Method
CONSTRUCTOR

### Parameters
#### Path Parameters
* **font** (Font) - Required - OpenType.Font object.
* **text** (string) - Required - String of text to render.
* **fontSize** (number) - Required - Font size.
* **combine** (boolean) - Optional (default: false) - Flag to perform a combineUnion upon each character with characters to the left and right.
* **centerCharacterOrigin** (boolean) - Optional (default: false) - Flag to move the x origin of each character to the center. Useful for rotating text characters.
* **bezierAccuracy** (number) - Optional - Optional accuracy of Bezier curves.
* **opentypeOptions** (RenderOptions) - Optional - Optional opentype.RenderOptions object.

### Returns
Text - Model of the text.

### Request Example
```json
{
  "font": "<OpenType.Font object>",
  "text": "Hello Maker.js",
  "fontSize": 100,
  "combine": true
}
```

### Response Example
```json
{
  "models": "<IModelMap object>"
}
```
```

--------------------------------

### Get Similar Path ID

Source: https://maker.js.org/docs/api/modules/makerjs.model

Generates an unused path ID with a specified prefix within a given model context.

```APIDOC
## getSimilarPathId /api/websites/maker_js

### Description
Get an unused id in the paths map with the same prefix.

### Method
GET (Assumed based on function signature and description)

### Endpoint
/websites/maker_js/getSimilarPathId

### Parameters
#### Path Parameters
* None

#### Query Parameters
* **modelContext** (IModel) - Required - The model containing the paths map.
* **pathId** (string) - Required - The id to use directly (if unused), or as a prefix.

### Request Example
```json
{
  "modelContext": { ... }, 
  "pathId": "pathPrefix_"
}
```

### Response
#### Success Response (200)
* **string** - An unused path ID.

#### Response Example
```json
"pathPrefix_1"
```
```

--------------------------------

### Get Similar Model ID

Source: https://maker.js.org/docs/api/modules/makerjs.model

Generates an unused model ID with a specified prefix within a given model context.

```APIDOC
## getSimilarModelId /api/websites/maker_js

### Description
Get an unused id in the models map with the same prefix.

### Method
GET (Assumed based on function signature and description)

### Endpoint
/websites/maker_js/getSimilarModelId

### Parameters
#### Path Parameters
* None

#### Query Parameters
* **modelContext** (IModel) - Required - The model containing the models map.
* **modelId** (string) - Required - The id to use directly (if unused), or as a prefix.

### Request Example
```json
{
  "modelContext": { ... }, 
  "modelId": "examplePrefix_"
}
```

### Response
#### Success Response (200)
* **string** - An unused model ID.

#### Response Example
```json
"examplePrefix_1"
```
```

--------------------------------

### Line Class Constructors

Source: https://maker.js.org/docs/api/classes/makerjs.paths.line

Constructs a line path either from an array of two points or from an origin and end point.

```APIDOC
## Line Class Constructors

### `new Line(points: IPoint[])`

**Description**: Constructs a line path from an array of two points.

**Parameters**:
* `points` (IPoint[]) - Required - An array containing exactly two IPoint objects.

**Returns**: `Line` - An instance of the Line class.

### `new Line(origin: IPoint, end: IPoint)`

**Description**: Constructs a line path from an origin point and an end point.

**Parameters**:
* `origin` (IPoint) - Required - The starting point of the line.
* `end` (IPoint) - Required - The ending point of the line.

**Returns**: `Line` - An instance of the Line class.
```

--------------------------------

### Get Polygon Paths

Source: https://maker.js.org/docs/api/classes/makerjs.models.polygon

Accesses the paths associated with a Polygon object. The paths are stored in an IPathMap data structure.

```typescript
paths: IPathMap
```

--------------------------------

### Path API - Get Points

Source: https://maker.js.org/docs/api/modules/makerjs.path

Retrieves points along a given path context. You can optionally specify the maximum arc facet length.

```APIDOC
## GET /websites/maker_js/path

### Description
Retrieves points along a given path context. You can optionally specify the maximum arc facet length.

### Method
GET

### Endpoint
/websites/maker_js/path

### Parameters
#### Query Parameters
- **pathContext** (IPath) - Required - Path to get points from.
- **maxArcFacet** (number) - Optional - Optional maximum length between points on an arc or circle.

### Response
#### Success Response (200)
- **IPoint[]** - Array of points which are on the path.

#### Response Example
```json
[
  { "x": 0, "y": 0 },
  { "x": 1, "y": 1 }
]
```
```

--------------------------------

### Get All Captions Offset in Model - TypeScript

Source: https://maker.js.org/docs/api/modules/makerjs.model

Retrieves all Caption objects in absolute position from a model and its children. It requires an IModel as input and returns an array of Caption objects.

```typescript
getAllCaptionsOffset(modelContext: IModel): (ICaption & object)[]
```

--------------------------------

### Star Class Constructor

Source: https://maker.js.org/docs/api/classes/makerjs.models.star

Initializes a new Star object. This constructor allows for the creation of star shapes with adjustable points, radii, and skipped points.

```APIDOC
## new Star(numberOfPoints: number, outerRadius: number, innerRadius?: number, skipPoints?: number): Star

### Description
Initializes a new Star object with specified parameters.

### Method
CONSTRUCTOR

### Parameters
#### Path Parameters
- **numberOfPoints** (number) - Required - The number of points the star should have.
- **outerRadius** (number) - Required - The radius of the star's outer points.
- **innerRadius** (number) - Optional - The radius of the star's inner points. If not provided, a default value is used.
- **skipPoints** (number) - Optional - The number of points to skip when drawing the star. Defaults to 2.

### Response
#### Success Response (200)
- **Star** (object) - A new Star object instance.
```

--------------------------------

### Zero a path's bounding box with maker_js

Source: https://maker.js.org/docs/api/interfaces/makerjs.icascadepath

Moves a path so that its bounding box starts at the origin [0, 0]. The function returns a cascade container for chaining operations.

```typescript
zero(): ICascadePath
```

--------------------------------

### Scaling Paths and Models

Source: https://maker.js.org/docs/intermediate-drawing

Demonstrates how to proportionally scale paths and models using `makerjs.path.scale` and `makerjs.model.scale`. These functions return the modified object, allowing for chained operations.

```APIDOC
## Scaling

To proportionately scale a simple point, use `makerjs.point.scale`. To proportionately scale paths and models, use these functions:
  * `makerjs.path.scale(path: object, scaleValue: number)`
  * `makerjs.model.scale(model: object, scaleValue: number)`

Each of these functions return the original object, so that we can "chain" on the same line of code.

### Scale Path Example

```javascript
//render a scaled arc

var makerjs = require('makerjs');

var arc1 = new makerjs.paths.Arc([0, 0], 25, 0, 90);
var arc2 = new makerjs.paths.Arc([0, 0], 25, 0, 90);

arc2 = makerjs.path.scale(arc2, 2);

var svg = makerjs.exporter.toSVG({ paths: { arc1: arc1, arc2: arc2 }});

document.write(svg);
```

### Scale Model Example

```javascript
//render a scaled polygon

var makerjs = require('makerjs');

var model = {
  models: {
    inner: new makerjs.models.Polygon(6, 40),
    outer: makerjs.model.scale(new makerjs.models.Polygon(6, 40), 1.7)
  }
};

var svg = makerjs.exporter.toSVG(model);

document.write(svg);
```
```

--------------------------------

### Render Model with No Chains in Maker.js

Source: https://maker.js.org/docs/basic-drawing

Renders a Maker.js model containing independent line paths that do not form any chains. This example demonstrates the basic structure of a Maker.js model and its SVG export.

```javascript
var makerjs = require('makerjs');

var model = {

  paths: {
    "h1": new makerjs.paths.Line([0, 10], [30, 10]),
    "h2": new makerjs.paths.Line([0, 20], [30, 20]),
    "v1": new makerjs.paths.Line([10, 0], [10, 30]),
    "v2": new makerjs.paths.Line([20, 0], [20, 30])
  }

};

var svg = makerjs.exporter.toSVG(model);

document.write(svg);
```

--------------------------------

### Instantiate Polygon Class

Source: https://maker.js.org/docs/api/classes/makerjs.models.polygon

Creates a new Polygon object. This constructor takes the number of sides, radius, an optional starting angle, and a boolean indicating if it's circumscribed.

```typescript
new Polygon(numberOfSides: number, radius: number, firstCornerAngleInDegrees?: number, circumscribed?: boolean): Polygon
```

--------------------------------

### Render a Model Created by a Function with Maker.js

Source: https://maker.js.org/docs/basic-drawing

This example shows how to define a Maker.js model within a function that returns the model object. The function is called, and its returned model is then exported to SVG. It relies on the 'makerjs' module.

```javascript
var makerjs = require('makerjs');

function myModel() {

 var line = { 
   type: 'line', 
   origin: [0, 0], 
   end: [50, 50] 
  };

 var circle = { 
   type: 'circle', 
   origin: [0, 0],
   radius: 50
  };

 var pathObject = { myLine: line, myCircle: circle };

 var model = { paths: pathObject };
 
 return model;
}

var svg = makerjs.exporter.toSVG(myModel());

document.write(svg);
```

--------------------------------

### Collector Class API

Source: https://maker.js.org/docs/api/classes/makerjs.collector

Documentation for the Collector class, including its constructor, properties, and methods.

```APIDOC
## Collector Class

Collects items that share a common key.

### Type parameters
  * #### K
  * #### T

### Hierarchy
  * Collector

## Constructors
### constructor
  * new Collector(comparer?: ICollectionKeyComparer<K>): Collector

  * #### Parameters
    * ##### Optional comparer: ICollectionKeyComparer<K>
#### Returns Collector

## Properties
### collections
collections: ICollection<K, T>[]

## Methods
### addItemToCollection
  * addItemToCollection(key: K, item: T): void

  * #### Parameters
    * ##### key: K
    * ##### item: T
#### Returns void

### findCollection
  * findCollection(key: K, action?: function): T[]

  * #### Parameters
    * ##### key: K
    * ##### Optional action: function
      *         * (index: number): void
        * #### Parameters
          * ##### index: number
#### Returns void
#### Returns T[]

### getCollectionsOfMultiple
  * getCollectionsOfMultiple(cb: function): void

  * #### Parameters
    * ##### cb: function
      *         * (key: K, items: T[]): void
        * #### Parameters
          * ##### key: K
          * ##### items: T[]
#### Returns void
#### Returns void

### removeCollection
  * removeCollection(key: K): boolean

  * #### Parameters
    * ##### key: K
#### Returns boolean

### removeItemFromCollection
  * removeItemFromCollection(key: K, item: T): boolean

  * #### Parameters
    * ##### key: K
    * ##### item: T
#### Returns boolean
```

--------------------------------

### Distorting Paths and Models

Source: https://maker.js.org/docs/intermediate-drawing

Explains how to disproportionately scale points, paths, and models using `makerjs.point.distort`, `makerjs.path.distort`, and `makerjs.model.distort`. Note that `makerjs.path.distort` and `makerjs.model.distort` return new objects.

```APIDOC
## Distorting

To disproportionately scale a simple point, use `makerjs.point.distort`. 
To disproportionately scale a path, use `makerjs.path.distort(path: object, scaleX: number, scaleY: number)` which returns a new object and does not modify the original. The type of returned object is dependent on the type of path being distorted: 
  * A line will return a line _IPath_ object, since the distortion can be represented with another line.
  * An arc will return a BezierCurve _IModel_ object, since the distortion is not circular.
  * A circle will return an Ellipse _IModel_ object, since the distortion is not circular.

### Distort Path Example

```javascript
//render distorted paths

var makerjs = require('makerjs');

var circle = new makerjs.paths.Circle(50);
var line = new makerjs.paths.Line([-50,-50], [50, 50]);

//a distorted line is a path, so it should be added to paths
var distortedLine = makerjs.path.distort(line, 4, 1.5);

//a distorted circle is a model, so it should be added to models
var ellipse = makerjs.path.distort(circle, 4, 1.5);

var model = {
  paths: {
    circle: circle,
    line: line,
    distortedLine: distortedLine
  },
  models: {
    ellipse: ellipse
  }
};

var svg = makerjs.exporter.toSVG(model);
  
document.write(svg);
```

To disproportionately scale a model, use `makerjs.model.distort(model: object, scaleX: number, scaleY: number)` which returns a new _IModel_ object and does not modify the original. 

### Distort Model Example

```javascript
//render a distorted star

var makerjs = require('makerjs');

var star = new makerjs.models.Star(5, 100);
makerjs.model.rotate(star, 18);

//make the star 4 times wider, and 2 times taller
var wideStar = makerjs.model.distort(star, 4, 2);

var model = {
  models: {
    star: star,
    wideStar: wideStar
  }
};

var svg = makerjs.exporter.toSVG(model);

document.write(svg);
```
```

--------------------------------

### Get Similar Model ID - TypeScript

Source: https://maker.js.org/docs/api/modules/makerjs.model

Generates an unused model ID with the same prefix within the provided model's map. It takes an IModel and a modelId string as input and returns a unique string ID.

```typescript
getSimilarModelId(modelContext: IModel, modelId: string): string
```

--------------------------------

### IPath Interface

Source: https://maker.js.org/docs/api/interfaces/makerjs.ipath

Documentation for the IPath interface, which represents a line, curved line, or other simple two-dimensional shape. Includes its hierarchy and properties.

```APIDOC
## IPath Interface
A line, curved line or other simple two dimensional shape.

### Hierarchy
  * IPath
    * IPathRemoved
    * IPathDirectional
    * IPathLine
    * IPathCircle
    * IPathArcInBezierCurve

## Properties

### Optional layer
`layer`: string
Optional layer of this path.

### origin
`origin`: IPoint
The main point of reference for this path.

### type
`type`: string
The type of the path, e.g. "line", "circle", or "arc". These strings are enumerated in pathType.
```

--------------------------------

### Cascading Functions in Maker.js

Source: https://maker.js.org/docs/intermediate-drawing

This example illustrates the use of cascading functions in Maker.js, where the output of one function is passed as the input to the next. This allows for chaining multiple operations like centering, rotating, and moving a model in a single statement.

```javascript
var makerjs = require('makerjs');

//many operations in this one statement
var square = 
        makerjs.model.moveRelative(
            makerjs.model.rotate(
                makerjs.model.center(
                    new makerjs.models.Square(10)
                ),
            45),
        [0, 15])
    ;

var drawing = {
    models: {
        dome: new makerjs.models.Dome(30, 30),
        square: square
    }
};

var svg = makerjs.exporter.toSVG(drawing);

document.write(svg);
```

--------------------------------

### IOpenJsCadOptions Interface

Source: https://maker.js.org/docs/api/interfaces/makerjs.exporter.iopenjscadoptions

Provides options for exporting models to OpenJSCAD format. This interface extends IExportOptions and IFindLoopsOptions.

```APIDOC
## IOpenJsCadOptions Interface

### Description
Options for exporting models to OpenJSCAD format. This interface extends IExportOptions and IFindLoopsOptions.

### Hierarchy
* IFindLoopsOptions
* IExportOptions
  * IOpenJsCadOptions

### Properties

#### Optional accuracy
`accuracy`: number
Optional exemplar of number of decimal places.

#### Optional extrusion
`extrusion`: number
Optional depth of 3D extrusion.

#### Optional facetSize
`facetSize`: number
Optional size of curve facets.

#### Optional functionName
`functionName`: string
Optional override of function name, default is "main".

#### Optional modelMap
`modelMap`: IOpenJsCadOptionsMap
Optional options applied to specific first-child models by model id.

#### Optional pointMatchingDistance
`pointMatchingDistance`: number
Max distance to consider two points as the same.

#### Optional removeFromOriginal
`removeFromOriginal`: boolean
Flag to remove looped paths from the original model.

#### Optional units
`units`: string
Optional unit system to embed in exported file, if the export format allows alternate unit systems.
```
Tokens:
Raw