Struct bevy_debug_grid::GridAxis

pub struct GridAxis {
    pub x: Option<Color>,
    pub y: Option<Color>,
    pub z: Option<Color>,
}

Custom color overrides for axis of a grid. Spawn it next to a grid for it to have effect.

Fields

x: Option<Color>

Color of the X axis

y: Option<Color>

Color of the Y axis

z: Option<Color>

Color of the Z axis

Implementations

impl GridAxis

pub fn new_empty() -> Self

An empty grid axis, does nothing. Use for later mutation or debug.

pub fn new_rgb() -> Self

Creates a grid axis with each axis having a color. Red for X, green for Y, and blue for Z.

pub fn create_single_axis(size: f32, alignment: GridAlignment) -> [Vec3; 2]

Creates a single axis mesh consisting of two Vec3s

pub fn create_axis(&self) -> (Vec<(GridAlignment, Color)>, Vec<GridAlignment>)

Creates grid axis from the configured colors. Returns a vector of used axis with their corresponding color, as well as a vector of unused axis, (used, unused).

pub fn default_axis() -> [GridAlignment; 2]

Returns the default axis for a grid

pub fn get_by_alignment(&self, alignment: &GridAlignment) -> Option<Color>

Returns an axis color by grid alignment, if such a color is configured per that axis

Trait Implementations

impl Clone for GridAxis

fn clone(&self) -> GridAxis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for GridAxiswhere Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either [TableStorage] or [SparseStorage].

impl Debug for GridAxis

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

Formats the value using the given formatter.

impl Default for GridAxis

fn default() -> Self

Returns the “default value” for a type.