Skip to content

Commit

Permalink
Moves the entity highlighting function to util/util.js
Browse files Browse the repository at this point in the history
Breaks out the code for getting a selector for entities and all their descendants into a generic function
Accounts for circular relations when recursively getting all relation member IDs
  • Loading branch information
quincylvania committed Oct 27, 2018
1 parent 51386e0 commit 1161767
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 30 deletions.
17 changes: 0 additions & 17 deletions modules/ui/entity_highlight.js

This file was deleted.

10 changes: 5 additions & 5 deletions modules/ui/raw_member_editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import { d3combobox as d3_combobox } from '../lib/d3.combobox.js';

import { t } from '../util/locale';
import { actionChangeMember, actionDeleteMember } from '../actions';
import { highlightEntity } from './entity_highlight';
import { modeBrowse, modeSelect } from '../modes';
import { osmEntity } from '../osm';
import { svgIcon } from '../svg';
Expand All @@ -16,7 +15,8 @@ import { uiDisclosure } from './disclosure';
import {
utilDisplayName,
utilDisplayType,
utilNoAuto
utilNoAuto,
utilHighlightEntity
} from '../util';


Expand All @@ -38,7 +38,7 @@ export function uiRawMemberEditor(context) {
context.map().zoomTo(entity);

// highlight the feature in case it wasn't previously on-screen
highlightEntity(context, d.member, true);
utilHighlightEntity(d.id, true, context);
}


Expand Down Expand Up @@ -136,10 +136,10 @@ export function uiRawMemberEditor(context) {

// highlight the member feature in the map while hovering on the list item
d3_select(this).on('mouseover', function() {
highlightEntity(context, d.member, true);
utilHighlightEntity(d.id, true, context);
});
d3_select(this).on('mouseout', function() {
highlightEntity(context, d.member, false);
utilHighlightEntity(d.id, false, context);
});

var label = d3_select(this).append('label')
Expand Down
7 changes: 3 additions & 4 deletions modules/ui/raw_membership_editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@ import {
actionDeleteMember
} from '../actions';

import { highlightEntity } from './entity_highlight';
import { modeSelect } from '../modes';
import { osmEntity, osmRelation } from '../osm';
import { services } from '../services';
import { svgIcon } from '../svg';
import { uiDisclosure } from './disclosure';
import { utilDisplayName, utilNoAuto } from '../util';
import { utilDisplayName, utilNoAuto, utilHighlightEntity } from '../util';


export function uiRawMembershipEditor(context) {
Expand Down Expand Up @@ -177,10 +176,10 @@ export function uiRawMembershipEditor(context) {
enter.each(function(d){
// highlight the relation in the map while hovering on the list item
d3_select(this).on('mouseover', function() {
highlightEntity(context, d.relation, true);
utilHighlightEntity(d.relation.id, true, context);
});
d3_select(this).on('mouseout', function() {
highlightEntity(context, d.relation, false);
utilHighlightEntity(d.relation.id, false, context);
});
});

Expand Down
7 changes: 3 additions & 4 deletions modules/ui/selection_list.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,10 @@ import {
} from 'd3-selection';

import { t } from '../util/locale';
import { highlightEntity } from './entity_highlight';
import { modeSelect } from '../modes';
import { osmEntity } from '../osm';
import { svgIcon } from '../svg';
import { utilDisplayName } from '../util';
import { utilDisplayName, utilHighlightEntity } from '../util';


export function uiSelectionList(context, selectedIDs) {
Expand Down Expand Up @@ -72,10 +71,10 @@ export function uiSelectionList(context, selectedIDs) {
.each(function(d) {
// highlight the feature in the map while hovering on the list item
d3_select(this).on('mouseover', function() {
highlightEntity(context, d, true);
utilHighlightEntity(d.id, true, context);
});
d3_select(this).on('mouseout', function() {
highlightEntity(context, d, false);
utilHighlightEntity(d.id, false, context);
});
});

Expand Down
2 changes: 2 additions & 0 deletions modules/util/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ export { utilDisplayType } from './util';
export { utilEditDistance } from './util';
export { utilEntitySelector } from './util';
export { utilEntityOrMemberSelector } from './util';
export { utilEntityOrDeepMemberSelector } from './util';
export { utilFastMouse } from './util';
export { utilFunctor } from './util';
export { utilGetAllNodes } from './util';
export { utilGetPrototypeOf } from './util';
export { utilGetSetValue } from './get_set_value';
export { utilHashcode } from './util';
export { utilHighlightEntity } from './util';
export { utilIdleWorker } from './idle_worker';
export { utilNoAuto } from './util';
export { utilPrefixCSSProperty } from './util';
Expand Down
33 changes: 33 additions & 0 deletions modules/util/util.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,32 @@ export function utilEntityOrMemberSelector(ids, graph) {
}


export function utilEntityOrDeepMemberSelector(ids, graph) {
var seen = {};
var allIDs = [];
function addEntityAndMembersIfNotYetSeen(id) {
// avoid infinite recursion for circular relations by skipping seen entities
if (seen[id]) return;
// mark the entity as seen
seen[id] = true;
// add the id;
allIDs.push(id);
if (graph.hasEntity(id)) {
var entity = graph.entity(id);
if (entity.type === 'relation' && entity.members) {
entity.members.forEach(function(member){
addEntityAndMembersIfNotYetSeen(member.id);
});
}
}
}
ids.forEach(function(id) {
addEntityAndMembersIfNotYetSeen(id);
});
return utilEntitySelector(allIDs);
}


export function utilGetAllNodes(ids, graph) {
var seen = {};
var nodes = [];
Expand Down Expand Up @@ -282,3 +308,10 @@ export function utilHashcode(str) {
}
return hash;
}

// Adds or removes highlight styling for the specified entity's SVG elements in the map.
export function utilHighlightEntity(id, highlighted, context) {
context.surface()
.selectAll(utilEntityOrDeepMemberSelector([id], context.graph()))
.classed('highlighted', highlighted);
}

0 comments on commit 1161767

Please sign in to comment.