virtual_knitting_machine.visualizer.visualizer_elements.diagram_elements.carrier_triangle module

Module containing the Carrier Triangle class

class Carrier_Triangle(carrier, needle_box, diagram_settings, **shape_kwargs)[source]

Bases: Triangle_Element

Wrapper for the SVG element that represents carriers as downward pointed triangles aligned above the needle bed.

__init__(carrier, needle_box, diagram_settings, **shape_kwargs)[source]

Parameters:

carrier (Yarn_Carrier) – The carrier represented by this element.
needle_box (Needle_Box | float) – The needle box to get the x-coordinate from or an x-coordinate.
diagram_settings (Diagram_Settings) – The diagram settings used to draw the carrier.
**shape_kwargs (Any) – Keyword arguments used to draw the carrier triangle.

property carrier_id: int: Returns: int: The id of the carrier that this represents.

property carrier: Yarn_Carrier_State: Returns: Yarn_Carrier_State: The carrier represented by this element.

__getitem__(item)

Parameters:: item (int) – The index of the polygon vertice to return.
Returns:: The coordinate of the indexed vertice.
Return type:: tuple[float, float]
Raises:: KeyError – If the index is out of bounds.

__len__()

Returns:: The number of vertices in the polygon.
Return type:: int

add_to_drawing(drawing)

Adds this element to the given svg drawing. :param drawing: The drawing to add. :type drawing: Drawing

property bottom_vertex: tuple[float, float]: Returns: tuple[float, float]: The bottom vertex of the equilateral triangle pointing downward.

static darken_color(color='none', factor=0.7)

Darken a hex or named color.

Parameters:

color (str) – The color to darken. Either a named color or a hex representation of the color.
factor (float, optional) –
A factor to darken. Defaults to 0.7.
- 0.0 = No change.
- 1.0 = black.

Returns:

The color-string of the darkened color. If “none” color is given, this will return “black”.

Return type:

str

static fill_from_stroke(stroke, lighten_factor=0.3)

Parameters:

stroke (str) – The color string of the stroke to be lightened for infill.
lighten_factor (float, optional) – The factor to lighten the stroke color by. Defaults to 0.3.

Returns:

The fill color string created by lightening the stroke color.

Return type:

str

property global_points: list[tuple[float, float]]: Returns: list[tuple[float, float]]: The global coordinates of the polygon vertices.

property global_x: float: Returns: float: The global x coordinate of this element based on its parent’s coordinates.

global_x_position(x)

Parameters:: x (float) – An X-coordinate position relative to this element’s coordinate system.
Returns:: The x-coordinate adjusted to the global coordinate system.
Return type:: float

property global_y: float: Returns: float: The global y coordinate of this element based on its parent’s coordinates.

global_y_position(y)

Parameters:: y (float) – An Y-coordinate position relative to this element’s coordinate system.
Returns:: The y-coordinate adjusted to the global coordinate system.
Return type:: float

property height: float: Returns: float: The height of the equilateral triangle.

static lighten_color(color='none', factor=0.3)

Lighten a hex or named color.

Parameters:

color (str, optional) – The color to lighten. Either a named color or a hex representation of the color. Defaults to transparent (“none”).
factor (float, optional) –
A factor to lighten (0.0 to 1.0). Defaults to 0.3.
- 0.0 = no change.
- 1.0 = white.

Returns:

The color-string of the lightened color. If “none” color is given, this will return “black”.

Return type:

str

property name: str: Returns: str: The unique name of this element. This will match the id of the svg element being wrapped.

static stroke_from_fill(fill, darken_factor=0.7)

Parameters:

fill (str) – The color string of the fill to be darkened for an outline.
darken_factor (float, optional) – The factor to darken the fill color by. Defaults to 0.7.

Returns:

The stroke color string created by darkening the fill color.

Return type:

str

property top_left_vertex: tuple[float, float]: Returns: tuple[float, float]: The top left vertex of the equilateral triangle pointing downward.

property top_right_vertex: tuple[float, float]: Returns: tuple[float, float]: The top right vertex of the equilateral triangle pointing downward.

property x: float: Returns: float: The x coordinate of this element relative to its parent (or globally).

property x_coordinates: list[float]: Returns: list[float]: The x coordinate values for each vertex in the polygon.

property y: float: Returns: float: The y coordinate of this element relative to its parent (or globally).

property y_coordinates: list[float]: Returns: list[float]: The y coordinate values for each vertex in the polygon.