Struct UiPosition 

pub struct UiPosition {
    pub anchor: Vec2,
    pub x: Val,
    pub y: Val,
}

Responsive position relative to a UI node.

Fields

anchor: Vec2

Normalized anchor point

x: Val

Responsive horizontal position relative to the anchor point

y: Val

Responsive vertical position relative to the anchor point

Implementations

impl UiPosition

pub const TOP_LEFT: UiPosition

Position at the top-left corner

pub const LEFT: UiPosition

Position at the center of the left edge

pub const BOTTOM_LEFT: UiPosition

Position at the bottom-left corner

pub const TOP: UiPosition

Position at the center of the top edge

pub const CENTER: UiPosition

Position at the center of the element

pub const BOTTOM: UiPosition

Position at the center of the bottom edge

pub const TOP_RIGHT: UiPosition

Position at the top-right corner

pub const RIGHT: UiPosition

Position at the center of the right edge

pub const BOTTOM_RIGHT: UiPosition

Position at the bottom-right corner

pub const fn anchor(anchor: Vec2) -> UiPosition

Position at the given normalized anchor point

pub const fn new(anchor: Vec2, x: Val, y: Val) -> UiPosition

Create a new position

pub const fn at(self, x: Val, y: Val) -> UiPosition

Creates a position from self with the given x and y coordinates

pub const fn at_x(self, x: Val) -> UiPosition

Creates a position from self with the given x coordinate

Examples found in repository

examples/ui/styling/stacked_gradients.rs (line 59)

fn setup(mut commands: Commands) {
    commands.spawn(Camera2d);
    commands
        .spawn(Node {
            display: Display::Grid,
            width: percent(100),
            height: percent(100),

            ..Default::default()
        })
        .with_children(|commands| {
            commands.spawn((
                Node {
                    width: percent(100),
                    height: percent(100),
                    ..Default::default()
                },
                BackgroundColor(Color::BLACK),
                BackgroundGradient(vec![
                    LinearGradient::to_top_right(vec![
                        ColorStop::auto(RED),
                        ColorStop::auto(RED.with_alpha(0.)),
                    ])
                    .into(),
                    LinearGradient::to_top_left(vec![
                        ColorStop::auto(BLUE),
                        ColorStop::auto(BLUE.with_alpha(0.)),
                    ])
                    .into(),
                    ConicGradient {
                        start: 0.,
                        position: UiPosition::CENTER,
                        stops: vec![
                            AngularColorStop::auto(YELLOW.with_alpha(0.)),
                            AngularColorStop::auto(YELLOW.with_alpha(0.)),
                            AngularColorStop::auto(YELLOW),
                            AngularColorStop::auto(YELLOW.with_alpha(0.)),
                            AngularColorStop::auto(YELLOW.with_alpha(0.)),
                        ],
                        ..Default::default()
                    }
                    .into(),
                    RadialGradient {
                        position: UiPosition::TOP.at_x(percent(5)),
                        shape: RadialGradientShape::Circle(vh(30)),
                        stops: vec![
                            ColorStop::auto(Color::WHITE),
                            ColorStop::auto(YELLOW),
                            ColorStop::auto(YELLOW.with_alpha(0.1)),
                            ColorStop::auto(YELLOW.with_alpha(0.)),
                        ],
                        ..Default::default()
                    }
                    .into(),
                    LinearGradient {
                        angle: TAU / 16.,
                        stops: vec![
                            ColorStop::auto(Color::BLACK),
                            ColorStop::auto(Color::BLACK.with_alpha(0.)),
                        ],
                        ..Default::default()
                    }
                    .into(),
                    LinearGradient {
                        angle: 15. * TAU / 16.,
                        stops: vec![
                            ColorStop::auto(Color::BLACK),
                            ColorStop::auto(Color::BLACK.with_alpha(0.)),
                        ],
                        ..Default::default()
                    }
                    .into(),
                ]),
            ));
        });
}

pub const fn at_y(self, y: Val) -> UiPosition

Creates a position from self with the given y coordinate

pub const fn at_px(self, x: f32, y: f32) -> UiPosition

Creates a position in logical pixels from self with the given x and y coordinates

pub const fn at_percent(self, x: f32, y: f32) -> UiPosition

Creates a percentage position from self with the given x and y coordinates

pub const fn with_anchor(self, anchor: Vec2) -> UiPosition

Creates a position from self with the given anchor point

pub const fn top_left(x: Val, y: Val) -> UiPosition

Position relative to the top-left corner

pub const fn left(x: Val, y: Val) -> UiPosition

Position relative to the left edge

pub const fn bottom_left(x: Val, y: Val) -> UiPosition

Position relative to the bottom-left corner

pub const fn top(x: Val, y: Val) -> UiPosition

Position relative to the top edge

pub const fn center(x: Val, y: Val) -> UiPosition

Position relative to the center

pub const fn bottom(x: Val, y: Val) -> UiPosition

Position relative to the bottom edge

pub const fn top_right(x: Val, y: Val) -> UiPosition

Position relative to the top-right corner

pub const fn right(x: Val, y: Val) -> UiPosition

Position relative to the right edge

pub const fn bottom_right(x: Val, y: Val) -> UiPosition

Position relative to the bottom-right corner

pub fn resolve( self, scale_factor: f32, physical_size: Vec2, physical_target_size: Vec2, ) -> Vec2

Resolves the Position into physical coordinates.

Trait Implementations

impl Clone for UiPosition

fn clone(&self) -> UiPosition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for UiPosition

impl Debug for UiPosition

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

Formats the value using the given formatter.

impl Default for UiPosition

fn default() -> UiPosition

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UiPosition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<(Val, Val)> for UiPosition

fn from(_: (Val, Val)) -> UiPosition

Converts to this type from the input type.

impl From<Val> for UiPosition

fn from(x: Val) -> UiPosition

Converts to this type from the input type.

impl FromArg for UiPosition

type This<'from_arg> = UiPosition

The type to convert into.

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

Creates an item from an argument.

impl FromReflect for UiPosition

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

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 UiPosition

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for UiPosition

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 UiPosition

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

where UiPosition: 'into_return,

Converts Self into a Return value.

impl PartialEq for UiPosition

fn eq(&self, other: &UiPosition) -> 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 UiPosition

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<UiPosition>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<UiPosition>, ) -> 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<UiPosition>) -> 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 UiPosition

fn into_any(self: Box<UiPosition>) -> 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<UiPosition>) -> 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 UiPosition

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 UiPosition

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 UiPosition

impl TypePath for UiPosition

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 UiPosition

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.