all files / bpmn-js/lib/features/modeling/ BpmnLayouter.js

100% Statements 105/105
100% Branches 105/105
100% Functions 22/22
100% Lines 105/105
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394                                                            733×   733× 733× 733× 733× 733×         733× 449×     733× 489×           733×     116× 81×         652× 101×                         551×     517×         513×   79×           434×   63×         371×   51×           320×             652×   618×   618×                     652×           79× 79×   79×         101×                     101× 49×     52× 11×         41× 14×     27×         21×     15×     14×         938×       116×             68×       181×       79×                                       55×   55×       211×   211×                       19×   19×   19×       77×       79× 79× 79×       79×   79×   79×         79× 13×       66×     66×   66×         13×     13× 11×           13×       11×   11×               31×           66× 27×           39×         36×                 66× 27×                           19×             17×             39×       35×      
import inherits from 'inherits';
 
import {
  assign
} from 'min-dash';
 
import BaseLayouter from 'diagram-js/lib/layout/BaseLayouter';
 
import {
  repairConnection,
  withoutRedundantPoints
} from 'diagram-js/lib/layout/ManhattanLayout';
 
import {
  getMid,
  getOrientation
} from 'diagram-js/lib/layout/LayoutUtil';
 
import {
  isExpanded
} from '../../util/DiUtil';
 
import { is } from '../../util/ModelUtil';
 
 
var BOUNDARY_TO_HOST_THRESHOLD = 40;
 
export default function BpmnLayouter() {}
 
inherits(BpmnLayouter, BaseLayouter);
 
 
BpmnLayouter.prototype.layoutConnection = function(connection, hints) {
  hints = hints || {};
 
  var source = hints.source || connection.source,
      target = hints.target || connection.target,
      waypoints = connection.waypoints,
      start = hints.connectionStart,
      end = hints.connectionEnd;
 
  var manhattanOptions,
      updatedWaypoints;
 
  if (!start) {
    start = getConnectionDocking(waypoints && waypoints[0], source);
  }
 
  if (!end) {
    end = getConnectionDocking(waypoints && waypoints[waypoints.length - 1], target);
  }
 
  // TODO(nikku): support vertical modeling
  // and invert preferredLayouts accordingly
 
  if (is(connection, 'bpmn:Association') ||
      is(connection, 'bpmn:DataAssociation')) {
 
    if (waypoints && !isCompensationAssociation(source, target)) {
      return [].concat([ start ], waypoints.slice(1, -1), [ end ]);
    }
  }
 
  // manhattan layout sequence / message flows
  if (is(connection, 'bpmn:MessageFlow')) {
    manhattanOptions = getMessageFlowManhattanOptions(source, target);
 
  } else
 
 
  // layout all connection between flow elements h:h,
  //
  // except for
  //
  // (1) outgoing of BoundaryEvents -> layout based on attach orientation and target orientation
  // (2) incoming / outgoing of Gateway -> v:h (outgoing), h:v (incoming)
  // (3) loops from / to the same element
  //
  if (is(connection, 'bpmn:SequenceFlow') ||
      isCompensationAssociation(source, target)) {
 
    if (source === target) {
      manhattanOptions = {
        preferredLayouts: [ 'b:l' ]
      };
    } else
 
    if (is(source, 'bpmn:BoundaryEvent')) {
 
      manhattanOptions = {
        preferredLayouts: getBoundaryEventPreferredLayouts(source, target, end)
      };
 
    } else
 
    if (is(source, 'bpmn:Gateway')) {
 
      manhattanOptions = {
        preferredLayouts: [ 'v:h' ]
      };
    } else
 
    if (is(target, 'bpmn:Gateway')) {
 
      manhattanOptions = {
        preferredLayouts: [ 'h:v' ]
      };
    }
 
    else {
      manhattanOptions = {
        preferredLayouts: [ 'h:h' ]
      };
    }
 
  }
 
  if (manhattanOptions) {
 
    manhattanOptions = assign(manhattanOptions, hints);
 
    updatedWaypoints =
      withoutRedundantPoints(
        repairConnection(
          source, target,
          start, end,
          waypoints,
          manhattanOptions
        )
      );
  }
 
  return updatedWaypoints || [ start, end ];
};
 
 
function getAttachOrientation(attachedElement) {
 
  var hostElement = attachedElement.host,
      padding = -10;
 
  return getOrientation(getMid(attachedElement), hostElement, padding);
}
 
 
function getMessageFlowManhattanOptions(source, target) {
  return {
    preferredLayouts: [ 'straight', 'v:v' ],
    preserveDocking: getMessageFlowPreserveDocking(source, target)
  };
}
 
 
function getMessageFlowPreserveDocking(source, target) {
 
  // (1) docking element connected to participant has precedence
 
  if (is(target, 'bpmn:Participant')) {
    return 'source';
  }
 
  if (is(source, 'bpmn:Participant')) {
    return 'target';
  }
 
  // (2) docking element connected to expanded sub-process has precedence
 
  if (isExpandedSubProcess(target)) {
    return 'source';
  }
 
  if (isExpandedSubProcess(source)) {
    return 'target';
  }
 
  // (3) docking event has precedence
 
  if (is(target, 'bpmn:Event')) {
    return 'target';
  }
 
  if (is(source, 'bpmn:Event')) {
    return 'source';
  }
 
  return null;
}
 
 
function getConnectionDocking(point, shape) {
  return point ? (point.original || point) : getMid(shape);
}
 
function isCompensationAssociation(source, target) {
  return is(target, 'bpmn:Activity') &&
         is(source, 'bpmn:BoundaryEvent') &&
         target.businessObject.isForCompensation;
}
 
 
function isExpandedSubProcess(element) {
  return is(element, 'bpmn:SubProcess') && isExpanded(element);
}
 
function isSame(a, b) {
  return a === b;
}
 
function isAnyOrientation(orientation, orientations) {
  return orientations.indexOf(orientation) !== -1;
}
 
var oppositeOrientationMapping = {
  'top': 'bottom',
  'top-right': 'bottom-left',
  'top-left': 'bottom-right',
  'right': 'left',
  'bottom': 'top',
  'bottom-right': 'top-left',
  'bottom-left': 'top-right',
  'left': 'right'
};
 
var orientationDirectionMapping = {
  top: 't',
  right: 'r',
  bottom: 'b',
  left: 'l'
};
 
function getHorizontalOrientation(orientation) {
  var matches = /right|left/.exec(orientation);
 
  return matches && matches[0];
}
 
function getVerticalOrientation(orientation) {
  var matches = /top|bottom/.exec(orientation);
 
  return matches && matches[0];
}
 
function isOppositeOrientation(a, b) {
  return oppositeOrientationMapping[a] === b;
}
 
function isOppositeHorizontalOrientation(a, b) {
  var horizontalOrientation = getHorizontalOrientation(a);
 
  var oppositeHorizontalOrientation = oppositeOrientationMapping[horizontalOrientation];
 
  return b.indexOf(oppositeHorizontalOrientation) !== -1;
}
 
function isOppositeVerticalOrientation(a, b) {
  var verticalOrientation = getVerticalOrientation(a);
 
  var oppositeVerticalOrientation = oppositeOrientationMapping[verticalOrientation];
 
  return b.indexOf(oppositeVerticalOrientation) !== -1;
}
 
function isHorizontalOrientation(orientation) {
  return orientation === 'right' || orientation === 'left';
}
 
function getBoundaryEventPreferredLayouts(source, target, end) {
  var sourceMid = getMid(source),
      targetMid = getMid(target),
      attachOrientation = getAttachOrientation(source),
      sourceLayout,
      targetLayout;
 
  var isLoop = isSame(source.host, target);
 
  var attachedToSide = isAnyOrientation(attachOrientation, [ 'top', 'right', 'bottom', 'left' ]);
 
  var targetOrientation = getOrientation(targetMid, sourceMid, {
    x: source.width / 2 + target.width / 2,
    y: source.height / 2 + target.height / 2
  });
 
  if (isLoop) {
    return getBoundaryEventLoopLayout(attachOrientation, attachedToSide, source, target, end);
  }
 
  // source layout
  sourceLayout = getBoundaryEventSourceLayout(attachOrientation, targetOrientation, attachedToSide);
 
  // target layout
  targetLayout = getBoundaryEventTargetLayout(attachOrientation, targetOrientation, attachedToSide);
 
  return [ sourceLayout + ':' + targetLayout ];
}
 
function getBoundaryEventLoopLayout(attachOrientation, attachedToSide, source, target, end) {
 
  var sourceLayout = orientationDirectionMapping[attachedToSide ? attachOrientation : getVerticalOrientation(attachOrientation)],
      targetLayout;
 
  if (attachedToSide) {
    if (isHorizontalOrientation(attachOrientation)) {
      targetLayout = shouldConnectToSameSide('y', source, target, end) ? 'h' : 'b';
    } else {
      targetLayout = shouldConnectToSameSide('x', source, target, end) ? 'v' : 'l';
    }
  } else {
    targetLayout = 'v';
  }
 
  return [ sourceLayout + ':' + targetLayout ];
}
 
function shouldConnectToSameSide(axis, source, target, end) {
  var threshold = BOUNDARY_TO_HOST_THRESHOLD;
 
  return !(
    areCloseOnAxis(axis, end, target, threshold) ||
    areCloseOnAxis(axis, end, { x: target.x + target.width, y: target.y + target.height }, threshold) ||
    areCloseOnAxis(axis, end, getMid(source), threshold)
  );
}
 
function areCloseOnAxis(axis, a, b, threshold) {
  return Math.abs(a[axis] - b[axis]) < threshold;
}
 
function getBoundaryEventSourceLayout(attachOrientation, targetOrientation, attachedToSide) {
 
  // attached to either top, right, bottom or left side
  if (attachedToSide) {
    return orientationDirectionMapping[attachOrientation];
  }
 
  // attached to either top-right, top-left, bottom-right or bottom-left corner
 
  // same vertical or opposite horizontal orientation
  if (isSame(
    getVerticalOrientation(attachOrientation), getVerticalOrientation(targetOrientation)
  ) || isOppositeOrientation(
    getHorizontalOrientation(attachOrientation), getHorizontalOrientation(targetOrientation)
  )) {
    return orientationDirectionMapping[getVerticalOrientation(attachOrientation)];
  }
 
  // fallback
  return orientationDirectionMapping[getHorizontalOrientation(attachOrientation)];
}
 
function getBoundaryEventTargetLayout(attachOrientation, targetOrientation, attachedToSide) {
 
  // attached to either top, right, bottom or left side
  if (attachedToSide) {
    if (isHorizontalOrientation(attachOrientation)) {
      // orientation is 'right' or 'left'
 
      // opposite horizontal orientation or same orientation
      if (
        isOppositeHorizontalOrientation(attachOrientation, targetOrientation) ||
        isSame(attachOrientation, targetOrientation)
      ) {
        return 'h';
      }
 
      // fallback
      return 'v';
    } else {
      // orientation is 'top' or 'bottom'
 
      // opposite vertical orientation or same orientation
      if (
        isOppositeVerticalOrientation(attachOrientation, targetOrientation) ||
        isSame(attachOrientation, targetOrientation)
      ) {
        return 'v';
      }
 
      // fallback
      return 'h';
    }
  }
  // attached to either top-right, top-left, bottom-right or bottom-left corner
 
  // orientation is 'right', 'left'
  // or same vertical orientation but also 'right' or 'left'
  if (isHorizontalOrientation(targetOrientation) ||
    (isSame(getVerticalOrientation(attachOrientation), getVerticalOrientation(targetOrientation)) &&
      getHorizontalOrientation(targetOrientation))) {
    return 'h';
  } else {
    return 'v';
  }
}