Request: Named Colors

Open
#389 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Domain
api

Research direction

Start by reviewing how Colors and Viewpoints are defined in the BCF-API specification, then compare the requested optional color names and color-schema name with the related Viewpoints should have names issue (#388). Done means the API request is resolved for both the BCF-API and BCF-XML concerns, with the intended naming scope documented.

Written by the indexing model from the issue text.

Description

Coloring in Viewpoints is usually not applied just for fancy looks, but as indicators. For example, walls may be colored by type, or by clash results. Rooms may be colored by purpose, or by renter, etc.
It is currently not possible to have this kind of semantic information in BCF. I think an optional Name property on Colors would be a valuable addition.

Additional to this, it would be nice to not only have names for each color, but also one for the entire color schema, to indicate the purpose of the coloring. This purpose would mostly be identical with the purpose of the Viewpoint, which is one more reason why Viewpoints should have names, too.

This request is obviously also for BCF-XML, but I wasn't sure if I should duplicate the issue.

Dominant language
No language data
Stars
238
Forks
67
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from buildingSMART/BCF-API

All issues in buildingSMART/BCF-API

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.