Skip to content

Latest commit

 

History

History
54 lines (42 loc) · 3.63 KB

README-FEATURES-TEAM2.md

File metadata and controls

54 lines (42 loc) · 3.63 KB
Raw

Implemented Functionality

Smart Custom Symbol Sizing

1) Auto

Given two connected symbols, resize the one selected second to make the port gaps on both symbols equal, and reposition the symbol so wires the are straight. Invoke using menu dropdown (Edit > TestResize).

  • works for all orientations
  • 'works' for all components in the sense that the algorithm is applied for all component, may have some unexpected behaviour for special edge cases
  • does not have expected behaviour if ports are 'tangled', recommended to run Smart Port Reordering before this feature
  • does not check for overlapping with other symbols after resize and reposition
  • minimal error checking done purposefully as this is meant to be manual feature requiring careful user input, for safer but less ambitious cleanup use Smart Beautify

2) Manual

Hold Ctrl near a custom component to highlight its four corners. Drag a corner in any direction to resize or mirror the component. UI implemented to visualise the resize action.

  • component is returned to original position if resizing causes it to overlap with other components

Smart Port Reordering

  • Smart Port Reordering is invoked by key binding CtrlOrCmd+R or menu dropdown (Edit > Sheet > Reorder Ports).
  • Reorders ports such that wire nets do not cross each other.
    • Limitation: Ports may be rearranged even if no nets cross each other.
    • Limitation: Ordering of Ports only work if wires come from one other component.
  • 'Flips' non custom components with two IO ports on an edge (eg. Mux2, Demux2, And, etc.) to minimize wire crossings.
    • Limitation: Flips only work if wires come from one other component.

Smart Beautify

  • Heuristic based algorithm to cleanup the whole sheet is invoked using menu dropdown (Edit > Sheet Beautify) or CtrlOrCmd+B.
  • Applies smart port reordering on 10 pairs of components that require the most swaps.
  • Applies smart size and respositioning to custom components if the operation does not cause symbols to overlap.
    • Limitation: Repositioning may move components too much. Cases which produce undesirable results have not been identified yet.

Smart Channel

  • Features

    • Added selectrion box for vertical and horizontal channels, ususe a toggle button on command on UI
    • Added support for channel routing wires with any number of segments & also added grouping nets together in the channel
    • Reworked framework and added types which are easily expandable for better maintainability or if anyone wants to expand on smart channels in the future

  • Limitations:

    • Will need better visual indication that we are in "make channel" mode - maybe change the selection box to be rendered in a red color
    • Only moves one segment and does not optimise for wire crossings
    • Currently no safety checks are being performed so if you drag a horizontal channel over vertical wire segements, it will fail in an ugly way

Smart Wire

  • Features

    • When routing a wire, it will first try to snap to an existing wire in the same net (if any). Subsequently, it will perform symbol avoidance to ensure no intersections with any symbols.
    • When routing a wire around a symbol that already has existing wires routed around it, there will be additional wire separation added to ensure that only wires from the same net will hug.
    • The snapping to net feature can be toggled with Ctrl+T or from the menu options.

  • Limitations

    • Snapping to net only works for the common case of non-rotated symbols and when input is on the left of the output.
    • Symbol avoidance works for all orientations.
    • Variable wire separation around symbols only work on 1 segment of the wire.