Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dmnsgn/primitive-octasphere

An octasphere geometry for 3D rendering, including normals, UVs and cell indices (faces).
https://github.com/dmnsgn/primitive-octasphere

geometry gl glsl mesh octasphere primitive simplicial-complex stackgl webgl

Last synced: about 1 month ago
JSON representation

An octasphere geometry for 3D rendering, including normals, UVs and cell indices (faces).

Host: GitHub
URL: https://github.com/dmnsgn/primitive-octasphere
Owner: dmnsgn
License: mit
Created: 2021-06-02T20:12:09.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-07-07T15:49:49.000Z (6 months ago)
Last Synced: 2024-11-29T19:25:18.638Z (about 1 month ago)
Topics: geometry, gl, glsl, mesh, octasphere, primitive, simplicial-complex, stackgl, webgl
Language: JavaScript
Homepage: https://dmnsgn.github.io/primitive-octasphere/
Size: 1.53 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # primitive-octasphere

[![npm version](https://img.shields.io/npm/v/primitive-octasphere)](https://www.npmjs.com/package/primitive-octasphere)

[![stability-stable](https://img.shields.io/badge/stability-stable-green.svg)](https://www.npmjs.com/package/primitive-octasphere)

[![npm minzipped size](https://img.shields.io/bundlephobia/minzip/primitive-octasphere)](https://bundlephobia.com/package/primitive-octasphere)

[![dependencies](https://img.shields.io/librariesio/release/npm/primitive-octasphere)](https://github.com/dmnsgn/primitive-octasphere/blob/main/package.json)

[![types](https://img.shields.io/npm/types/primitive-octasphere)](https://github.com/microsoft/TypeScript)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-fa6673.svg)](https://conventionalcommits.org)

[![styled with prettier](https://img.shields.io/badge/styled_with-Prettier-f8bc45.svg?logo=prettier)](https://github.com/prettier/prettier)

[![linted with eslint](https://img.shields.io/badge/linted_with-ES_Lint-4B32C3.svg?logo=eslint)](https://github.com/eslint/eslint)

[![license](https://img.shields.io/github/license/dmnsgn/primitive-octasphere)](https://github.com/dmnsgn/primitive-octasphere/blob/main/LICENSE.md)

An octasphere geometry for 3D rendering, including normals, UVs and cell indices (faces). Based on [Philip Rideout's article here](https://prideout.net/blog/octasphere/).

[![paypal](https://img.shields.io/badge/donate-paypal-informational?logo=paypal)](https://paypal.me/dmnsgn)

[![coinbase](https://img.shields.io/badge/donate-coinbase-informational?logo=coinbase)](https://commerce.coinbase.com/checkout/56cbdf28-e323-48d8-9c98-7019e72c97f3)

[![twitter](https://img.shields.io/twitter/follow/dmnsgn?style=social)](https://twitter.com/dmnsgn)

![](https://raw.githubusercontent.com/dmnsgn/primitive-octasphere/main/screenshot.gif)

## Installation

```bash

npm install primitive-octasphere

```

## Usage

```js

import createOctasphere from "primitive-octasphere";

const geometry = createOctasphere();

console.log(geometry);

// {

//   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

## Functions





createOctasphere([options]) ⇒ SimplicialComplex





An octasphere geometry for 3D rendering, including normals, UVs and cell indices (faces).





## Typedefs





vec2 : Array.<number>







vec3 : Array.<number>







OctasphereOptions : object







SimplicialComplex : object





Geometry definition.







## createOctasphere([options]) ⇒ [SimplicialComplex](#SimplicialComplex)

An octasphere geometry for 3D rendering, including normals, UVs and cell indices (faces).

**Kind**: global function

| Param     | Type                                                 | Default         |

| --------- | ---------------------------------------------------- | --------------- |

| [options] | [OctasphereOptions](#OctasphereOptions) | {} |



## vec2 : Array.<number>

**Kind**: global typedef



## vec3 : Array.<number>

**Kind**: global typedef



## OctasphereOptions : object

**Kind**: global typedef

**Properties**

| Name           | Type                | Default          |

| -------------- | ------------------- | ---------------- |

| [radius]       | number | 0.5 |

| [subdivisions] | number | 2   |



## SimplicialComplex : object

Geometry definition.

**Kind**: global typedef

**Properties**

| Name      | Type                                     |

| --------- | ---------------------------------------- |

| positions | [Array.<vec3>](#vec3) |

| normals   | [Array.<vec3>](#vec3) |

| uvs       | [Array.<vec2>](#vec2) |

| cells     | [Array.<vec3>](#vec3) |

## License

MIT. See [license file](https://github.com/dmnsgn/primitive-octasphere/blob/main/LICENSE.md).