Skip to main content

BlockShape

Struct BlockShape 

Source
pub struct BlockShape<'a> {
    pub block: &'a Block,
    pub pins: Vec<(PinId, &'a Pin)>,
    pub structure: Structure,
}
Expand description

A block with the pins the caller resolved for it. In the document a pin is its own entity owned by the block, so nothing about a block’s boundary can be read off the block alone; the scope that draws it hands the set in, in the order it wants them painted.

Fields§

§block: &'a Block§pins: Vec<(PinId, &'a Pin)>§structure: Structure

Whether the block holds blocks of its own — crate::path::structure, resolved by the scope that built the shape, since a block’s interior is no more readable off the block alone than its pins are.

Implementations§

Source§

impl<'a> BlockShape<'a>

Source

pub fn new( block: &'a Block, pins: Vec<(PinId, &'a Pin)>, structure: Structure, ) -> Self

Source

pub fn rect(&self) -> Rect

Source

pub fn lock(&self) -> InterfaceLock

The block’s InterfaceLock state, for passing to functions that branch on it.

Source

pub fn accent_role(&self) -> Role

The Role the block’s outline strokes with, chosen by its accent role register: Accent1..=Accent8Role::Accent0..Role::Accent7, the plain Accent0Role::AccentDefault.

Source

fn offsets(&self) -> impl Iterator<Item = u32> + '_

Source

pub fn is_pin_location_available(&self, location: PinLocation) -> bool

Source

pub fn is_pin_location_available_excluding( &self, location: PinLocation, except: Option<PinId>, ) -> bool

Like Self::is_pin_location_available, but ignores the pin except (so a pin being dragged doesn’t block its own move).

Source

pub fn resize_pin_shift(&self, new_height: f32) -> u32

How many slots every pin shifts up when the block is resized to new_height (see the free resize_pin_shift).

Source

pub fn pin_anchor_at(&self, rect: Rect, side: PinSide, offset: u32) -> Pos2

Where a pin sitting at (side, offset) anchors its wire when the block is drawn at rect — the slot-parameterized core of BaseShape::anchor_point_with_rect, shared with drag previews that preview a pin at a hypothetical slot without moving it. Applies the same upward shift the block’s render preview uses, so a route re-routed against a shrunk preview rect tracks where the pin will land; at the block’s real height the shift is zero.

Source

fn title_label(&self) -> ShapeLabel<'a>

Source

fn type_label_of(&self) -> ShapeLabel<'a>

Source

fn committed_rect(&self, mode: RenderMode) -> Rect

The grid-committed rect a block renders its frame and pins at for mode (a drag/resize preview snaps to grid on commit). Shared by BaseShape::render_ng and Self::render_pins_ng so the body and pin passes stay aligned.

Source

pub fn render_pins_ng<R: Renderer>( &self, accents: ShapeAccents<'_>, mode: RenderMode, painter: &mut Style<'_, R>, )

Draw only the block’s pin layer for mode — stubs, names, tags, the selection placeholders, and the drag/resize previews. Split out of BaseShape::render_ng so the scene can draw it in a later pass, on top of a block’s icon (see crate::widget::DrawingPasses).

Trait Implementations§

Source§

impl BaseShape for BlockShape<'_>

Source§

fn pin_drop_candidate( &self, pin_id: PinId, side: PinSide, raw_offset_px: f32, ) -> Option<u32>

The slot a dragged pin would snap to (its grid offset), or None if no free slot is available near the raw drop position. Tries the nearest slot, then the adjacent slot on the other side of the raw drop position. The drop’s own write (crate::edit::geometry::move_pin) is handed the slot this resolved, so the live preview lands exactly where the commit will.

Source§

fn title(&self) -> Option<ShapeLabel<'_>>

Source§

fn type_label(&self) -> Option<ShapeLabel<'_>>

Source§

fn gui_rect(&self) -> Rect

Source§

fn pin(&self, id: PinId) -> Option<&Pin>

Source§

fn anchor_point_with_rect(&self, rect: Rect, id: PinId) -> Option<Pos2>

Source§

fn pin_text_rect<R: Renderer>( &self, id: PinId, painter: &Style<'_, R>, ) -> Option<Rect>

Source§

fn pin_type_rect<R: Renderer>( &self, id: PinId, painter: &Style<'_, R>, ) -> Option<Rect>

Bounding box of a pin’s type label (the smaller second line below the name), for hit-testing a double-click on the type. None for shapes without such a pin.
Source§

fn tag_text_rect_for<R: Renderer>( &self, id: PinId, text: &str, painter: &Style<'_, R>, ) -> Option<Rect>

Bounding box of a pin’s tag label (drawn above the stub line), sized for an explicit text. None if the shape has no such pin. Callers pass the “+tag” placeholder for an empty tag so the prompt stays a hit/edit target.
Source§

fn pin_stub_rect(&self, id: PinId) -> Option<Rect>

Clickable hit region around a pin’s stub (the red line).
Source§

fn new_pin_locations(&self) -> Vec<PinLocation>

Source§

fn pin_position(&self, location: PinLocation) -> Option<Pos2>

Source§

fn title_anchor(&self) -> Option<Pos2>

Source§

fn type_anchor(&self) -> Option<Pos2>

Source§

fn resizable(&self) -> bool

Source§

fn render_ng<R: Renderer>(&self, mode: RenderMode, painter: &mut Style<'_, R>)

Render this shape. A block draws its own tag label from its decorations, so no external id is needed.
Source§

fn constrain_resize_delta(&self, delta: Vec2) -> Vec2

Auto Trait Implementations§

§

impl<'a> Freeze for BlockShape<'a>

§

impl<'a> RefUnwindSafe for BlockShape<'a>

§

impl<'a> Send for BlockShape<'a>

§

impl<'a> Sync for BlockShape<'a>

§

impl<'a> Unpin for BlockShape<'a>

§

impl<'a> UnsafeUnpin for BlockShape<'a>

§

impl<'a> UnwindSafe for BlockShape<'a>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

§

impl<D> OwoColorize for D

§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either [OwoColorize::fg] or a color-specific method, such as [OwoColorize::green], Read more
§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either [OwoColorize::bg] or a color-specific method, such as [OwoColorize::on_yellow], Read more
§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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