CesiumGS / CesiumGS/cesium

Primitive interface

Open
#8,909 0 comments 3 reactions 0 assignees View on GitHub
category - doc category - graphics category - typescript type - cleanup
Dominant language
JavaScript
Stars
15.7k
Forks
3.9k
Avg merge
4d 6h
Merged PRs (30d)
34

Description

We actually don't have a concrete interface definition for `primitives`, i.e. things we store inside of `PrimitiveCollection`. It's simply documented everywhere as `Object`. What's even worse is that we have a `Primitive` class that renders geometry, but is not the base class or interface for all "primitives". Why we didn't name it `GeometryPrimitive` I'm not sure.

It would be great to clean up our own terminology here and define a base primitive interface so that we can use it in JSDoc and TypeScript.

Contributor guide

Open the contributing guide

Research direction

No files, tests, or entry points are named. Start by tracing the PrimitiveCollection contents and the existing Primitive class, then review how primitives are represented in JSDoc and TypeScript. Done means the terminology is consistent and a shared primitive interface is defined for those usages.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
api
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.