Struct four_bar::plot::FigureBase

pub struct FigureBase<'a, 'b, M: Clone, C: Clone> {
    pub fb: Option<Cow<'b, M>>,
    pub angle: Option<f64>,
    pub lines: Vec<Rc<RefCell<LineData<'a, C>>>>,
    pub opt: Opt<'a>,
}

Available on crate feature plot only.

Option type base.

Fields

fb: Option<Cow<'b, M>>

Linkage

angle: Option<f64>

Input angle

lines: Vec<Rc<RefCell<LineData<'a, C>>>>

Line data

opt: Opt<'a>

Drawing options

Implementations

impl FigureBase<'_, '_, FourBarBase<UnNorm, NormFourBar>, [f64; 2]>

pub fn plot<B, R>( &self, root: R ) -> Result<(), DrawingAreaErrorKind<<B as DrawingBackend>::ErrorType>>where B: DrawingBackend, DrawingArea<B, Shift>: From<R>,

Plot 2D curves and linkages.

use four_bar::{plot::*, plot2d, FourBar};
let fb = FourBar::example();
let mut buf = String::new();
plot2d::Figure::from(&fb)
    .axis(false)
    .add_line("First Curve", fb.curve(180), Style::Line, BLACK)
    .plot(SVGBackend::with_string(&mut buf, (1600, 1600)))
    .unwrap();

impl FigureBase<'_, '_, FourBarBase<UnNorm, SNormFourBar>, [f64; 3]>

pub fn plot<B, R>( &self, root: R ) -> Result<(), DrawingAreaErrorKind<<B as DrawingBackend>::ErrorType>>where B: DrawingBackend, DrawingArea<B, Shift>: From<R>,

Plot 3D spherical linkage.

Please see Opt for more options.

use four_bar::{plot3d::*, SFourBar};
let fb = SFourBar::example();
let mut buf = String::new();
Figure::from(&fb)
    .axis(false)
    .add_line("First Curve", fb.curve(180), Style::Line, BLACK)
    .plot(SVGBackend::with_string(&mut buf, (1600, 1600)))
    .unwrap();

impl<'a, 'b, M: Clone, C: Clone> FigureBase<'a, 'b, M, C>

pub fn new(fb: Option<M>) -> Self

Create a new instance with linkage.

pub fn new_ref(fb: Option<&'b M>) -> Self

From an optional linkage setting.

pub fn with_fb(self, fb: M) -> Self

Attach linkage.

pub fn with_fb_ref(self, fb: &'b M) -> Self

Attach linkage with its reference.

pub fn remove_fb(self) -> Self

Remove linkage.

pub fn angle(self, angle: f64) -> Self

Set the input angle of the linkage.

If the angle value is not in the range of fb::FourBarBase::angle_bound(), the actual angle will be the midpoint.

pub fn font_family(self, family: impl Into<Cow<'a, str>>) -> Self

Set the font family.

pub fn stroke(self, stroke: u32) -> Self

Set the line stroke of the linkage.

pub fn font(self, font: f64) -> Self

Set font size.

pub fn grid(self, grid: bool) -> Self

Use grid in the plot.

pub fn axis(self, axis: bool) -> Self

Show the axis.

pub fn legend(self, legend: LegendPos) -> Self

Set legend position.

pub fn with_opt(self, opt: Opt<'a>) -> Self

Set the inner options.

pub fn add_line<S, L>( self, label: S, line: L, style: Style, color: RGBColor ) -> Selfwhere S: Into<Cow<'a, str>>, L: Into<Cow<'a, [C]>>,

Add a line.

pub fn add_line_data(self, data: LineData<'a, C>) -> Self

Add a line from a LineData instance.

pub fn push_line<S, L>( &mut self, label: S, line: L, style: Style, color: RGBColor )where S: Into<Cow<'a, str>>, L: Into<Cow<'a, [C]>>,

Add a line in-placed.

pub fn push_line_data(&mut self, data: LineData<'a, C>)

Add a line from a LineData instance in-placed.

pub fn push_line_default<S, L>(&mut self, label: S, line: L)where S: Into<Cow<'a, str>>, L: Into<Cow<'a, [C]>>,

Add a line with default settings in-placed.

pub fn lines(&self) -> impl Iterator<Item = Ref<'_, LineData<'a, C>>>

Iterate over lines.

pub fn lines_mut(&mut self) -> &mut Vec<Rc<RefCell<LineData<'a, C>>>>

Get a mutable reference to the lines.

Trait Implementations

impl<'a, 'b, M: Clone + Clone, C: Clone + Clone> Clone for FigureBase<'a, 'b, M, C>

fn clone(&self) -> FigureBase<'a, 'b, M, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Clone, C: Clone> Default for FigureBase<'_, '_, M, C>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, M: Clone, C: Clone> Deref for FigureBase<'a, '_, M, C>

type Target = Opt<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, M: Clone, C: Clone> DerefMut for FigureBase<'a, '_, M, C>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, 'a, 'b, M, C> Deserialize<'de> for FigureBase<'a, 'b, M, C>where FigureBase<'a, 'b, M, C>: Default, M: Deserialize<'de> + Clone, C: Deserialize<'de> + Clone,

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

Deserialize this value from the given Serde deserializer.

impl<'a, 'b, M, C> Serialize for FigureBase<'a, 'b, M, C>where M: Serialize + Clone, C: Serialize + Clone,

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

Serialize this value into the given Serde serializer.