Crate for loading SVG files into bevy:
* Load paths from an SVG directly into bevy.
The properties of the lines (color, opacity, fill...) can be used to programmatically
add functionality, setting the foundation for a very weird workflow: Vector Graphics as editor to bevy entities!
* Load whole SVG files as a single entity (see this example).
Add the library to your project's Cargo.toml (check last published version,
it corresponds to the stable version on the branch crates.io):
toml
[dependencies]
bevy_svg_map = "0.1"
If you want the bleeding edge (corresponds to master):
toml
[dependencies]
bevy_svg_map = {git="https://github.com/carrascomj/bevy_svg_map.git"}
:warning: The master branch points to each master branch of bevy and lyon. Use with caution!
The library provides a function to be used inside a bevy's startup_system.
Here, we are loading the file ex.svg under the assets/ directory.
```rust use bevysvgmap::loadsvgmap; use bevy::prelude::*;
// We need to provide a struct implementing the StyleStrategy // leave it as default, we'll come back to this later struct MyStrategy;
impl StyleStrategy for MyStrategy {}
fn main() { App::build() .adddefaultplugins() .addstartupsystem(setup.system()) .run(); }
fn setup(com: &mut Commands, mat: ResMut
That should display some lines as in the image on the top. However, they are plain
black (default for `StyleStrategy`). What about using the colors from the SVG
path strokes?
rust
// we're now also using SvgStyle
use bevysvgmap::{loadsvgmap, StyleStrategy, SvgStyle};
use bevy::prelude::*;
struct MyStrategy;
impl StyleStrategy for MyStrategy {
// implement this trait method
fn colordecider(&self, style: &SvgStyle) -> Color {
match style.stroke() {
Some(c) => c,
// add red lines if the Color could not be parsed from the SVG
_ => Color::RED,
}
}
}
``
OK, that's a bit more interesting. Notice howSvgStyleexposes properties of the
style of the SVG path. For each of these paths, thecolordecider` function will be
applied to... well.. decide its color.
Finally, to provide some actually useful functionality, we can apply arbitrary functions to each component created from the path. ```rust // ... same as before
// This Component will be added to each SpriteComponents created from a path enum Collider { Scorable, Solid, }
impl StyleStrategy for MyStrategy { // implement this trait method fn colordecider(&self, style: &SvgStyle) -> Color { // same as before } fn componentdecider(&self, style: &SvgStyle, comp: &mut Commands) { // use the stroke opacity to decide the kind of Collider comp.with( if style.stroke_opacity().unwrap() == 1.0 { Collider::Solid } else{ Collider::Scorable } ); } } ```
Check out more properties to extract from SvgStyle in the documentation!
Plug and play! ```rust use bevysvgmap::load_svg;
fn setupwholesvg(
commands: &mut Commands,
materials: ResMut
The function returns a command so you can chain components.
rust
loadsvg(commands, materials, meshes, "assets/ex.svg", 1., 2.).
with(YourComponent)
// etc
```
PathSegments.