virtual_knitting_machine.visualizer.visualizer_elements.diagram_elements.needle_bed_element module

Module containing the Needle_Bed_Element class

class Needle_Bed_Element(is_front, is_slider, leftmost_needle, rightmost_needle, render_sliders, diagram_setting, machine_state)

Bases: Visualizer_Group

__init__(is_front, is_slider, leftmost_needle, rightmost_needle, render_sliders, diagram_setting, machine_state)

property needle_count: int

Returns: int: The number of needle boxes rendered in the bed.

property all_needle_rack: bool

Returns: bool: True if the machine state is set for all needle rack. False otherwise.

property carriage_direction: Carriage_Pass_Direction

Returns: Carriage_Pass_Direction: The last direction of movement of the carriage.

on_bed(needle)

Parameters:

needle (Needle) – Needle to check if it belongs to this bed.

Returns:

True if this needle belongs to this bed. False otherwise.

Return type:

bool

Notes

This does not check that the needle is rendered within the diagram’s window. Only that it belongs to this bed. For full index checking, use in operator.

index_of_needle(needle)

Parameters:

needle (int | Needle) – The needle or position of a needle to index on this bed.

Returns:

The index of that needle on this bed.

Return type:

int

Raises:

KeyError – If the given needle or position is not being rendered on this bed.

property bed_x_shift: int

Returns: int: The amount to horizontally shift this bed based on its position and all needle racking.

property is_back: bool

Returns: bool: True if this a back bed.

property add_label: bool

Returns: bool: True if this bed should also have labels

property unique_bed_name: str

Returns: str: The unique name of the bed element.

property bed_label: str

Returns: str: The unique name of the bed element.

property bed_row: int

Returns: int: The index of the row that this bed belongs to.

add_child(child)

Add the given child element as a sub element to this element. :param child: The child element to add. :type child: Visualizer_Element

add_to_drawing(drawing)

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

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_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

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 x: float

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

property y: float

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