search

phetsims / circuit-construction-kit-common

"Circuit Construction Kit: Basics" is an educational simulation in HTML5, by PhET Interactive Simulations.
GNU General Public License v3.0
10 stars 10 forks source link

Battery carousel icon doesn't need "right" descriptor #853

Closed arouinfar closed 1 year ago

arouinfar commented 2 years ago

The battery in the carousel is view.circuitElementToolbox.circuitElementTools.rightBatteryToolNode. The "right" descriptor appears six places in the tree (3 for each screen).

image

This orientation information doesn't add any value to the tree and carries the implication that there could be a paired "left" battery. For comparison purposes, the high-voltage battery looks like this:

image

@samreid let's remove "right" so it's batteryToolNode and batteryIcon.

samreid commented 2 years ago

It has a "right" descriptor because in an incomplete version of CCK Basics we added batteries facing the opposite way. In light of https://github.com/phetsims/geometric-optics-basics/issues/3#issuecomment-1050287506 do we still want to do this?

arouinfar commented 1 year ago

I'm a bit conflicted. I really do think the "right" descriptor adds a bit of difficulty when scanning the tree for "battery". However, this is mitigated by the Studio select feature. Since there could be a "left" battery in future flavors of CCK, let's leave this as-is so we don't have to introduce API-breaking changes in the future to distinguish the "right" and "left" batteries.