> ## Documentation Index
> Fetch the complete documentation index at: https://docs.opengeometry.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference

> Every export of the opengeometry 3.0 package, and the page that describes it.

The package has one entry, `opengeometry`. Its types are in `index.d.ts` in the installed package.

```ts theme={null}
import { OpenGeometry, Solid, Wire, OG_PRIMITIVE_CUBOID } from 'opengeometry';
import type { Measure } from 'opengeometry';
```

## Classes and values

| Export | Page | What it is |
| - | - | - |
| `OpenGeometry` | [OpenGeometry](https://docs.opengeometry.io/opengeometry/api/opengeometry.md) | The runtime: start, events, history, export, 2D |
| `Wire` | [Wire](https://docs.opengeometry.io/opengeometry/api/wire.md) | Lines and arcs |
| `Solid` | [Solid](https://docs.opengeometry.io/opengeometry/api/solid.md) | Closed faces around a volume |
| `Sheet` | [Sheet](https://docs.opengeometry.io/opengeometry/api/sheet.md) | Faces that enclose no volume |
| `SystemAssembly` | [SystemAssembly](https://docs.opengeometry.io/opengeometry/api/system-assembly.md) | A group of nodes |
| `OGMark` | [OGMark](https://docs.opengeometry.io/opengeometry/api/og-mark.md) | A point in history |
| `OGError` | [OGError](https://docs.opengeometry.io/opengeometry/api/og-error.md) | The error every call throws |
| `OG_*` constants | [Constants](https://docs.opengeometry.io/opengeometry/api/constants.md) | Kinds, typed parameter helpers, tolerance |

The methods that `Wire`, `Solid` and `Sheet` share are on [Body methods](https://docs.opengeometry.io/opengeometry/api/body.md). The display statics are on [Display](https://docs.opengeometry.io/opengeometry/api/display.md), and picking on [Picking](https://docs.opengeometry.io/opengeometry/api/picking.md).

## Types

| Type | Page |
| - | - |
| `BodyEventMap`, `PointClassification`, `Measure`, `Validity`, `MirrorPlane` | [Body methods](https://docs.opengeometry.io/opengeometry/api/body.md) |
| `HostGroup` | [Display](https://docs.opengeometry.io/opengeometry/api/display.md) |
| `ErrorDetails`, `OperateErrorDetails` | [OGError](https://docs.opengeometry.io/opengeometry/api/og-error.md) |
| `AnalyticExchangeBodyV2`, `IfcPreparedValue` | [Export](https://docs.opengeometry.io/opengeometry/api/export.md) |
| `OffsetRegion`, `CurvedRegion2D`, `CurvedRegionEdge` | [Regions](https://docs.opengeometry.io/opengeometry/api/regions.md) |
| `OffsetHole`, `OffsetPath2D`, `OffsetPolylineOptions` | [Offsets](https://docs.opengeometry.io/opengeometry/api/offsets.md) |
| `ProfileParams`, `ProfileSegment`, `ProfileArc`, `ArcParams`, `CylinderSectorParams`, `PolyhedronParams`, `SphereParams`, `ConeParams`, `TorusParams`, `SlotPrismParams`, `RoundedBoxParams`, `PipeSegmentParams`, `PolysolidParams`, `RegularPolygonParams`, `SlotParams`, `RoundedRectangleParams` | [Constants](https://docs.opengeometry.io/opengeometry/api/constants.md) |

## Conventions

* Points and vectors are `[x, y, z]`. Units are metres. Y is up.
* Kinds are string constants, such as `OG_PRIMITIVE_CUBOID`, which is `'Cuboid'`.
* Every failure throws an `OGError`.
* `index.d.ts` also declares internal members, such as `handle` and `install`. They are not part of the API; do not call them.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.