CesiumGS/cesium

Irrelevant error message from `PerInstanceColorAppearance`

Open

#12,107 opened on Aug 2, 2024

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (11,758 stars) (3,324 forks)batch import
category - docgood first issuetype - bug

Description

What happened?

As reported on the forum Adding a GeometryInstance with a RectangleOutlineGeometry to the scene as a Primitive with a default PerInstanceColorAppearance gives the following error:

DeveloperError: Appearance/Geometry mismatch. The appearance requires vertex shader attribute input 'compressedAttributes', which was not computed as part of the Geometry. Use the appearance's vertexFormat property when constructing the geometry.

See this Sandcastle example.

But vertexFormat is not an option for RectangleOutlineGeometry. In this case, the PerInstanceColorAppearance will work as long as it is initialized with the option flat: true. See this updated Sandcastle.

Reproduction steps

  1. Construct a GeometryInstance with a RectangleOutlineGeometry
  2. Add it to the scene with a default PerInstanceColorAppearance

Sandcastle example

https://sandcastle.cesium.com/#c=zZNdS8MwFIb/SuiNLcx09eNC1w1lggiCouCN9SJLjzWYJiVJJ1P2303StXZbvRVvEnLOed+T8zSlUmiDlgw+QKEpEvCB5qBZXeInHwuzgPrzXApDmACVBdEkE5mgXvmFNAUBaG3FjUsvqYAaIgoON/ZEBIVku8U1yBKMWrXp8CsTCBWbKDrv1z60Xne14fYerbbRoJ9eVrYrwa9KlldQKAAdHiYnYzweoWO/HiZjv7tYNHJW62ZjuTU66FwPfJAYo9iiNqBtctOYSi7V9l3nLrQ73GWrDX3DpFvG+DTyjTOxdmh/YXf0L9g11I4admcdyL9C16c2gM6/RVwpVjLDlqAxyfOw537fZrZptX3c1Z73H+1o4GO8NENVFRDlAttT3INqK/1Al11d6BCto2gSjIJUmxWHWcMCoQtWVlIZVCseYhwbKCtOLK94UdN3MJhq7WZ0pWncl6Y5W1ro04FfFVFOtLaZ15rzR/YJWTBLY1u/J+WS5EwUd0tQnKxc2Vsyu22CGOM0tsdhpZGSL4jacf4G

Environment

Browser: Chrome CesiumJS Version: 1.120 Operating System: Windows

Contributor guide

Tech stack
javascript
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of CesiumJS primitives and appearances
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate the PerInstanceColorAppearance and RectangleOutlineGeometry source files to understand why vertexFormat is missing. The current error message is misleading because vertexFormat is not a constructor option for RectangleOutlineGeometry. Consider improving the error message to suggest using flat: true or automatically handling the mismatch. Refer to the linked forum post and sandcastle examples for context.