API reference

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

import { OpenGeometry, Solid, Wire, OG_PRIMITIVE_CUBOID } from 'opengeometry';
import type { Measure } from 'opengeometry';

Classes and values

Export	Page	What it is
`OpenGeometry`	OpenGeometry	The runtime: start, events, history, export, 2D
`Wire`	Wire	Lines and arcs
`Solid`	Solid	Closed faces around a volume
`Sheet`	Sheet	Faces that enclose no volume
`SystemAssembly`	SystemAssembly	A group of nodes
`OGMark`	OGMark	A point in history
`OGError`	OGError	The error every call throws
`OG_*` constants	Constants	Kinds, typed parameter helpers, tolerance

The methods that Wire, Solid and Sheet share are on Body methods. The display statics are on Display, and picking on Picking.

Type	Page
`BodyEventMap`, `PointClassification`, `Measure`, `Validity`, `MirrorPlane`	Body methods
`HostGroup`	Display
`ErrorDetails`, `OperateErrorDetails`	OGError
`AnalyticExchangeBodyV2`, `IfcPreparedValue`	Export
`OffsetRegion`, `CurvedRegion2D`, `CurvedRegionEdge`	Regions
`OffsetHole`, `OffsetPath2D`, `OffsetPolylineOptions`	Offsets
`ProfileParams`, `ProfileSegment`, `ProfileArc`, `ArcParams`, `CylinderSectorParams`, `PolyhedronParams`, `SphereParams`, `ConeParams`, `TorusParams`, `SlotPrismParams`, `RoundedBoxParams`, `PipeSegmentParams`, `PolysolidParams`, `RegularPolygonParams`, `SlotParams`, `RoundedRectangleParams`	Constants

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.