This is an Aframe library for rust. It's still fairly experimental and a lot might change. I started writing this for a bit of fun to see if I could play with aframe from inside a yew app. It started getting pretty large so I decided to abstract away all the yew-specific stuff and start making a library on its own. There's still a bunch missing and a bunch to do here, but what IS there is functional.
This crate contains an init feature which may be enabled to allow initialization from an async function:
```rust,ignore
async fn appmain() -> Result<(), aframe::InitError> { aframe::initaframe().await?; // ... Now you can safely continue }
```
You can also initialize simply by adding the Aframe script to your HTML header:
```html
```
You can either use this crate's Htmlify trait to output raw html, or use the yew-support feature to create a yew componment (described lower in this readme) to output your actual Aframe scene.
Instantiating a scene:
scene!
Defining a new component:
component_def!
Declaring the structure of a defined component:
componentstruct!
simpleenum!
complex_enum!
Instantiating a component struct:
component!
See the component module for more information and for pre-defined component structs.
Defining a new custom geometry:
geometry_def!
Not yet implemented:
* geometry_struct! macro to declare structure of custom geometry data
* geometry! macro to serve as a helper when instantiating custom geometry
Instantiating an entity or defined primitive:
entity!
Defining a new primitive:
primitive!
The assets! and mixin! macros are provided to define an Assets struct.
The Htmlify trait is is to generate HTML from the structures provided in this crate. This may eventually be abstracted into a separate crate. (TBD: Is there a better crate in existence already?). This trait can generate web_sys::Element and other javascript-wrapped types, or raw HTML as a string.
You can use this to plop a Scene directly into your DOM with the web_sys crate, making this crate usable even without any supporting framework:
rust,ignore
// Say we have some `Scene` structure already constructed:
let body = web_sys::window()?.document()?.body()?;
body.append_with_node_1(scene.as_element()?.as_ref())?;
Here's a basic example of a fully-functional page being created using wasm-bindgen-test:
test example
The lowest-level calls to Aframe are defined in the sys module:
registerPrimitive
registerComponent
registerShader
The yew_support feature adds yew support to this crate. At its core, all this does is implement From<&Scene> for Html along with a few other conversions to yew's Html type.
See the yew-ext module page for an example.
Below is a full example of how a scene is constructed in yew (this also serves of a valid example of how to use the scene! macro even outside of a yew context):
```rust,ignore
html!
{
// Ambient light
entity!
{
attributes: ("id", "ambient-light"),
components: ("light", component!
{
component::Light,
light_type: component::LightType::Ambient{},
color: color::GREY73,
intensity: 0.2
})
},
// Directional light
entity!
{
attributes: ("id", "directional-light"),
components:
("position", component::Position{ x: 0.5, y: 1.0, z: 1.0 }),
("light", component!
{
component::Light,
light_type: component::LightType::Directional
{
shadow: component::OptionalDirectionalShadow::Cast
{
shadow: component!
{
component::DirectionalShadow
}
}
},
color: color::WHITE,
intensity: 0.1
})
},
// The sky
entity!
{
primitive: "a-sky",
attributes: ("id", "sky"),
components: ("material", component!
{
component::Material,
// This assumes the existence of a shader registered as "strobe"
shader: Cow::Borrowed("strobe"),
props: component::MaterialProps(Cow::Owned(vec!
(
(Cow::Borrowed("color"), Cow::Borrowed("black")),
(Cow::Borrowed("color2"), Cow::Borrowed("#222222"))
)))
})
},
// The ocean
entity!
{
primitive: "a-ocean",
attributes: ("id", "water"), ("depth", "100"), ("width", "100"), ("amplitude", "0.5"),
components: ("material", component!
{
component::Material,
// This assumes the existence of a shader registered as "water"
shader: Cow::Borrowed("water"),
props: component::MaterialProps(Cow::Owned(vec!((Cow::Borrowed("transparent"), Cow::Borrowed("true")))))
})
}
}
} />
} ```