Raywoke

Raywoke is an extremely simple raycasting crate, forked from raylite. It was created primarily to make the API simpler to use, and integrate more closely with third-party math libraries.

In order to achieve this, Raywoke makes two compromises:

• It is no longer no_std
• It now requires dyn-clone, meaning it is no longer dependency-free.

Third-party crate interop

Raywoke provides interop with the following external crates:

• glam
• nalgebra
• yakui

To enable this, enable their respective features in your cargo.toml:

[dependencies]
raywoke = { version = "0.1", features = ["glam","nalgebra","yakui"] }

Examples

Using the library

use raywoke::prelude::*;

fn main() {
    // Positions are differentiated here because emission direction matters
    let ray = Ray {
        start: (0., 0.), // Emission origin position
        end: (2., 0.),   // Emission end position
    };
	// Direction does not matter for Barriers
    let mut bar = Barrier ((1., -1.), (1., 1.)); 

    let result = cast(&ray, &bar); // Returns a Result<RayHit, RayFail>

    assert!(result.is_ok()); // Result is an Ok<RayHit> containing hit info

    bar = Barrier ((-1., -1.), (-1., 1.)); // Place barrier behind the Ray

    let result = cast(&ray, &bar);
    assert!(result.is_err()); // Result is an Err<RayFail::NoHit>
}

Third-party crate interop

use glam::Vec2;
use nalgebra::Vector2;
use raywoke::prelude::*;

fn main() {
	// With the "glam" and "nalgebra" features, you can use their respective Vector structs
	let ray = Ray::new(
		Vec2::new(0., 0.),
		Vector2::new(0., 0.),
	);
}

Creating your own Point struct

use raywoke::prelude::*;

// Clone and Debug are both required
#[derive(Debug, Clone)]
struct Vec2 {
	x: f32,
	y: f32
}

impl Point for Vec2 {
	fn x(&self) -> f32 {
		self.x
	}
	fn y(&self) -> f32 {
		self.y
	}
	fn edit(&mut self, x: f32, y: f32) {
		self.x = x;
		self.y = y;
	}
}

fn main() {
	let ray = Ray::new(
		Vec2 { x: 0., y: 0. },
		Vec2 { x: 2., y: 0. },
	);
}