archive-gh-me/AgentMaps
1
0
Fork 0
mirror of https://github.com/noncomputable/AgentMaps.git synced 2026-01-25 16:46:38 +00:00
Code Issues Projects Releases Wiki Activity

Removed useless function from buildings.js, fixed comments and var names elsewhere

Browse Source
This commit is contained in:
noncomputable 2018-07-07 18:00:08 -04:00
parent 20eb875052
commit 8317de9263
2 changed files with 32 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/agentmap.js
View File

@ -142,9 +142,9 @@ Agentmap.prototype.getUnitDoor = function(unit_id) {
}
let unit_spec = unit.getLatLngs()[0],
side_a = unit_spec[0],
side_b = unit_spec[1],
door = L.latLngBounds(side_a, side_b).getCenter();
corner_a = unit_spec[0],
corner_b = unit_spec[1],
door = L.latLngBounds(corner_a, corner_b).getCenter();
return door;
};
@ -168,22 +168,22 @@ Agentmap.prototype.getStreetNearDoor = function(unit_id) {
return street_point;
};
/**
* Given a point on a street, find the nearest intersection on that street (with any other street).
*
* @param {LatLng} lat_lng - The coordinates of the point on the street to search from.
* @param {Place} place - A place object corresponding to the street.
* @returns {LatLng} - The coordinates of the nearest intersection.
*/
Agentmap.prototype.getNearestIntersection = function(lat_lng, place) {
let coordinates,
street_id,
let street_id,
street_feature;
if (place.unit) {
coordinates = this.getStreetNearDoor(place.unit),
unit = this.units.getLayer(place.unit),
street_id = unit.street_id;
}
else if (place.street) {
coordinates = lat_lng,
if (place.street) {
street_id = place.street;
}
else {
throw new Error("place must be a unit or a street!");
throw new Error("place must be a street!");
}
street_feature = this.streets.getLayer(street_id).toGeoJSON();

54
src/buildings.js
View File

@ -13,14 +13,14 @@ var Agentmap = require('./agentmap').Agentmap;
* @property {object} properties - Non-geometric properties describing the map feature.
* @property {object} geometry - Specification of the feature's geometry.
* @property {string} geometry.type - The feature's GeoJSON geometry type
* @property {ray} geometry.coordinates - The coordinates specifying the feature's geometry.
* @property {Array} geometry.coordinates - The coordinates specifying the feature's geometry.
* @see {@link http://geojson.org/}
*/
/**
* Generate and setup the desired map features (e.g. streets, houses).
*
* @param {ray.<ray.<number>>} bounding_box - The map's top-left and bottom-right coordinates.
* @param {Array.<Array.<number>>} bounding_box - The map's top-left and bottom-right coordinates.
* @param {object} OSM_data - A GeoJSON Feature Collection object containing the OSM features inside the bounding box.
* @param {string} OSM_data_URL - URL from which to download equivalent OSM_data.
*/
@ -115,7 +115,7 @@ function buildingify(bounding_box, OSM_data, OSM_data_URL) {
* Get all appropriate units within the desired bounding box.
*
* @param {Object} OSM_data - A GeoJSON Feature Collection object containing the OSM features inside the bounding box.
* @returns {ray<Feature>} - array of features representing real estate units.
* @returns {Array<Feature>} - array of features representing real estate units.
*/
function getUnitFeatures(OSM_data, bounding_box) {
let proposed_unit_features = [];
@ -137,7 +137,7 @@ function getUnitFeatures(OSM_data, bounding_box) {
* Get all streets from the GeoJSON data.
*
* @param {Object} OSM_data - A GeoJSON Feature Collection object containing the OSM streets inside the bounding box.
* @returns {ray<Feature>} - array of street features.
* @returns {Array<Feature>} - array of street features.
*/
function getStreetFeatures(OSM_data) {
let street_features = [];
@ -159,10 +159,10 @@ function getStreetFeatures(OSM_data) {
* Given two anchors, find four nearby points on either side
* of the street appropriate to build a unit(s) on.
*
* @param {ray<ray<Feature>>} unit_anchors - array of pairs of points around which to anchor units along a street.
* @param {ray<Feature>} proposed_unit_features - array of features representing real estate units already proposed for construction.
* @param {Array<Array<Feature>>} unit_anchors - array of pairs of points around which to anchor units along a street.
* @param {Array<Feature>} proposed_unit_features - array of features representing real estate units already proposed for construction.
* @param {string} street_feature_id - The Leaflet layer ID of the street feature along which the unit is being constructed..
* @returns {ray<Feature>} unit_features - array of features representing real estate units.
* @returns {Array<Feature>} unit_features - array of features representing real estate units.
*/
function generateUnitFeatures(unit_anchors, proposed_unit_features, street_feature_id) {
//One sub-array of unit features for each side of the road.
@ -255,7 +255,7 @@ function generateUnitFeatures(unit_anchors, proposed_unit_features, street_featu
* and end points along the street from which units may be constructed.
*
* @param {Feature} street_feature - A GeoJSON feature object representing a street.
* @returns {ray<ray<Feature>>} - array of pairs of points around which to anchor units along a street.
* @returns {Array<Array<Feature>>} - array of pairs of points around which to anchor units along a street.
*/
function getUnitAnchors(street_feature, bounding_box) {
let unit_anchors = [],
@ -288,9 +288,9 @@ function getUnitAnchors(street_feature, bounding_box) {
/**
* Get an array of units excluding units that overlap with streets.
*
* @param {ray<Feature>} unit_features - ray of features representing units.
* @param {ray<Layer>} street_layers - ray of Leaflet layers representing streets.
* @returns {ray<Feature>} - unit_features, but with all units that intersect any streets removed.
* @param {Array<Feature>} unit_features - ray of features representing units.
* @param {Array<Layer>} street_layers - ray of Leaflet layers representing streets.
* @returns {Array<Feature>} - unit_features, but with all units that intersect any streets removed.
*/
function unitsOutOfStreets(unit_features, street_layers) {
let processed_unit_features = unit_features.slice();
@ -315,7 +315,7 @@ function unitsOutOfStreets(unit_features, street_layers) {
* Check whether a polygon overlaps with any member of an array of polygons.
*
* @param {Feature} polygon_feature - A geoJSON polygon feature.
* @param {ray<Feature>} polygon_feature_array - array of geoJSON polygon features.
* @param {Array<Feature>} polygon_feature_array - array of geoJSON polygon features.
* @returns {boolean} - Whether the polygon_feature overlaps with any one in the array.
*/
function noOverlaps(reference_polygon_feature, polygon_feature_array) {
@ -339,8 +339,8 @@ function noOverlaps(reference_polygon_feature, polygon_feature_array) {
* methods expect Leaflet's latLng pairs and won't auto-reverse, so we have to do that
* manually if we're preprocessing the GeoJSON data before passing it to L.geoJSON.
*
* @param {ray<number|ray<number|ray<number>>>} coordinates - GeoJSON coordinates for a point, (multi-)line, or (multi-)polygon.
* @returns {ray<number|ray<number|ray<number>>>} - Reversed geoJSON coordinates for a point, (multi-)line, or (multi-)polygon.
* @param {Array<number|Array<number|Array<number>>>} coordinates - GeoJSON coordinates for a point, (multi-)line, or (multi-)polygon.
* @returns {Array<number|Array<number|Array<number>>>} - Reversed geoJSON coordinates for a point, (multi-)line, or (multi-)polygon.
*/
function reversedCoordinates(coordinates) {
let reversed = coordinates.slice();
@ -357,9 +357,9 @@ function reversedCoordinates(coordinates) {
}
/**
* Given an array, check whether it can be the coordinates of a point.
* Given an array, check whether it can represent the coordinates of a point.
*
* @param {ray} array - array to check.
* @param {Array} array - Array to check.
* @returns {boolean} - Whether the array can be the coordinates of a point.
*/
function isPointCoordinates(array) {
@ -376,11 +376,12 @@ function isPointCoordinates(array) {
* Given either a GeoJSON feature, L.latLng, or coordinate array containing the coordinates of a point,
* return an array of the coordinates.
*
* @params {Point|ray<number>|LatLng} point - The data containing the point's coordinates (latitude & longitude).
* @returns {ray<number>} - array of the point's coordinates. I.e.: [lng, lat].
* @params {Point|Array<number>|LatLng} point - The data containing the point's coordinates (latitude & longitude).
* @returns {Array<number>} - Array of the point's coordinates. I.e.: [lng, lat].
*/
function pointToCoordinateArray(point) {
let coordinate_array;
if (typeof(point.lat) === "number" && typeof(point.lng) === "number") {
coordinate_array = [point.lng, point.lat];
}
@ -397,22 +398,6 @@ function pointToCoordinateArray(point) {
return coordinate_array;
}
/**
* Given an array of coordinate arrays, get their intersection.
*/
function getIntersections(array_array) {
let reference = array_array[0];
for (let array of array_array.slice(1)) {
if (isCoordinateray(array)) {
throw new Error("l elements of the array must be coordinate arrays.");
}
reference = getIntersection(reference, array);
}
return reference;
}
/**
* Given two coordinate arrays, get their intersection.
*
@ -462,7 +447,6 @@ function getIntersection(arr_a, arr_b, with_indices = []) {
Agentmap.prototype.buildingify = buildingify;
exports.getIntersection = getIntersection;
exports.getIntersections = getIntersections;
exports.reversedCoordinates = reversedCoordinates;
exports.isPointCoordinates = isPointCoordinates;
exports.pointToCoordinateArray = pointToCoordinateArray;