common_sequence_diagram_io 0.2.0

A generic interface to parse, print and draw interaction languages
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

/*
Copyright 2024 Erwan Mahe (github.com/erwanM974)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

use image::{Rgb, RgbImage};
use imageproc::drawing::draw_line_segment_mut;


// **********


pub struct MessageExchangeLineStyle {
    pub bold : bool,
    pub doubled : bool,
    pub color : Rgb<u8>,
    pub arrowhead_length : f32
}


impl MessageExchangeLineStyle {
    pub fn new(bold : bool,doubled : bool,color : Rgb<u8>,arrowhead_length : f32) -> MessageExchangeLineStyle {
        MessageExchangeLineStyle{
            bold,doubled,color,arrowhead_length
        }
    }
}


pub fn draw_message_exchange_horizontal_arrow(image : &mut RgbImage, x_start : f32, x_end : f32, y_pos : f32, style : &MessageExchangeLineStyle) {
    draw_styled_horizontal_line_mut(image,x_start,x_end,y_pos,style);
    if x_start < x_end {
        draw_arrowhead_rightward(image,x_end,y_pos,style.arrowhead_length,style.color);
    } else {
        draw_arrowhead_leftward(image,x_end,y_pos,style.arrowhead_length,style.color);
    }
}



pub fn draw_styled_horizontal_line_mut(image : &mut RgbImage, x_left : f32, x_right : f32, y_pos : f32, style : &MessageExchangeLineStyle) {
    if style.doubled {
        let doubling_y_shift = if style.bold {
            2.5
        } else {
            1.5
        };
        draw_thick_line_segment_mut(image,
            (x_left, y_pos - doubling_y_shift),
            (x_right, y_pos - doubling_y_shift),
            style.color, 
            style.bold);
        draw_thick_line_segment_mut(image,
            (x_left, y_pos + doubling_y_shift),
            (x_right, y_pos + doubling_y_shift),
            style.color, 
            style.bold);
    } else {
        draw_thick_line_segment_mut(image,
            (x_left, y_pos),
            (x_right, y_pos),
            style.color, 
            style.bold);
    }
}


pub fn draw_styled_vertical_line_mut(image : &mut RgbImage, y_top : f32, y_bot : f32, x_pos : f32, style : &MessageExchangeLineStyle) {
    if style.doubled {
        let doubling_x_shift = if style.bold {
            2.5
        } else {
            1.5
        };
        draw_thick_line_segment_mut(image,
            (x_pos - doubling_x_shift, y_top),
            (x_pos - doubling_x_shift, y_bot),
            style.color, 
            style.bold);
        draw_thick_line_segment_mut(image,
            (x_pos + doubling_x_shift, y_top),
            (x_pos + doubling_x_shift, y_bot),
            style.color, 
            style.bold);
    } else {
        draw_thick_line_segment_mut(image,
            (x_pos, y_top),
            (x_pos, y_bot),
            style.color, 
            style.bold);
    }
}




fn draw_thick_line_segment_mut(image : &mut RgbImage, start: (f32, f32), end: (f32, f32), color: Rgb<u8>, is_thick : bool) {
    if is_thick {
        draw_line_segment_mut(image,
            (start.0, start.1 - 0.5),
            (end.0, end.1 - 0.5),
            color);
        draw_line_segment_mut(image,
            (start.0, start.1 + 0.5),
            (end.0, end.1 + 0.5),
            color);
    } else {
        draw_line_segment_mut(image,
            start,
            end,
            color);
    }
}

fn draw_arrowhead_rightward(image : &mut RgbImage, x_pos : f32, y_pos : f32, arrowhead_length : f32, color : Rgb<u8>) {
    draw_line_segment_mut(image,
                          (x_pos, y_pos),
                          (x_pos - arrowhead_length, y_pos - arrowhead_length),
                          color);
    draw_line_segment_mut(image,
                          (x_pos, y_pos),
                          (x_pos - arrowhead_length, y_pos + arrowhead_length),
                          color);
}

fn draw_arrowhead_leftward(image : &mut RgbImage, x_pos : f32, y_pos : f32, arrowhead_length : f32, color : Rgb<u8>) {
    draw_line_segment_mut(image,
                          (x_pos, y_pos),
                          (x_pos + arrowhead_length, y_pos - arrowhead_length),
                          color);
    draw_line_segment_mut(image,
                          (x_pos, y_pos),
                          (x_pos + arrowhead_length, y_pos + arrowhead_length),
                          color);
}