ColormapOverlay overlays don't seem to apply to transparent keys

[obra]

I was a little surprised, when testing out the replacement for the Numpad plugin, that setting an overlay on a key that didn't have anything defined on the numpad layer...just didn't light up the key. I'd expect that if I've explicitly defined an overlay, it wouldn't skip lighting up just because there was a transparent key on the keymap.

@EvyBongers - is this an intentional design? I'd love to understand the design intent better.

[EvyBongers]

I don't believe that was intentional. This plugin is one of my first contributions, so I may have simply overlooked something. Will have a look this weekend

[EvyBongers]

I don't do anything in particular to prevent the led from being set if the key isn't assigned. Basically, if an overlay is defined for the given key address on that layer, ::LEDControl.setCrgbAt is called to set the color for that particular key.

Kaleidoscope/plugins/Kaleidoscope-Colormap-Overlay/src/kaleidoscope/plugin/Colormap-Overlay.cpp

Lines 61 to 67 in 2c280dd

	for (auto key_addr : KeyAddr::all()) {
	if (ColormapOverlay::hasOverlay(key_addr)) {
	::LEDControl.setCrgbAt(KeyAddr(key_addr), selectedColor);
	} else {
	::LEDControl.refreshAt(KeyAddr(key_addr));
	}
	}

I think the error I made is that I used Layer.lookupActiveLayer rather than Layer.mostRecent to find the current layer.

Kaleidoscope/plugins/Kaleidoscope-Colormap-Overlay/src/kaleidoscope/plugin/Colormap-Overlay.cpp

Lines 37 to 51 in 2c280dd

	bool ColormapOverlay::hasOverlay(KeyAddr k) {
	uint8_t layer_index = Layer.lookupActiveLayer(k);
	for (uint8_t i{0}; i < overlay_count_; ++i) {
	Overlay overlay = overlays_[i];
	if (overlay.addr == k) {
	if ((overlay.layer == layer_index) ||
	(overlay.layer == layer_wildcard)) {
	selectedColor = ::LEDPaletteTheme.lookupPaletteColor(overlay.palette_index);
	return true;
	}
	}
	}
	return false;
	}

Does that make sense to you?

[EvyBongers]

Now I realize that this behavior may have been intentional, even it if is counterintuitive... My use-case for the overlay plugin is to highlight my layer switches. The way it's currently set up supports lighting up keys in lower layers, provided that higher layers don't have a key assigned (i.e. transparent). I suppose it should be easy enough to add additional logic to check for an assigned color overlay at the top-most layer before falling through to lower layers. I could also add a toggle to enable/disable the option to check for overlays on lower layers.