Struct Val2 

pub struct Val2 {
    pub x: Val,
    pub y: Val,
}

A pair of Vals used to represent a 2-dimensional size or offset.

Fields

x: Val

Translate the node along the x-axis. Val::Percent values are resolved based on the computed width of the Ui Node. Val::Auto is resolved to 0..

y: Val

Translate the node along the y-axis. Val::Percent values are resolved based on the computed height of the UI Node. Val::Auto is resolved to 0..

Implementations

impl Val2

pub const ZERO: Val2

pub const fn new(x: Val, y: Val) -> Val2

Creates a new Val2

pub const fn all(val: Val) -> Val2

Creates a new Val2 where both components are the same value

pub fn px<X, Y>(x: X, y: Y) -> Val2

where X: ValNum, Y: ValNum,

Creates a new Val2 where both components are in logical pixels

Examples found in repository

examples/ui/ui_transform.rs (line 96)

fn translation_system(
    time: Res<Time>,
    input: Res<ButtonInput<KeyCode>>,
    mut translation_query: Query<&mut UiTransform, With<TargetNode>>,
) {
    let controls = [
        (KeyCode::ArrowLeft, -Vec2::X),
        (KeyCode::ArrowRight, Vec2::X),
        (KeyCode::ArrowUp, -Vec2::Y),
        (KeyCode::ArrowDown, Vec2::Y),
    ];
    for &(key_code, direction) in &controls {
        if input.pressed(key_code) {
            for mut transform in translation_query.iter_mut() {
                let d = direction * 50.0 * time.delta_secs();
                let (Val::Px(x), Val::Px(y)) = (transform.translation.x, transform.translation.y)
                else {
                    continue;
                };
                let x = (x + d.x).clamp(-150., 150.);
                let y = (y + d.y).clamp(-150., 150.);

                transform.translation = Val2::px(x, y);
            }
        }
    }
}

examples/testbed/ui.rs (line 1409)

    pub fn setup(mut commands: Commands) {
        commands.spawn((Camera2d, DespawnOnExit(super::Scene::Transformations)));
        commands
            .spawn((
                Node {
                    width: percent(100),
                    height: percent(100),
                    display: Display::Block,
                    ..default()
                },
                DespawnOnExit(super::Scene::Transformations),
            ))
            .with_children(|parent| {
                for (transformation, label, background) in [
                    (
                        UiTransform::from_rotation(Rot2::degrees(45.)),
                        "Rotate 45 degrees",
                        RED,
                    ),
                    (
                        UiTransform::from_scale(Vec2::new(2., 0.5)),
                        "Scale 2.x 0.5y",
                        GREEN,
                    ),
                    (
                        UiTransform::from_translation(Val2::px(-50., 50.)),
                        "Translate -50px x +50px y",
                        BLUE,
                    ),
                    (
                        UiTransform {
                            translation: Val2::px(50., 0.),
                            scale: Vec2::new(-1., 1.),
                            rotation: Rot2::degrees(30.),
                        },
                        "T 50px x\nS -1.x (refl)\nR 30deg",
                        DARK_CYAN,
                    ),
                ] {
                    parent
                        .spawn((Node {
                            width: percent(100),
                            margin: UiRect {
                                top: px(50),
                                bottom: px(50),
                                ..default()
                            },
                            align_items: AlignItems::Center,
                            justify_content: JustifyContent::SpaceAround,
                            ..default()
                        },))
                        .with_children(|row| {
                            row.spawn((
                                Text::new("Before Tf"),
                                Node {
                                    width: px(100),
                                    height: px(100),
                                    border_radius: BorderRadius::bottom_right(px(25.)),
                                    ..default()
                                },
                                BackgroundColor(background.into()),
                                TextFont::default(),
                            ));
                            row.spawn((
                                Text::new(label),
                                Node {
                                    width: px(100),
                                    height: px(100),
                                    border_radius: BorderRadius::bottom_right(px(25.)),
                                    ..default()
                                },
                                BackgroundColor(background.into()),
                                transformation,
                                TextFont::default(),
                            ));
                        });
                }
            });
    }

examples/ui/ui_drag_and_drop.rs (line 80)

fn setup(mut commands: Commands) {
    commands.spawn(Camera2d);
    commands
        .spawn((Node {
            display: Display::Grid,
            align_self: AlignSelf::Center,
            justify_self: JustifySelf::Center,
            ..Default::default()
        }, Pickable::IGNORE, BackgroundColor(Color::srgb(0.4, 0.4, 0.4))))
        .with_children(|parent| {
            let tile_colors = [
                Color::srgb(0.2, 0.2, 0.8),
                Color::srgb(0.8, 0.2, 0.2)
            ];
            for column in 0..COLUMNS {
                for row in 0..ROWS {
                    let i = column + row * COLUMNS;
                    let tile_color = tile_colors[((row % 2) + column) as usize % tile_colors.len()];
                    let tile_border_color = tile_color.darker(0.025);
                    parent
                        .spawn((
                            Node {
                                width: px(TILE_SIZE),
                                height: px(TILE_SIZE),
                                border: px(4.).all(),
                                grid_row: GridPlacement::start(row + 1),
                                grid_column: GridPlacement::start(column + 1),
                                align_items: AlignItems::Center,
                                justify_content: JustifyContent::Center,
                                ..Default::default()
                            },
                            BorderColor::all(tile_border_color),
                            BackgroundColor(tile_color),
                            Outline {
                                width: px(2.),
                                offset: Val::ZERO,
                                color: Color::NONE,
                            },
                            Pickable {
                                should_block_lower: false,
                                is_hoverable: true,
                            },
                            GlobalZIndex::default()
                        ))
                        .observe(move |on_over: On<Pointer<Over>>, mut query: Query<(&mut BackgroundColor, &mut BorderColor)>| {
                            if let Ok((mut background_color, mut border_color)) = query.get_mut(on_over.event_target()) {
                                background_color.0 = tile_color.lighter(0.1);
                                border_color.set_all(tile_border_color.lighter(0.1));
                            }
                        })
                        .observe(move |on_out: On<Pointer<Out>>, mut query: Query<(&mut BackgroundColor, &mut BorderColor)>| {
                            if let Ok((mut background_color, mut border_color)) = query.get_mut(on_out.event_target()) {
                                background_color.0 = tile_color;
                                border_color.set_all(tile_border_color);
                            }
                        })
                        .observe(|on_drag_start: On<Pointer<DragStart>>, mut query: Query<(&mut Outline, &mut GlobalZIndex)>| {
                            if let Ok((mut outline, mut global_zindex, )) = query.get_mut(on_drag_start.event_target()) {
                                outline.color = Color::WHITE;
                                global_zindex.0 = 1;
                            }
                        })
                        .observe(|on_drag: On<Pointer<Drag>>, mut query: Query<&mut UiTransform>| {
                            if let Ok(mut transform) = query.get_mut(on_drag.event_target()) {
                                transform.translation = Val2::px(on_drag.distance.x, on_drag.distance.y);
                            }
                        })
                        .observe(move |on_drag_end: On<Pointer<DragEnd>>, mut query: Query<(&mut UiTransform, &mut Outline, &mut GlobalZIndex)>| {
                            if let Ok((mut transform, mut outline, mut global_zindex)) = query.get_mut(on_drag_end.event_target()) {
                                transform.translation = Val2::ZERO;
                                outline.color = Color::NONE;
                                global_zindex.0 = 0;
                            }
                        })
                        .observe(|on_drag_drop: On<Pointer<DragDrop>>, mut query: Query<&mut Node>| {
                            if let Ok([mut a, mut b]) = query.get_many_mut([on_drag_drop.event_target(), on_drag_drop.dropped]) {
                                core::mem::swap(&mut a.grid_row, &mut b.grid_row);
                                core::mem::swap(&mut a.grid_column, &mut b.grid_column);
                            }
                        })
                        .with_child((Text::new(format!("{i}")), Pickable::IGNORE));
                }
            }
        });
}

pub fn percent<X, Y>(x: X, y: Y) -> Val2

where X: ValNum, Y: ValNum,

Creates a new Val2 where both components are percentage values

pub fn resolve( &self, scale_factor: f32, base_size: Vec2, viewport_size: Vec2, ) -> Vec2

Resolves this Val2 from the given scale_factor, parent_size, and viewport_size.

Component values of Val::Auto are resolved to 0.

pub fn try_add(self, other: Val2) -> Result<Val2, ValArithmeticError>

Try to add two Val2s component-wise.

Returns ValArithmeticError::IncompatibleUnits if either component has mismatched units.

assert_eq!(Val2::px(1., 2.).try_add(Val2::px(3., 4.)), Ok(Val2::px(4., 6.)));
assert_eq!(
    Val2::new(Val::Px(1.), Val::Px(2.)).try_add(Val2::new(Val::Percent(3.), Val::Px(4.))),
    Err(ValArithmeticError::IncompatibleUnits)
);

pub fn try_sub(self, other: Val2) -> Result<Val2, ValArithmeticError>

Try to subtract two Val2s component-wise.

Returns ValArithmeticError::IncompatibleUnits if either component has mismatched units.

assert_eq!(Val2::px(3., 4.).try_sub(Val2::px(1., 2.)), Ok(Val2::px(2., 2.)));
assert_eq!(
    Val2::new(Val::Px(1.), Val::Px(2.)).try_sub(Val2::new(Val::Percent(3.), Val::Px(4.))),
    Err(ValArithmeticError::IncompatibleUnits)
);

Trait Implementations

impl Clone for Val2

fn clone(&self) -> Val2

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Val2

impl Debug for Val2

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Val2

fn default() -> Val2

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Val2

fn deserialize<__D>( __deserializer: __D, ) -> Result<Val2, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArg for Val2

type This<'from_arg> = Val2

The type to convert into.

fn from_arg(arg: Arg<'_>) -> Result<<Val2 as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromReflect for Val2

fn from_reflect(reflect: &(dyn PartialReflect + 'static)) -> Option<Val2>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetOwnership for Val2

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for Val2

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl IntoReturn for Val2

fn into_return<'into_return>(self) -> Return<'into_return>

where Val2: 'into_return,

Converts Self into a Return value.

impl PartialEq for Val2

fn eq(&self, other: &Val2) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialReflect for Val2

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Val2>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Val2>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Val2>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_partial_cmp( &self, value: &(dyn PartialReflect + 'static), ) -> Option<Ordering>

Returns a “partial comparison” result.

fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Debug formatter for the value.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for Val2

fn into_any(self: Box<Val2>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Val2>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Serialize for Val2

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for Val2

fn field(&self, name: &str) -> Option<&(dyn PartialReflect + 'static)>

Gets a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut( &mut self, name: &str, ) -> Option<&mut (dyn PartialReflect + 'static)>

Gets a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Gets a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Gets a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Gets the name of the field with index index.

fn index_of_name(&self, name: &str) -> Option<usize>

Gets the index of the field with the given name.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl StructuralPartialEq for Val2

impl TypePath for Val2

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Val2

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.