Agent names provided in DisplayData were not being saved out as the agent name in the type mapping, and so the raw type name in the spatial data was being displayed in the left panel of the viewer.
Display names are useful to, for example, display the same name for agents that have different geometry (which we need to do for ipub).
Solution
Fixed AgentData.get_type_ids_and_mapping() so that it uses the name in the display data, this method is called whenever a .simularium file is saved out.
Type of change
Bug fix (non-breaking change which fixes an issue)
This change requires updated or new tests
Change summary:
use display name when creating type mapping in AgentData
fix another bug with display names that was revealed in PhysicellConverter after fixing
Time estimate or Size
small, 5 min
Problem
Agent names provided in
DisplayDatawere not being saved out as the agent name in the type mapping, and so the raw type name in the spatial data was being displayed in the left panel of the viewer.Display names are useful to, for example, display the same name for agents that have different geometry (which we need to do for ipub).
Solution
Fixed
AgentData.get_type_ids_and_mapping()so that it uses the name in the display data, this method is called whenever a .simularium file is saved out.Type of change
Change summary:
AgentDataPhysicellConverterafter fixingAgentDatafix