fyrox_animation/spritesheet/
signal.rs

1// Copyright (c) 2019-present Dmitry Stepanov and Fyrox Engine contributors.
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in all
11// copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19// SOFTWARE.
20
21//! Animation signal is used as a point at which to notify external observers that animation just
22//! started to play a specific frame.
23
24use crate::core::{reflect::prelude::*, visitor::prelude::*};
25use fyrox_core::uuid_provider;
26
27/// Animation signal is used as a point at which to notify external observers that animation just
28/// started to play a specific frame.
29#[derive(PartialEq, Visit, Reflect, Debug, Clone)]
30pub struct Signal {
31    /// Signal id. It should be used to distinguish different signals. For example, `JUMP` signal
32    /// can have `id = 0`, while `CROUCH` signal - `id = 1`, etc.
33    pub id: u64,
34
35    /// Index of a frame at which to notify external observers.
36    pub frame: u32,
37
38    /// Is the signal enabled or not. Disabled signals won't produce any events.
39    pub enabled: bool,
40}
41
42uuid_provider!(Signal = "30fd963f-4ce7-4dcc-bdff-691897267420");
43
44impl Default for Signal {
45    fn default() -> Self {
46        Self {
47            id: 0,
48            frame: 0,
49            enabled: true,
50        }
51    }
52}
fyrox_animation/spritesheet/signal.rs

fyrox_animation/spritesheet/
signal.rs
