Struct bevy_plot::Plot

source · [−]

pub struct Plot {Show 23 fields
    pub plot_coord_mouse_pos: Vec2,
    pub canvas_position: Vec2,
    pub tick_period: Vec2,
    pub outer_border: Vec2,
    pub canvas_size: Vec2,
    pub background_color1: Color,
    pub background_color2: Color,
    pub show_grid: bool,
    pub zero_world: Vec2,
    pub time: f32,
    pub zoom: f32,
    pub hide_contour: bool,
    pub hide_tick_labels: bool,
    pub hide_half_ticks: bool,
    pub tick_label_color: Color,
    pub significant_digits: usize,
    pub show_target: bool,
    pub target_label_color: Color,
    pub target_color: Color,
    pub target_significant_digits: usize,
    pub show_axes: bool,
    pub bezier_num_points: usize,
    pub data: PlotData,
    /* private fields */
}

Expand description

Contains all relevant information to both the look of the canvas and the data to be plotted.

Fields

plot_coord_mouse_pos: Vec2

mouse position in the reference frame of the graph, corresponding to its axes

canvas_position: Vec2

Position of the canvas in World coordinates

tick_period: Vec2

Distance between consecutive grid lines

outer_border: Vec2

Size of the margins with respect to the canvas_size. The default is set to Vec2::new(0.03 * size.y / size.x, 0.03)

canvas_size: Vec2

Size of the graph in pixels

background_color1: Color

Color of even tiles

background_color2: Color

Color of odd tiles

show_grid: bool

The grid is shown by default

zero_world: Vec2

Position of the origin of the graph in World coordinates

time: f32

unused

zoom: f32

The current zoom value: adjustable with the MouseWheel

hide_contour: bool

Hides the black contour around the canvas

hide_tick_labels: bool

Hides numeric labels by the side of the grid lines

hide_half_ticks: bool

Hides half the numeric tick labels for a less crowded feel

tick_label_color: Color

Color for the numerical labels shown by the side of the grid lines

significant_digits: usize

Adjusts the number of significant digits for the tick labels

show_target: bool

A target can be spawned together with a pair of coordinates by pressing MouseButton::Middle

target_label_color: Color

The color for the coordinate pair by the side of the target

target_color: Color

Color of the target

target_significant_digits: usize

Number of significant digits for the target coordinates

show_axes: bool

Axes are shown by default

bezier_num_points: usize

The number of samples taken on the explicit function provided to Plot::plot_func or [Plot::plotopt_func`] functions

data: PlotData

Contains the data and metaparameters needed for drawing each kind of plot

Implementations

source

impl Plot

source

pub fn plotopt<T: Plotable>(&mut self, v: T, options: Vec<Opt>)

Customizable plotting function. Takes any type that implements Plotable, namely Vec<Vec2>, Vec<(f64, f64)>, Vec<f32>, …

source

pub fn plot(&mut self, v: impl Plotable)

Quickly plot data points using segments to connect consecutive points. Takes any type that implements Plotable, namely Vec<Vec2>, Vec<(f64, f64)>, Vec<f32>, …

source

pub fn plotm<T: Plotable>(&mut self, v: T)

Quickly plot data points using markers (scatter plot).

source

pub fn plot_func(&mut self, f: fn(_: f32, _: f32) -> f32)

Quickly plot a function by providing said function. Defaults to a range on the both axes from -0.2 to 1.2.

source

pub fn plotopt_func(&mut self, f: fn(_: f32, _: f32) -> f32, options: Vec<Opt>)

Plot a function by providing said function and options.

source

pub fn set_bounds(&mut self, lo: Vec2, up: Vec2)

Override the default plot bounds: x axis goes from bounds.lo.x to bounds.up.x. Beware! The tick period is automatically adjusted. Changing the tick period before setting the bounds will not have the intended effect. The bounds must be set before the ticks.

Panics

Panics if lo.x >= up.x or lo.y >= up.y.

source

pub fn to_local(&self, v: Vec2) -> Vec2

Convert a point in plot coordinates to a point in world coordinates modulo the canvas position

source

pub fn world_to_plot(&self, y: Vec2) -> Vec2

Convert a point in world coordinates to a point in the graph coordinates.

Trait Implementations

source

impl Clone for Plot

source

fn clone(&self) -> Plot

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Component for Plot where
Self: Send + Sync + 'static,

type Storage = TableStorage

source

impl Debug for Plot

source

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

Formats the value using the given formatter. Read more

source

impl Default for Plot

source

fn default() -> Plot

Returns the “default value” for a type. Read more

source

impl TypeUuid for Plot

source

const TYPE_UUID: Uuid

Auto Trait Implementations

impl RefUnwindSafe for Plot

impl Send for Plot

impl Sync for Plot

impl Unpin for Plot

impl UnwindSafe for Plot

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromWorld for T where
T: Default,

pub fn from_world(_world: &mut World) -> T

Creates Self using data from the given [World]

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,

pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>

impl<T> TypeUuidDynamic for T where
T: TypeUuid,

pub fn type_uuid(&self) -> Uuid

pub fn type_name(&self) -> &'static str

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct bevy_plot::Plot

Fields

Implementations

impl Plot

pub fn plotopt<T: Plotable>(&mut self, v: T, options: Vec<Opt>)

pub fn plot(&mut self, v: impl Plotable)

pub fn plotm<T: Plotable>(&mut self, v: T)

pub fn plot_func(&mut self, f: fn(_: f32, _: f32) -> f32)

pub fn plotopt_func(&mut self, f: fn(_: f32, _: f32) -> f32, options: Vec<Opt>)

pub fn set_bounds(&mut self, lo: Vec2, up: Vec2)

pub fn to_local(&self, v: Vec2) -> Vec2

pub fn world_to_plot(&self, y: Vec2) -> Vec2

Trait Implementations

impl Clone for Plot

fn clone(&self) -> Plot

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

impl Component for Plot where Self: Send + Sync + 'static,

type Storage = TableStorage

impl Debug for Plot

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

impl Default for Plot

fn default() -> Plot

impl TypeUuid for Plot

const TYPE_UUID: Uuid

Auto Trait Implementations

impl RefUnwindSafe for Plot

impl Send for Plot

impl Sync for Plot

impl Unpin for Plot

impl UnwindSafe for Plot

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for T where T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

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

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

impl<T> DowncastSync for T where T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> FromWorld for T where T: Default,

pub fn from_world(_world: &mut World) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> TypeData for T where T: 'static + Send + Sync + Clone,

pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>

impl<T> TypeUuidDynamic for T where T: TypeUuid,

pub fn type_uuid(&self) -> Uuid

pub fn type_name(&self) -> &'static str

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> Asset for T where T: TypeUuid + AssetDynamic + TypeUuidDynamic,

impl<T> AssetDynamic for T where T: 'static + Send + Sync + TypeUuidDynamic,

impl<T> Resource for T where T: 'static + Send + Sync,

impl Component for Plot where
Self: Send + Sync + 'static,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

impl<T> FromWorld for T where
T: Default,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,

impl<T> TypeUuidDynamic for T where
T: TypeUuid,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> Asset for T where
T: TypeUuid + AssetDynamic + TypeUuidDynamic,

impl<T> AssetDynamic for T where
T: 'static + Send + Sync + TypeUuidDynamic,

impl<T> Resource for T where
T: 'static + Send + Sync,