Mark

check-mark

check-mark(
style: style,
) -> bool 

Checks if a mark should be drawn according to the current style.

style:

style

The current style.

process-style

process-style(
ctx: context,style: style,root: str,path-length: float,
) 

Processes the mark styling. TODO: remember what is actually going on here.

ctx:

context

The context object.

style:

style

The current style.

root:

str

Where the mark is being placed, normally either "start" or "end". Allows different styling for marks in different directions.

path-length:

float

The length of the path. This is used for relative offsets.

place-mark-on-path

place-mark-on-path(
ctx: context,styles: style,segments: drawable,is-end: bool,
) -> dictionary 

Places a mark on the given path. Returns a dictionary with the following keys:

drawables:

drawable

The mark drawables.

distance:

float

The length to shorten the path by.

pos:

float

The position of the mark, can be used to snap the end of the path to after shortening.

---

ctx:

context

The canvas context object.

styles:

style

A processed mark styling.

segments:

drawable

The path to place the mark on.

is-end:

bool

Default: false

TODO

place-marks-along-path

place-marks-along-path(
ctx: context,style: style,transform: matrix,path: drawable,add-path: bool,
) -> array 

Places marks along a path. Returns them as an array of drawable.

ctx:

context

The context object.

style:

style

The current mark styling.

transform:

matrix

The current transformation matrix.

path:

drawable

The path to place the marks on.

add-path:

bool

Default: true

When true the shortened path will returned as the first drawable in the array