Struct AutoNavigationConfig 

pub struct AutoNavigationConfig {
    pub min_alignment_factor: f32,
    pub max_search_distance: Option<f32>,
    pub prefer_aligned: bool,
}

Configuration resource for automatic navigation.

This resource controls how the automatic navigation system computes which nodes should be connected in each direction.

Fields

min_alignment_factor: f32

Minimum overlap ratio (0.0-1.0) required along the perpendicular axis for cardinal directions.

This parameter controls how much two UI elements must overlap in the perpendicular direction to be considered reachable neighbors. It only applies to cardinal directions (North, South, East, West); diagonal directions (NorthEast, SouthEast, etc.) ignore this requirement entirely.

Calculation

The overlap factor is calculated as:

overlap_factor = actual_overlap / min(origin_size, candidate_size)

For East/West navigation, this measures vertical overlap:

• actual_overlap = overlapping height between the two elements
• Sizes are the heights of the origin and candidate

For North/South navigation, this measures horizontal overlap:

• actual_overlap = overlapping width between the two elements
• Sizes are the widths of the origin and candidate

Examples

• 0.0 (default): Any overlap is sufficient. Even if elements barely touch, they can be neighbors.
• 0.5: Elements must overlap by at least 50% of the smaller element’s size.
• 1.0: Perfect alignment required. The smaller element must be completely within the bounds of the larger element along the perpendicular axis.

Use Cases

• Sparse/irregular layouts (e.g., star constellations): Use 0.0 to allow navigation between elements that don’t directly align.
• Grid layouts: Use 0.5 or higher to ensure navigation only connects elements in the same row or column.
• Strict alignment: Use 1.0 to require perfect alignment, though this may result in disconnected navigation graphs if elements aren’t precisely aligned.

max_search_distance: Option<f32>

Maximum search distance in logical pixels.

Nodes beyond this distance won’t be connected. None means unlimited.

prefer_aligned: bool

Whether to prefer nodes that are more aligned with the exact direction.

When true, nodes that are more directly in line with the requested direction will be strongly preferred over nodes at an angle.

Trait Implementations

impl Clone for AutoNavigationConfig

fn clone(&self) -> AutoNavigationConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AutoNavigationConfig

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

Formats the value using the given formatter.

impl Default for AutoNavigationConfig

fn default() -> Self

Returns the “default value” for a type.

impl FromReflect for AutoNavigationConfig

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

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 GetTypeRegistration for AutoNavigationConfig

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 PartialEq for AutoNavigationConfig

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

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

Returns an owned enumeration of “kinds” of type.

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

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

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

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

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

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

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

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 AutoNavigationConfig

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

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

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

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

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 Struct for AutoNavigationConfig

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

Returns 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>

Returns 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>

Returns 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>

Returns 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>

Returns the name of the field with index index.

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 TypePath for AutoNavigationConfig

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 AutoNavigationConfig

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Resource for AutoNavigationConfig

where Self: Send + Sync + 'static,

impl StructuralPartialEq for AutoNavigationConfig