Simple API

[brollb]

The autorouter's api is rather clumsy and should be redesigned. This should make designing/debugging projects using it easier.

[brollb]

Current API

• clear
• destroy -- Probably not needed
• getPortId -- Probably not needed (as public)
• addBox(size)
  • boxObject
• getBoxRect(boxId)
• setBoxRect(boxObject, size)
• move(box, details)
• remove(item -- box or path)
• setComponent(pBoxObj, chBoxObj) -- Should probably be renamed
• addPort(boxObject, portInfo)
  • addPort(boxObject, portInfo)
• updatePort(boxObject, portInfo)
• removePort(port)
• addPath(params)
  • return pathId
• getPathPoints(pathId)
• setPathCustomPoints({path: id, points: [[x, y], [x2, xy], ... ]})
• routeSync
• routeAsync(options)
• setMinimumGap(min) -- Probably not needed

Currently Used API (by the webgme)

• routeAsync
• clear
• addPath
• setPathCustomPoints
• getPathPoints
• addBox
• setBoxRect
• setComponent
• remove
• move
• updatePort
• removePort

Unused (by the webgme)

• destroy -- Probably not needed
• getPortId -- Probably not needed (as public)
• getBoxRect
• addPort

Proposed API

Object Creation and Methods

• clear
• setBox(id, rect) // To create/resize/move
  • setBox('myBox', {x1, x2, y1, y2}) // To remove Should I do it this way???
  • setBox(id, null) // To remove Should I do it this way???
  • return the new box or null (if removed)
• setDependentBox(parentId, childId)
• setPort(boxId, portId, area)
  • setPort('box-10', 'north', [[x1, y1], [x2, y2]]) // Create/update
  • setPort('box-10', 'north', null) // removal
  • return the port object
• setPath(pathId, srcBoxId, dstBoxId) // create/update
  • setPath(pathId, null) // remove
  • return a path object: {id: pathId, points: [], raw: ARPath}
• setCustomRouting(pathId, [[x, y], [x, y], ...]) // custom path
  • setCustomRouting(pathId, null) // autorouted
• routeSync
• routeAsync(options)

  Getters

• box(id) // Return copies of the wrappers
  • {id: id, rect: {x: x, width: width, y: y, height: height}},
• port(boxId, id)
  • {id: id, rect: {x: x, width: width, y: y, height: height}},
• path(id)
  • {id: id, points: [[x, y], [x, y], ...]},
• boxes()
  • [id, id, id]
• ports(boxId)
  • [id, id, id]
• paths()
  • [id, id, id]