Struct atoll::grid::RoutingGrid

pub struct RoutingGrid<L> {
    pub stack: LayerStack<L>,
    /* private fields */
}

A fixed-size routing grid.

Does not store the state of track points in the grid. For that functionality, see RoutingState.

Fields

stack: LayerStack<L>

The layer stack.

Implementations

impl<L> RoutingGrid<L>

pub fn new(stack: LayerStack<L>, layers: Range<usize>) -> Self

Creates a new routing grid with the given properties.

pub fn layers(&self) -> Range<usize>

Returns the set of layers contained in this grid.

pub fn slice(&self) -> LayerSlice<'_, L>

The layer slice representing the layers used by this routing grid.

impl<L: AtollLayer> RoutingGrid<L>

pub fn track_span(&self, layer: usize, track: i64) -> Span

Calculates the span of a particular track on the given layer.

pub fn tracks(&self, layer: usize) -> UniformTracks

The tracks on the given layer.

pub fn track_grid(&self, layer: usize) -> (UniformTracks, UniformTracks)

Returns the track grid for the given layer.

Returns a tuple containing the vertical going tracks followed by the horizontal going tracks. In other words, the first element of the tuple is indexed by an x-coordinate, and the second element of the tuple is indexed by a y-coordinate.

pub fn track(&self, layer: usize, track: i64, start: i64, end: i64) -> Rect

Calculates the bounds of a particular track on the given layer.

The start and end coordinates are with respect to tracks on the grid defining layer.

pub fn track_point(&self, layer: usize, track: i64, cross_track: i64) -> Point

Returns the physical coordinates of the grid point defined by the given track and cross_track on layer layer, where track is the track on layer and cross_track is a perpendicular track.

pub fn xy_track_point(&self, layer: usize, x_track: i64, y_track: i64) -> Point

Returns the physical coordinates of the grid point defined by the given x_track and y_track on layer layer.

pub fn point_to_grid( &self, p: Point, layer: usize, round_x: RoundingMode, round_y: RoundingMode ) -> Point

Rounds the given point to the routing grid, returning a point in track coordinates on the given layer.

pub fn shrink_to_grid(&self, rect: Rect, layer: usize) -> Option<Rect>

Rounds the given point to the routing grid, returning a point in track coordinates on the given layer.

Rounds in the direction that makes the rectangle smaller. If the resulting rectangle contains no track points, returns None.

pub fn expand_to_grid(&self, rect: Rect, layer: usize) -> Rect

Rounds the given point to the routing grid, returning a point in track coordinates on the given layer.

Rounds in the direction that makes the rectangle larger.

Trait Implementations

impl<L: Clone> Clone for RoutingGrid<L>

fn clone(&self) -> RoutingGrid<L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L: Debug> Debug for RoutingGrid<L>

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

Formats the value using the given formatter.

impl<'de, L> Deserialize<'de> for RoutingGrid<L>

where L: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<L: Hash> Hash for RoutingGrid<L>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<L: PartialEq> PartialEq for RoutingGrid<L>

fn eq(&self, other: &RoutingGrid<L>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<L> Serialize for RoutingGrid<L>

where L: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<L: Eq> Eq for RoutingGrid<L>

impl<L> StructuralPartialEq for RoutingGrid<L>