Crate line_clipping

Line clipping

A rust crate to implement several line clipping algorithms. See the documentation for more information. The choice of algorithms is based on the following article which contains a good summary of the options:

Matthes D, Drakopoulos V. Line Clipping in 2D: Overview, Techniques and Algorithms. J Imaging. 2022 Oct 17;8(10):286. doi: 10.3390/jimaging8100286. PMID: 36286380; PMCID: PMC9605407.

Supports:

• Cohen-Sutherland

TODO

• Cyrus-Beck
• Liang-Barsky
• Nicholl-Lee-Nicholl
• More comprehensive testing

Installation

Add this to your Cargo.toml:

[dependencies]
line_clipping = "0.1"

Usage

use line_clipping::{
    LineSegment, Point, Window,
    cohen_sutherland::clip_line,
}

let line = clip_line(
    LineSegment { p1: Point { x: 0.0, y: 0.0 }, p2: Point { x: 10.0, y: 10.0 } },
    Window { x_min: 1.0, x_max: 9.0, y_min: 1.0, y_max: 9.0 },
);

License

Copyright (c) 2024 Josh McKinney

This project is licensed under either of

• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)

at your option.

Contribution

Contributions are welcome! Please open an issue or submit a pull request.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Modules

• cohen_sutherland

Structs

• LineSegment
  A line segment in 2D space.
• Point
  A point in 2D space.
• Window
  A rectangular region to clip lines against.