Package Exports

primitive-geometry

Readme

primitive-geometry

Geometries for 3D rendering, including normals, UVs and cell indices (faces). Perfect if you want to supercharge your dependency folder... with 30KB of geometries.

Installation

npm install primitive-geometry

Features

Common API: options object in, simplicial complex out
Outputs TypedArray (Float32Array for geometry data and Uint8Array|Uint16Array|Uint32Array for cells)
Zero dependency
Same parameters naming: radius (or rx/ry/rz), scale (or height/sx/sy/sz), segments (or nx/ny/nz) and a few specific parameters for icosphere/cylinder/cone/torus.

See difference with v1 here.

Usage

See the example and its source.

import Primitives from "primitive-geometry";

const quadGeometry = Primitives.quad({
  scale: 0.5,
});
const planeGeometry = Primitives.plane({
  sx: 1,
  sy: 1,
  nx: 1,
  ny: 1,
});

const cubeGeometry = Primitives.cube({
  sx: 1,
  sy: 1,
  sz: 1,
  nx: 1,
  ny: 1,
  nz: 1,
});
const roundedCubeGeometry = Primitives.roundedCube({
  sx: 1,
  sy: 1,
  sz: 1,
  nx: 16,
  ny: 16,
  nz: 16,
  radius: 0.25,
});

const cylinderGeometry = Primitives.cylinder({
  height: 1,
  radius: 0.25,
  nx: 16,
  ny: 1,
  radiusApex: 0.25,
  capSegments: 1,
  capApex: true,
  capBase: true,
  capBaseSegments: 1,
  phi: Math.PI * 2,
});
const coneGeometry = Primitives.cone({
  height: 1,
  radius: 0.25,
  nx: 16,
  ny: 1,
  capSegments: 1,
  capBase: true,
  theta: Math.PI * 2,
});
const capsuleGeometry = Primitives.capsule({
  height: 0.5,
  radius: 0.25,
  nx: 16,
  ny: 32,
  theta: Math.PI * 2,
});

const sphereGeometry = Primitives.sphere({
  radius: 0.5,
  nx: 32,
  ny: 16,
  theta: Math.PI,
  phi: Math.PI * 2,
});
const icosphereGeometry = Primitives.icosphere({
  radius: 0.5,
  subdivisions: 2,
});
const ellipsoidGeometry = Primitives.ellipsoid({
  radius: 1,
  nx: 32,
  ny: 16,
  rx: 0.5,
  ry: 0.25,
  rz: 0.25,
  theta: Math.PI,
  phi: Math.PI * 2,
});
const torusGeometry = Primitives.torus({
  radius: 0.3,
  segments: 64,
  minorRadius: 0.1,
  minorSegments: 32,
  theta: Math.PI * 2,
  phi: Math.PI * 2,
});

const tetrahedron = Primitives.tetrahedron({
  radius: 0.5,
});
const icosahedron = Primitives.icosahedron({
  radius: 0.5,
});

// without normals/uvs
const boxGeometry = Primitives.box({
  sx: 1,
  sy: 1,
  sz: 1,
});
const circleGeometry = Primitives.circle({
  radius: 0.5,
  segments: 32,
  closed: false,
  theta: Math.PI * 2,
});

console.log(quadGeometry);
// {
//   positions: [ [x, y, z], [x, y, z], ... ],
//   cells: [ [a, b, c], [a, b, c], ... ],
//   uvs: [ [u, v], [u, v], ... ],
//   normals: [ [x, y, z], [x, y, z], ... ]
// }

API

Modules

index: Re-export all geometries and utils.
box
capsule
circle
cone
cube
cylinder
ellipsoid
icosahedron
icosphere
plane
quad
rounded-cube
sphere
tetrahedron
torus
utils

Typedefs

BasicSimplicialComplex : Object: Geometry definition without normals and UVs.
SimplicialComplex : Object: Geometry definition.

index

Re-export all geometries and utils.

box

box
- box([options]) ⇒ BasicSimplicialComplex ⏏
  - ~BoxOptions : Object

box([options]) ⇒ `BasicSimplicialComplex` ⏏

Kind: Exported function

Param	Type	Default
[options]	`BoxOptions`	`{}`

box~BoxOptions : `Object`

Kind: inner typedef of box Properties

Name	Type	Default
[sx]	`number`	`1`
[sy]	`number`	`sx`
[sz]	`number`	`sx`

capsule

capsule
- capsule([options]) ⇒ SimplicialComplex ⏏
  - ~CapsuleOptions : Object

capsule([options]) ⇒ `SimplicialComplex` ⏏

Kind: Exported function

Param	Type	Default
[options]	`CapsuleOptions`	`{}`

capsule~CapsuleOptions : `Object`

Kind: inner typedef of capsule Properties

Name	Type	Default
[height]	`number`	`1`
[radius]	`number`	`0.25`
[nx]	`number`	`16`
[ny]	`number`	`32`
[phi]	`number`	`TAU`

circle

circle
- circle([options]) ⇒ BasicSimplicialComplex ⏏
  - ~CircleOptions : Object

circle([options]) ⇒ `BasicSimplicialComplex` ⏏

Kind: Exported function

Param	Type	Default
[options]	`CircleOptions`	`{}`

circle~CircleOptions : `Object`

Kind: inner typedef of circle Properties

Name	Type	Default
[radius]	`number`	`0.5`
[segments]	`number`	`32`
[theta]	`number`	`TAU`
[closed]	`boolean`	`false`

cone

cone
- cone([options]) ⇒ SimplicialComplex ⏏
  - ~ConeOptions : Object

cone([options]) ⇒ `SimplicialComplex` ⏏

Kind: Exported function

Param	Type	Default
[options]	`ConeOptions`	`{}`

cone~ConeOptions : `Object`

Kind: inner typedef of cone Properties

Name	Type	Default
[height]	`number`	`1`
[radius]	`number`	`0.25`
[nx]	`number`	`16`
[ny]	`number`	`1`
[capSegments]	`number`	`1`
[capBase]	`boolean`	`true`
[phi]	`number`	`TAU`

cube

cube
- cube([options]) ⇒ SimplicialComplex ⏏
  - ~CubeOptions : Object

cube([options]) ⇒ `SimplicialComplex` ⏏

Kind: Exported function

Param	Type	Default
[options]	`CubeOptions`	`{}`

cube~CubeOptions : `Object`

Kind: inner typedef of cube Properties

Name	Type	Default
[sx]	`number`	`1`
[sy]	`number`	`sx`
[sz]	`number`	`sx`
[nx]	`number`	`1`
[ny]	`number`	`nx`
[nz]	`number`	`nx`

cylinder

cylinder
- cylinder([options]) ⇒ SimplicialComplex ⏏
  - ~CylinderOptions : Object

cylinder([options]) ⇒ `SimplicialComplex` ⏏

Kind: Exported function

Param	Type	Default
[options]	`CylinderOptions`	`{}`

cylinder~CylinderOptions : `Object`

Kind: inner typedef of cylinder Properties

Name	Type	Default
[height]	`number`	`1`
[radius]	`number`	`0.25`
[nx]	`number`	`16`
[ny]	`number`	`1`
[radiusApex]	`number`	`radius`
[capSegments]	`number`	`1`
[capApex]	`boolean`	`true`
[capBase]	`boolean`	`true`
[phi]	`number`	`TAU`

ellipsoid

ellipsoid
- ellipsoid([options]) ⇒ SimplicialComplex ⏏
  - ~EllipsoidOptions : Object

ellipsoid([options]) ⇒ `SimplicialComplex` ⏏

Default to an oblate spheroid.

Kind: Exported function

Param	Type	Default
[options]	`EllipsoidOptions`	`{}`

ellipsoid~EllipsoidOptions : `Object`

Kind: inner typedef of ellipsoid Properties

Name	Type	Default
[radius]	`number`	`0.5`
[nx]	`number`	`32`
[ny]	`number`	`16`
[rx]	`number`	`1`
[rx]	`number`	`0.5`
[rz]	`number`	`ry`
[theta]	`number`	`Math.PI`
[phi]	`number`	`TAU`

icosahedron

icosahedron
- icosahedron([options]) ⇒ SimplicialComplex ⏏
  - ~IcosahedronOptions : Object

icosahedron([options]) ⇒ `SimplicialComplex` ⏏

Kind: Exported function

Param	Type	Default
[options]	`IcosahedronOptions`	`{}`

icosahedron~IcosahedronOptions : `Object`

Kind: inner typedef of icosahedron Properties

Name	Type	Default
[radius]	`number`	`0.5`

icosphere

icosphere
- icosphere([options]) ⇒ SimplicialComplex ⏏
  - ~IcosphereOptions : Object

icosphere([options]) ⇒ `SimplicialComplex` ⏏

Kind: Exported function

Param	Type	Default
[options]	`IcosphereOptions`	`{}`

icosphere~IcosphereOptions : `Object`

Kind: inner typedef of icosphere Properties

Name	Type	Default
[radius]	`number`	`0.5`
[subdivisions]	`number`	`2`

plane

plane
- plane([options]) ⇒ SimplicialComplex ⏏
  - ~PlaneDirection : "x" | "-x" | "y" | "-y" | "z" | "-z"
  - ~PlaneOptions : Object

plane([options]) ⇒ `SimplicialComplex` ⏏

Kind: Exported function

Param	Type	Default
[options]	`PlaneOptions`	`{}`

plane~PlaneDirection : `"x"` | `"-x"` | `"y"` | `"-y"` | `"z"` | `"-z"`

Kind: inner typedef of plane

plane~PlaneOptions : `Object`

Kind: inner typedef of plane Properties

Name	Type	Default
[sx]	`number`	`1`
[sy]	`number`	`sx`
[nx]	`number`	`1`
[ny]	`number`	`nx`
[direction]	`string`	`""z""`

quad

quad
- quad([options]) ⇒ SimplicialComplex ⏏
  - ~QuadOptions : Object

quad([options]) ⇒ `SimplicialComplex` ⏏

Kind: Exported function

Param	Type	Default
[options]	`QuadOptions`	`{}`

quad~QuadOptions : `Object`

Kind: inner typedef of quad Properties

Name	Type	Default
[scale]	`number`	`0.5`

rounded-cube

rounded-cube
- roundedCube([options]) ⇒ SimplicialComplex ⏏
  - ~RoundedCubeOptions : Object

roundedCube([options]) ⇒ `SimplicialComplex` ⏏

Kind: Exported function

Param	Type	Default
[options]	`module:rounded~RoundedCubeOptions`	`{}`

roundedCube~RoundedCubeOptions : `Object`

Kind: inner typedef of roundedCube Properties

Name	Type	Default
[sx]	`number`	`1`
[sy]	`number`	`sx`
[sz]	`number`	`sx`
[nx]	`number`	`16`
[ny]	`number`	`nx`
[nz]	`number`	`nx`
[radius]	`number`	`sx * 0.25`

sphere

sphere
- sphere([options]) ⇒ SimplicialComplex ⏏
  - ~SphereOptions : Object

sphere([options]) ⇒ `SimplicialComplex` ⏏

Kind: Exported function

Param	Type	Default
[options]	`SphereOptions`	`{}`

sphere~SphereOptions : `Object`

Kind: inner typedef of sphere Properties

Name	Type	Default
[radius]	`number`	`0.5`
[nx]	`number`	`32`
[ny]	`number`	`16`
[theta]	`number`	`Math.PI`
[phi]	`number`	`TAU`

tetrahedron

tetrahedron
- tetrahedron([options]) ⇒ SimplicialComplex ⏏
  - ~TetrahedronOptions : Object

tetrahedron([options]) ⇒ `SimplicialComplex` ⏏

Kind: Exported function

Param	Type	Default
[options]	`TetrahedronOptions`	`{}`

tetrahedron~TetrahedronOptions : `Object`

Kind: inner typedef of tetrahedron Properties

Name	Type	Default
[radius]	`number`	`0.5`

torus

torus
- torus([options]) ⇒ SimplicialComplex ⏏
  - ~TorusOptions : Object

torus([options]) ⇒ `SimplicialComplex` ⏏

Kind: Exported function

Param	Type	Default
[options]	`TorusOptions`	`{}`

torus~TorusOptions : `Object`

Kind: inner typedef of torus Properties

Name	Type	Default
[radius]	`number`	`0.5`
[segments]	`number`	`64`
[minorRadius]	`number`	`0.1`
[minorSegments]	`number`	`16`
[theta]	`number`	`TAU`
[phi]	`number`	`TAU`

utils

utils
- .TAU : number
- .getCellsTypedArray ⇒ Uint8Array | Uint16Array | Uint32Array
- .normalize(v) ⇒ Array.<number>
- .checkArguments(...args)
- .setTypedArrayType(type)

utils.TAU : `number`

Two times PI.

Kind: static constant of utils

utils.getCellsTypedArray ⇒ `Uint8Array` | `Uint16Array` | `Uint32Array`

Select cells typed array from a size determined by amount of vertices.

Kind: static constant of utils See: MDN TypedArray objects

Param	Type	Description
size	`number`	The max value expected

utils.normalize(v) ⇒ `Array.<number>`

Normalize a vector 3.

Kind: static method of utils Returns: Array.<number> - Normalized vector

Param	Type	Description
v	`Array.<number>`	Vector 3 array

utils.checkArguments(...args)

Ensure first argument passed to the primitive functions is an object

Kind: static method of utils

Param	Type
...args	`*`

utils.setTypedArrayType(type)

Enforce a typed array constructor for cells

Kind: static method of utils

Param	Type
type	`Class.<Uint8Array>` \| `Class.<Uint16Array>` \| `Class.<Uint32Array>`

BasicSimplicialComplex : `Object`

Geometry definition without normals and UVs.

Kind: global typedef Properties

Name	Type
positions	`Float32Array`
cells	`Uint8Array` \| `Uint16Array` \| `Uint32Array`

SimplicialComplex : `Object`

Geometry definition.

Kind: global typedef Properties

Name	Type
positions	`Float32Array`
normals	`Float32Array`
uvs	`Float32Array`
cells	`Uint8Array` \| `Uint16Array` \| `Uint32Array`

License

See original packages used in v1:

Differences with v1:

fix cylinder orientation and uvs
fix icosphere uvs (based on: https://github.com/mourner/icomesh)
uniformise api and internal names
use options object
remove gl-matrix/pex-math and icosphere dependencies
use only trigonometric operation, no matrix transformation
base sphere on ellispsoid
add cone based on cylinder
use flat typed arrays
add jsdoc, prettier, eslint via snowdev

MIT. See license file.