bevy_points 0.10.0

Points mesh plugin for Bevy
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88


# Bevy Points

[![crates.io](https://img.shields.io/crates/v/bevy_points)](https://crates.io/crates/bevy_points)

Points mesh plugin for Bevy.

![Example](https://github.com/mattatz/bevy_points/assets/1085910/9bbf57b4-38b6-45ea-8b99-10ae004974e5)

## Usage

### System setup

Add the plugin to your app:

```rust
use bevy::prelude::*;
use bevy_points::prelude::*;

fn main() {
    App::new()
        .add_plugins(PointsPlugin);
}
```

### Apply a material to a mesh

```rust
fn setup(
    mut commands: Commands,
    mut meshes: ResMut<Assets<Mesh>>,
    mut materials: ResMut<Assets<PointsMaterial>>,
) {
    let n = 320; // # of points
    let h = 3.0; // spiral height
    commands.spawn((
        Mesh3d(meshes.add(
            PointsMesh::from_iter((0..n).map(|i| {
                let t01 = (i as f32) / ((n - 1) as f32);
                let r = t01 * TAU * 4.0; // spiral fineness
                Vec3::new(r.cos(), (t01 - 0.5) * h, r.sin())
            })),
        )),
        MeshMaterial3d(materials.add(PointsMaterial {
            settings: PointsShaderSettings {
                point_size: 20.,    // Defines the size of the points. 
                ..Default::default()
            },
            perspective: true,      // Specify whether points' size is attenuated by the camera depth. 
            circle: true,           // Specify whether the shape of points is circular or rectangular.
            ..Default::default()
        })),
    ));

    commands.spawn((
        Mesh3d(meshes.add(
            // Mesh can be converted to PointsMesh & vice versa.
            PointsMesh::from(Mesh::from(Sphere {
                radius: 1.0
            }))
        )),
        MeshMaterial3d(materials.add(PointsMaterial {
            settings: PointsShaderSettings {
                color: Color::BLUE,
                opacity: 0.5,
                ..Default::default()
            },
            alpha_mode: AlphaMode::Blend,
            ..Default::default()
        })),
    ));
}

```

## Compatibility

| bevy | bevy_points |
| ---- | ------------- |
| 0.9  | 0.1           |
| 0.10 | 0.2           |
| 0.11 | 0.3           |
| 0.12 | 0.4           |
| 0.13 | 0.5           |
| 0.14 | 0.6           |
| 0.15 | 0.7           |
| 0.16 | 0.8           |
| 0.18 | 0.10          |