bevy_obj

Crates.iobevy_obj
lib.rsbevy_obj
version0.15.0
sourcesrc
created_at2020-08-25 21:50:12.062535
updated_at2024-10-29 20:26:14.62102
descriptionWavefront OBJ mesh asset loader plugin for the Bevy engine
homepage
repositoryhttps://github.com/AmionSky/bevy_obj
max_upload_size
id280744
size148,178
Csányi István (AmionSky)

documentation

README

bevy_obj

Crates.io

Wavefront OBJ mesh asset loader plugin for the Bevy engine.

Usage

Add the crate as a dependency:

Major and Minor version number should match bevy version.

[dependencies]
bevy = "0.15"
bevy_obj = "0.15"

Add the plugin:

use bevy::prelude::*;
use bevy_obj::ObjPlugin;

fn main() {
    App::new()
        .add_plugins((DefaultPlugins, ObjPlugin))
        .run();
}

Load an .obj file:

fn example_startup_system(asset_server: Res<AssetServer>) {
    // Load it as a singular mesh
    let mesh_handle = asset_server.load::<Mesh>("example.obj");

    // Load it as a scene with limited .mtl material support
    let scene_handle = asset_server.load::<Scene>("example.obj");

    // Or let bevy infer the type
    let mesh = Mesh3d(asset_server.load("example.obj"));
    let scene = SceneRoot(asset_server.load("example.obj"));
}

Settings

You can use load_with_settings() to modify some loader settings.

fn example_startup_system(asset_server: Res<AssetServer>) {
    // Load the model with flat normals
    let scene = SceneRoot(asset_server.load_with_settings(
        "example.obj",
        |settings: &mut bevy_obj::ObjSettings| {
            settings.force_compute_normals = true;
            settings.prefer_flat_normals = true;
        },
    ));
}

License

Licensed under either of

at your option.

Commit count: 74

cargo fmt