{"id":20767778,"url":"https://github.com/dmnsgn/primitive-ellipsoid","last_synced_at":"2025-06-30T11:39:19.072Z","repository":{"id":32982004,"uuid":"148654121","full_name":"dmnsgn/primitive-ellipsoid","owner":"dmnsgn","description":"An ellipsoid geometry for 3D rendering, including normals, UVs and cell indices (faces).","archived":false,"fork":false,"pushed_at":"2024-07-07T15:44:10.000Z","size":11175,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-20T22:32:52.705Z","etag":null,"topics":["ellipsoid","geometry","gl","glsl","mesh","primitive","simplicial-complex","stackgl","webgl"],"latest_commit_sha":null,"homepage":"https://dmnsgn.github.io/primitive-ellipsoid/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dmnsgn.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-13T14:55:19.000Z","updated_at":"2024-07-07T15:35:31.000Z","dependencies_parsed_at":"2024-07-07T17:11:18.124Z","dependency_job_id":null,"html_url":"https://github.com/dmnsgn/primitive-ellipsoid","commit_stats":{"total_commits":11,"total_committers":1,"mean_commits":11.0,"dds":0.0,"last_synced_commit":"f0b65bdad1d02244310777f84db6df4585dfa499"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmnsgn%2Fprimitive-ellipsoid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmnsgn%2Fprimitive-ellipsoid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmnsgn%2Fprimitive-ellipsoid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmnsgn%2Fprimitive-ellipsoid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dmnsgn","download_url":"https://codeload.github.com/dmnsgn/primitive-ellipsoid/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251689011,"owners_count":21627817,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ellipsoid","geometry","gl","glsl","mesh","primitive","simplicial-complex","stackgl","webgl"],"created_at":"2024-11-17T11:33:22.836Z","updated_at":"2025-04-30T11:22:33.278Z","avatar_url":"https://github.com/dmnsgn.png","language":"JavaScript","funding_links":["https://paypal.me/dmnsgn"],"categories":[],"sub_categories":[],"readme":"# primitive-ellipsoid\n\n[![npm version](https://img.shields.io/npm/v/primitive-ellipsoid)](https://www.npmjs.com/package/primitive-ellipsoid)\n[![stability-stable](https://img.shields.io/badge/stability-stable-green.svg)](https://www.npmjs.com/package/primitive-ellipsoid)\n[![npm minzipped size](https://img.shields.io/bundlephobia/minzip/primitive-ellipsoid)](https://bundlephobia.com/package/primitive-ellipsoid)\n[![dependencies](https://img.shields.io/librariesio/release/npm/primitive-ellipsoid)](https://github.com/dmnsgn/primitive-ellipsoid/blob/main/package.json)\n[![types](https://img.shields.io/npm/types/primitive-ellipsoid)](https://github.com/microsoft/TypeScript)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-fa6673.svg)](https://conventionalcommits.org)\n[![styled with prettier](https://img.shields.io/badge/styled_with-Prettier-f8bc45.svg?logo=prettier)](https://github.com/prettier/prettier)\n[![linted with eslint](https://img.shields.io/badge/linted_with-ES_Lint-4B32C3.svg?logo=eslint)](https://github.com/eslint/eslint)\n[![license](https://img.shields.io/github/license/dmnsgn/primitive-ellipsoid)](https://github.com/dmnsgn/primitive-ellipsoid/blob/main/LICENSE.md)\n\nAn ellipsoid geometry for 3D rendering, including normals, UVs and cell indices (faces).\n\n[![paypal](https://img.shields.io/badge/donate-paypal-informational?logo=paypal)](https://paypal.me/dmnsgn)\n[![coinbase](https://img.shields.io/badge/donate-coinbase-informational?logo=coinbase)](https://commerce.coinbase.com/checkout/56cbdf28-e323-48d8-9c98-7019e72c97f3)\n[![twitter](https://img.shields.io/twitter/follow/dmnsgn?style=social)](https://twitter.com/dmnsgn)\n\n![](https://raw.githubusercontent.com/dmnsgn/primitive-ellipsoid/main/screenshot.gif)\n\n## Installation\n\n```bash\nnpm install primitive-ellipsoid\n```\n\n## Usage\n\n```js\nimport createEllipsoid from \"primitive-ellipsoid\";\n\nconst radius = 1;\nconst geometry = createEllipsoid(radius, {\n  latSegments: 64,\n  lngSegments: 64,\n  rx: 2,\n  ry: 1,\n  rz: 1,\n});\n\nconsole.log(geometry);\n// {\n//   positions: [ [x, y, z], [x, y, z], ... ],\n//   cells: [ [a, b, c], [a, b, c], ... ],\n//   uvs: [ [u, v], [u, v], ... ],\n//   normals: [ [x, y, z], [x, y, z], ... ]\n// }\n```\n\n## API\n\n\u003c!-- api-start --\u003e\n\n## Functions\n\n\u003cdl\u003e\n\u003cdt\u003e\u003ca href=\"#createEllipsoid\"\u003ecreateEllipsoid(radius, [options])\u003c/a\u003e ⇒ \u003ccode\u003e\u003ca href=\"#SimplicialComplex\"\u003eSimplicialComplex\u003c/a\u003e\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eAn ellipsoid geometry for 3D rendering, including normals, UVs and cell indices (faces).\u003c/p\u003e\n\u003c/dd\u003e\n\u003c/dl\u003e\n\n## Typedefs\n\n\u003cdl\u003e\n\u003cdt\u003e\u003ca href=\"#vec3\"\u003evec3\u003c/a\u003e : \u003ccode\u003eArray.\u0026lt;number\u0026gt;\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#Options\"\u003eOptions\u003c/a\u003e : \u003ccode\u003eobject\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#SimplicialComplex\"\u003eSimplicialComplex\u003c/a\u003e : \u003ccode\u003eobject\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eGeometry definition.\u003c/p\u003e\n\u003c/dd\u003e\n\u003c/dl\u003e\n\n\u003ca name=\"createEllipsoid\"\u003e\u003c/a\u003e\n\n## createEllipsoid(radius, [options]) ⇒ [\u003ccode\u003eSimplicialComplex\u003c/code\u003e](#SimplicialComplex)\n\nAn ellipsoid geometry for 3D rendering, including normals, UVs and cell indices (faces).\n\n**Kind**: global function\n**See**: [Wolfram MathWorld Ellipsoid](http://mathworld.wolfram.com/Ellipsoid.html)\n\n| Param     | Type                             | Default         | Description |\n| --------- | -------------------------------- | --------------- | ----------- |\n| radius    | \u003ccode\u003enumber\u003c/code\u003e              | \u003ccode\u003e1\u003c/code\u003e  | Base radius |\n| [options] | [\u003ccode\u003eOptions\u003c/code\u003e](#Options) | \u003ccode\u003e{}\u003c/code\u003e |             |\n\n\u003ca name=\"vec3\"\u003e\u003c/a\u003e\n\n## vec3 : \u003ccode\u003eArray.\u0026lt;number\u0026gt;\u003c/code\u003e\n\n**Kind**: global typedef\n\u003ca name=\"Options\"\u003e\u003c/a\u003e\n\n## Options : \u003ccode\u003eobject\u003c/code\u003e\n\n**Kind**: global typedef\n**Properties**\n\n| Name          | Type                | Default         | Description                      |\n| ------------- | ------------------- | --------------- | -------------------------------- |\n| [latSegments] | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e64\u003c/code\u003e | Number of latitudinal segments.  |\n| [lngSegments] | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e64\u003c/code\u003e | Number of longitudinal segments. |\n| [rx]          | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e2\u003c/code\u003e  | Radius in the x direction.       |\n| [ry]          | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e1\u003c/code\u003e  | Radius in the y direction.       |\n| [rz]          | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e1\u003c/code\u003e  | Radius in the z direction.       |\n\n\u003ca name=\"SimplicialComplex\"\u003e\u003c/a\u003e\n\n## SimplicialComplex : \u003ccode\u003eobject\u003c/code\u003e\n\nGeometry definition.\n\n**Kind**: global typedef\n**Properties**\n\n| Name      | Type                                     |\n| --------- | ---------------------------------------- |\n| positions | [\u003ccode\u003eArray.\u0026lt;vec3\u0026gt;\u003c/code\u003e](#vec3) |\n| normals   | [\u003ccode\u003eArray.\u0026lt;vec3\u0026gt;\u003c/code\u003e](#vec3) |\n| uvs       | [\u003ccode\u003eArray.\u0026lt;vec3\u0026gt;\u003c/code\u003e](#vec3) |\n| cells     | [\u003ccode\u003eArray.\u0026lt;vec3\u0026gt;\u003c/code\u003e](#vec3) |\n\n\u003c!-- api-end --\u003e\n\n## License\n\nMIT. See [license file](https://github.com/dmnsgn/primitive-ellipsoid/blob/main/LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmnsgn%2Fprimitive-ellipsoid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdmnsgn%2Fprimitive-ellipsoid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmnsgn%2Fprimitive-ellipsoid/lists"}