fyrox_ui/brush.rs
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
//! Brush defines a way to fill an arbitrary surface. See [`Brush`] docs for more info and usage examples.
#![warn(missing_docs)]
use crate::core::{algebra::Vector2, color::Color, reflect::prelude::*, visitor::prelude::*};
use fyrox_core::uuid_provider;
use strum_macros::{AsRefStr, EnumString, VariantNames};
/// Gradient point defines a point on a surface with a color.
#[derive(Clone, Debug, PartialEq, Reflect, Visit, Default)]
pub struct GradientPoint {
/// A distance from an origin of the gradient.
pub stop: f32,
/// Color of the point.
pub color: Color,
}
uuid_provider!(GradientPoint = "e8503ec6-a1d0-4a9b-ab91-0d3f126254dd");
/// Brush defines a way to fill an arbitrary surface.
#[derive(Clone, Debug, PartialEq, Reflect, Visit, AsRefStr, EnumString, VariantNames)]
pub enum Brush {
/// A brush, that fills a surface with a solid color.
Solid(Color),
/// A brush, that fills a surface with a linear gradient, which is defined by two points in local coordinates
/// and a set of stop points. See [`GradientPoint`] for more info.
LinearGradient {
/// Beginning of the gradient in local coordinates.
from: Vector2<f32>,
/// End of the gradient in local coordinates.
to: Vector2<f32>,
/// Stops of the gradient.
stops: Vec<GradientPoint>,
},
/// A brush, that fills a surface with a radial gradient, which is defined by a center point in local coordinates
/// and a set of stop points. See [`GradientPoint`] for more info.
RadialGradient {
/// Center of the gradient in local coordinates.
center: Vector2<f32>,
/// Stops of the gradient.
stops: Vec<GradientPoint>,
},
}
uuid_provider!(Brush = "eceb3805-73b6-47e0-8582-38a01f7b70e1");
impl Default for Brush {
fn default() -> Self {
Self::Solid(Color::WHITE)
}
}