virtual_joystick 2.8.0

Bevy virtual Joystick for mobile/web/touch games with Mouse Emulation
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

use bevy::prelude::*;

use crate::components::VirtualJoystickInteractionArea;
use crate::{
    VirtualJoystickAction, VirtualJoystickBehavior, VirtualJoystickBundle, VirtualJoystickID,
    VirtualJoystickNode, VirtualJoystickUIBackground, VirtualJoystickUIKnob,
};

/// This function is a simple helper to create a joystick
/// Entity with all needed without complexity
///
/// * `cmd`: bevy Commands, this required to spawn entity
/// * `knob_img`: Handle image for joystick knob
/// * `background_img`: Handle image for joystick border
/// * `knob_color`: Color for joystick knob
/// * `background_color`: Color for joystick border
/// * `interactable_area_color`: Color for interactable zone
/// * `knob_size`: Size for knob ui
/// * `background_size`: Size for joystick border ui
/// * `joystick_node`: [`JoystickNode`] struct
/// * `joystick_node_style`: bevy Style for joystick
///
/// Usage:
/// ```no_run
/// create_joystick(
///     cmd,
///     asset_server.load("Knob.png"),
///     asset_server.load("Outline.png"),
///     None,
///     None,
///     Some(Color::rgba(1.0, 0.27, 0.0, 0.3))),
///     Vec2::new(75., 75.),
///     Vec2::new(150., 150.),
///     VirtualJoystickNode {
///         dead_zone: 0.,
///         id: "UniqueJoystick".to_string(),
///         axis: VirtualJoystickAxis::Both,
///         behaviour: VirtualJoystickType::Floating,
///     },
///     Node {
///         width: Val::Px(150.),
///         height: Val::Px(150.),
///         position_type: PositionType::Absolute,
///         left: Val::Percent(50.),
///         bottom: Val::Percent(15.),
///         ..default()
///     },
/// );
/// ```
///
/// if you not want use this function helper, you need do that
/// ```no_run
/// cmd.spawn((
///     VirtualJoystickBundle::new(VirtualJoystickNode {
///         dead_zone: 0.,
///         id: "UniqueJoystick".to_string(),
///         axis: VirtualJoystickAxis::Both,
///         behaviour: VirtualJoystickType::Floating,
///     })
///     .set_style(Node {
///         width: Val::Px(150.),
///         height: Val::Px(150.),
///         position_type: PositionType::Absolute,
///         left: Val::Percent(50.),
///         bottom: Val::Percent(15.),
///         ..default()
///     }),
///     BackgroundColor(Color::rgba(1.0, 0.27, 0.0, 0.3))),
/// ))
/// .insert(VirtualJoystickInteractionArea)
/// .with_children(|parent| {
///     parent.spawn((
///         VirtualJoystickUIKnob,
///         ImageBundle {
///             image: asset_server.load("Knob.png").into(),
///             style: Style {
///                 width: Val::Px(75.),
///                 height: Val::Px(75.),
///                 ..default()
///             },
///             background_color: Color::WHITE.into(),
///             ..default()
///         },
///     ));
///     parent.spawn((
///         VirtualJoystickUIBackground,
///         ImageBundle {
///             image: asset_server.load("Outline.png").into(),
///             style: Style {
///                 width: Val::Px(150.),
///                 height: Val::Px(150.),
///                 ..default()
///             },
///             background_color: Color::WHITE.into(),
///             ..default()
///         },
///     ));
/// });
/// ```
#[allow(clippy::too_many_arguments)]
pub fn create_joystick<I: VirtualJoystickID>(
    cmd: &mut Commands,
    id: I,
    knob_img: Handle<Image>,
    background_img: Handle<Image>,
    knob_color: Option<Color>,
    background_color: Option<Color>,
    interactable_area_color: Option<Color>,
    knob_size: Vec2,
    background_size: Vec2,
    joystick_node_style: Node,
    behavior: impl VirtualJoystickBehavior,
    action: impl VirtualJoystickAction<I>,
) {
    let mut spawn = cmd.spawn(
        VirtualJoystickBundle::new(
            VirtualJoystickNode::<I>::default()
                .with_id(id)
                .with_behavior(behavior)
                .with_action(action),
        )
        .set_style(joystick_node_style),
    );

    if let Some(c) = interactable_area_color {
        spawn.insert(BackgroundColor(c));
    }

    spawn.with_children(|parent| {
        // Interaction Area
        parent.spawn((
            VirtualJoystickInteractionArea,
            Node {
                width: Val::Percent(100.),
                height: Val::Percent(100.),
                ..default()
            },
        ));

        // Knob
        parent.spawn((
            VirtualJoystickUIKnob,
            ImageNode {
                color: knob_color.unwrap_or(Color::WHITE.with_alpha(1.0)),
                image: knob_img,
                ..default()
            },
            Node {
                position_type: PositionType::Absolute,
                width: Val::Px(knob_size.x),
                height: Val::Px(knob_size.y),
                ..default()
            },
            ZIndex(1),
        ));

        // Background
        parent.spawn((
            VirtualJoystickUIBackground,
            ImageNode {
                color: background_color.unwrap_or(Color::WHITE.with_alpha(1.0)),
                image: background_img,
                ..default()
            },
            Node {
                position_type: PositionType::Absolute,
                width: Val::Px(background_size.x),
                height: Val::Px(background_size.y),
                ..default()
            },
            ZIndex(0),
        ));
    });
}