mark behaviors that could be configurable

Author: g-harel

internal/animate/interpolate.ts

@@ -1,7 +1,8 @@
 import {Shape} from "../types";
 import {split, splitLine, mod} from "../util";
 
-// TODO percentage > 1
+// TODO allow percentage > 1
+// OPT? loop
 
 const interpolateAngle = (percentage: number, a: number, b: number): number => {
     const tau = Math.PI * 2;

internal/animate/prepare.ts

@@ -11,6 +11,7 @@ import {
 } from "../util";
 import {Point, Shape} from "../types";
 
+// OPT extract optimization logic
 const optimizeOrder = (a: Shape, b: Shape): Shape => {
     const count = a.length;
 
@@ -38,6 +39,7 @@ const optimizeOrder = (a: Shape, b: Shape): Shape => {
     return shift(minOffset, minShape);
 };
 
+// OPT allow extra division
 export const divideShape = (count: number, points: Shape): Shape => {
     if (points.length < 3) throw new Error("not enough points");
     if (count < points.length) throw new Error("cannot remove points");
@@ -62,6 +64,7 @@ export const divideShape = (count: number, points: Shape): Shape => {
     return out;
 };
 
+// OPT disable
 const fixAnglesWith = (fixee: Shape, fixer: Shape): Shape => {
     const out: Shape = [];
     for (let i = 0; i < fixee.length; i++) {
@@ -79,6 +82,7 @@ const fixAnglesWith = (fixee: Shape, fixer: Shape): Shape => {
     return out;
 };
 
+// OPT disable
 const fixAnglesSelf = (shape: Shape): Shape => {
     const out: Shape = [];
     for (let i = 0; i < shape.length; i++) {

internal/render/canvas.ts

@@ -31,6 +31,7 @@ const drawPoint = (ctx: CanvasRenderingContext2D, p: Coord, style: string) => {
     ctx.fillStyle = backupFillStyle;
 };
 
+// OPT draw cutout
 export const drawShape = (ctx: CanvasRenderingContext2D, debug: boolean, shape: Shape) => {
     if (shape.length < 2) throw new Error("not enough points");
 

internal/render/svg.ts

@@ -24,6 +24,8 @@ export interface RenderOptions {
     boundingBox?: boolean;
 }
 
+// OPT render path only
+
 // Renders a shape made up of the input points to an editable data structure
 // which can be rendered to svg.
 export const renderEditable = (points: Shape, opt: RenderOptions): XmlElement => {

internal/types.ts

@@ -11,6 +11,7 @@ export interface Handle {
     length: number;
 }
 
+// TODO? use four coord instead of angles
 export interface Point extends Coord {
     // Cubic bezier handles.
     handleIn: Handle;