Skip to content

Commit

Permalink
update to v0.1.8
Browse files Browse the repository at this point in the history
  • Loading branch information
@PointlessUser
PointlessUser committed Jul 10, 2024
1 parent f62d320 commit 7b963dc
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 48 deletions.
60 changes: 30 additions & 30 deletions PLOTDRAW_README.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Plot Draw Mecsimcalc v0.1.7 documentation
# Plot Draw Mecsimcalc v0.1.8 documentation

This library is designed to provide a set of functions for drawing various types of plots, arrows, segments, and shapes using Matplotlib. The functions allow for customized plotting and annotation of graphical elements.

## General

### draw_arrow

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L7C1-L84C78)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L7C1-L84C78)

```python
draw_arrow(
Expand Down Expand Up @@ -52,7 +52,7 @@ Draws an arrow between two points on a plot.

### calculate_midpoint

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L87C1-L121C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L87C1-L121C1)

```python
calculate_midpoint(
Expand Down Expand Up @@ -82,7 +82,7 @@ Calculates the midpoint between two coordinates.

### draw_arc_circumference

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L123C1-L167C22)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L123C1-L167C22)

```python
draw_arc_circumference(
Expand Down Expand Up @@ -116,7 +116,7 @@ Draws an arc of a circumference with a given radius between two angles.

### create_blank_image

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L170C1-L213C14)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L170C1-L213C14)

```python
create_blank_image(
Expand Down Expand Up @@ -146,7 +146,7 @@ Creates a blank image with specified width and height, displaying a grid.

### draw_three_axes

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L216C1-L343C14)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L216C1-L343C14)

```python
draw_three_axes(
Expand Down Expand Up @@ -184,7 +184,7 @@ Draws a set of three axes (x, y, z) with optional negative directions for x and

### draw_two_inclined_axes

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L346C1-L460C14)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L346C1-L460C14)

```python
draw_two_inclined_axes(
Expand Down Expand Up @@ -224,7 +224,7 @@ Draws two inclined axes (x and y) with optional negative directions.

### plot_segment_pixels

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L463C1-L549C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L463C1-L549C1)

```python
plot_segment_pixels(
Expand Down Expand Up @@ -270,7 +270,7 @@ Plots a line segment between two points and adds a label at the end point.

### plot_annotate_arrow

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L551C1-L699C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L551C1-L699C1)

```python
plot_annotate_arrow(
Expand Down Expand Up @@ -329,7 +329,7 @@ Plots an annotated arrow starting from a given point and extending in a given di

### draw_custom_arrow

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L700C1-L785C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L700C1-L785C1)

```python
draw_custom_arrow(
Expand Down Expand Up @@ -376,7 +376,7 @@ Draws a custom arrow from a start point to another point on a given axis, using

### calculate_arrow_endpoint_pixels

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L787C1-L823C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L787C1-L823C1)

```python
calculate_arrow_endpoint_pixels(
Expand Down Expand Up @@ -407,7 +407,7 @@ Calculates the end point of an arrow in pixel coordinates.

### plot_segment

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L825C1-L911C21)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L825C1-L911C21)

```python
plot_segment(
Expand Down Expand Up @@ -452,7 +452,7 @@ Plots a line segment starting from a given point with a specific angle and lengt

### plot_segment_dashed

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L914C1-L1001C21)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L914C1-L1001C21)

```python
plot_segment_dashed(
Expand Down Expand Up @@ -501,7 +501,7 @@ Plots a dashed line segment starting from a given point with a specific angle an

### draw_custom_circle

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L1004C1-L1041C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L1004C1-L1041C1)

```python
draw_custom_circle(
Expand Down Expand Up @@ -536,7 +536,7 @@ Draws a custom circle on a given axis.

### draw_rounded_rectangle

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L1042C1-L1120C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L1042C1-L1120C1)

```python
draw_rounded_rectangle(
Expand Down Expand Up @@ -572,7 +572,7 @@ Draws a rounded rectangle with specified properties.

### calculate_intersection_point

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L1122C1-L1178C44)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L1122C1-L1178C44)

```python
calculate_intersection_point(
Expand Down Expand Up @@ -605,7 +605,7 @@ Calculates the intersection point of two lines defined by points and angles.

### draw_segment

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L1181C1-L1229C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L1181C1-L1229C1)

```python
draw_segment(
Expand Down Expand Up @@ -639,7 +639,7 @@ Draws a segment between two points with a specified line width and color.

### plot_annotate_arrow_end

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L1231C1-L1369C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L1231C1-L1369C1)

```python
plot_annotate_arrow_end(
Expand Down Expand Up @@ -695,7 +695,7 @@ Plots an arrow annotation at the end point of a vector.

### draw_arc_with_text

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L1371C1-L1430C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L1371C1-L1430C1)

```python
draw_arc_with_text(
Expand Down Expand Up @@ -733,7 +733,7 @@ Draws an arc with text annotation.

### draw_three_axes_rotated

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L1431C1-L1566C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L1431C1-L1566C1)

```python
draw_three_axes_rotated(
Expand Down Expand Up @@ -771,7 +771,7 @@ Draws three rotated axes in a 3D coordinate system.

### draw_double_arrowhead

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L1568C1-L1639C6)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L1568C1-L1639C6)

```python
draw_double_arrowhead(
Expand Down Expand Up @@ -805,7 +805,7 @@ Draws a double arrowhead between two points.

### draw_custom_arrow_end

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L1642C1-L1705C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L1642C1-L1705C1)

```python
draw_custom_arrow_end(
Expand Down Expand Up @@ -839,7 +839,7 @@ Draws a custom arrow at the end of a line segment.

### draw_two_axes

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L1706C1-L1815C14)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L1706C1-L1815C14)

```python
draw_two_axes(
Expand Down Expand Up @@ -877,7 +877,7 @@ Draws two axes representing the x and y directions.

### vertical_arrow_rain

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L1818C1-L1864C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L1818C1-L1864C1)

```python
vertical_arrow_rain(
Expand Down Expand Up @@ -911,7 +911,7 @@ Draws a specific quantity of arrows from equidistant points on a segment that ex

### draw_rain_arrows_horizontal

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L1865C1-L1918C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L1865C1-L1918C1)

```python
draw_rain_arrows_horizontal(
Expand Down Expand Up @@ -947,7 +947,7 @@ Draws a specific quantity of arrows from a vertical line at x_origin to equidist

### calculate_angle

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L1919C1-L1954C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L1919C1-L1954C1)

```python
calculate_angle(
Expand Down Expand Up @@ -976,7 +976,7 @@ Calculates the angle (in degrees) between two points.

### draw_segment_1

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L1955C1-L1979C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L1955C1-L1979C1)

```python
draw_segment_1(
Expand Down Expand Up @@ -1006,7 +1006,7 @@ Draws a line segment in black ('k').

### draw_segment_2

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L1981C1-L2004C64)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L1981C1-L2004C64)

```python
draw_segment_2(
Expand Down Expand Up @@ -1038,7 +1038,7 @@ Draws a line segment in red ('r').

### draw_segment_3

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L2007C1-L2031C1)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L2007C1-L2031C1)

```python
draw_segment_3(
Expand Down Expand Up @@ -1068,7 +1068,7 @@ Draws a line segment in blue ('b').

### get_arc_points

[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.7/mecsimcalc/eng130/plot_draw.py#L2033C1-L2074C16)
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.1.8/mecsimcalc/eng130/plot_draw.py#L2033C1-L2074C16)

```python
get_arc_points(
Expand Down
Loading

0 comments on commit 7b963dc

Please sign in to comment.