Struct Shape

pub struct Shape {
    pub width: u32,
    pub height: u32,
}

Shape

A Shape represents a 2D rectangular area using a width and height.
It is used extensively for defining bounds, tilemaps, collision areas, and spatial logic.

---

Struct Definition

pub struct Shape {
    pub width: u32,
    pub height: u32,
}

---

Constructors

Shape::new(width, height)

Creates a shape with the specified width and height.

use rpgx::prelude::*;

let shape = Shape::new(3, 4); // → Shape { width: 3, height: 4 }

Shape::from_square(side)

Creates a square with equal width and height.

Shape::from_rectangle(width, height)

Alias for new.

Shape::from_bounds(start, end)

Creates a shape that spans the rectangular area between two Coordinates.

use rpgx::prelude::*;

let shape = Shape::from_bounds(Coordinates::new(2, 3), Coordinates::new(5, 6));
// → Shape { width: 3, height: 3 }

Shape::bounding_shape(&[Shape])

Returns the minimal shape that fully contains all provided shapes by taking the component-wise maximum.

---

Methods

shape.area() -> u32

Returns the number of cells in the shape (width × height).

shape.union(other) -> Shape

Returns a new Shape that is the union of two shapes, taking the max of each dimension.

shape.in_bounds(coord) -> bool

Returns true if the coordinate lies within the shape’s dimensions.

shape.delta_in_bounds(delta) -> bool

Checks whether the given delta lies within the shape (non-negative and less than width/height).

shape.offset_by(coord) -> Shape

Returns a new shape with width and height increased by coord.x and coord.y.

shape.expand_to_include(offset, other)

Expands the shape to fit another shape placed at offset.

shape.coordinates_in_range(start, end) -> Vec<Coordinates>

Returns a vector of Coordinates clamped within the shape bounds.

shape.filter_coordinates(predicate) -> Vec<Coordinates>

Iterates all coordinates in the shape and returns only those matching the filter function:

use rpgx::prelude::*;

let shape = Shape::from_rectangle(3, 3);
let diagonal = shape.filter_coordinates(|c, _| c.x == c.y);
// → [ (0,0), (1,1), (2,2) ]

---

Operators

Shape + Shape

Adds width and height component-wise, saturating on overflow.

Shape - Shape

Subtracts width and height component-wise with saturation.

Shape + u32 / Shape - u32

Adds or subtracts the scalar from both width and height.

Shape + Coordinates / Shape - Coordinates

Adds or subtracts the coordinate’s x/y values from width/height.

Shape / u32

Divides both width and height by the scalar.

---

Examples

use rpgx::prelude::*;

let a = Shape::from_rectangle(4, 2);
let b = Shape::from_square(3);

let union = a.union(b);            // Shape { width: 4, height: 3 }
let expanded = a + Coordinates::new(1, 2); // Shape { width: 5, height: 4 }
let area = b.area();               // 9

---

Design Notes

• Shape defines non-positional size, unlike Coordinates.
• Used in tilemaps, viewports, bounding box math, and placement calculations.
• Prefer Shape for absolute space coverage, Delta for movement, and Coordinates for positions.

---

See Also

• Coordinates – 2D positions
• Delta – signed directional offsets
• Map, Layer Represents a rectangular area by its width and height.

Fields

width: u32

height: u32

Implementations

impl Shape

Constructors

pub fn new(width: u32, height: u32) -> Self

pub fn from_square(side: u32) -> Self

Creates a square shape with equal width and height.

pub fn from_rectangle(width: u32, height: u32) -> Self

Creates a rectangular shape from width and height.

pub fn from_bounds(start: Coordinates, end: Coordinates) -> Self

Creates a shape that covers the area between two coordinates.

pub fn bounding_shape(shapes: &[Self]) -> Self

Computes the smallest shape that can encompass all given shapes.

impl Shape

Core utilities

pub fn union(&self, other: Shape) -> Self

Computes the union of two shapes by taking the max of each dimension.

pub fn in_bounds(&self, coordinates: Coordinates) -> bool

Checks if the given coordinates fall within the shape.

pub fn delta_in_bounds(&self, delta: Delta) -> bool

Checks if the given delta is within bounds (non-negative and smaller than shape).

pub fn area(&self) -> u32

Returns the area (width * height) of this shape.

pub fn offset_by(&self, offset: Coordinates) -> Self

Returns a new shape offset by the given coordinates.

pub fn expand_to_include(&mut self, offset: Coordinates, other: Shape)

Expands this shape to include another shape placed at an offset.

impl Shape

Iteration and filtering

pub fn coordinates_in_range( &self, start: Coordinates, end: Coordinates, ) -> Vec<Coordinates>

Iterates through coordinates in a given range clamped by this shape.

pub fn filter_coordinates<F>(&self, filter_fn: F) -> Vec<Coordinates>

where F: FnMut(Coordinates, Shape) -> bool,

Returns coordinates that satisfy a filter predicate.

Trait Implementations

impl Add<Coordinates> for Shape

Arithmetic with coordinates

type Output = Shape

The resulting type after applying the + operator.

fn add(self, coordinates: Coordinates) -> Shape

Performs the + operation.

impl Add<Shape> for Coordinates

fn add(self, shape: Shape) -> Coordinates

Adds a Shape (width, height) to the coordinate.

type Output = Coordinates

The resulting type after applying the + operator.

impl Add<u32> for Shape

Arithmetic with scalar values

type Output = Shape

The resulting type after applying the + operator.

fn add(self, value: u32) -> Shape

Performs the + operation.

impl Add for Shape

Arithmetic operations between Shapes

type Output = Shape

The resulting type after applying the + operator.

fn add(self, other: Shape) -> Shape

Performs the + operation.

impl Clone for Shape

fn clone(&self) -> Shape

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Shape

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

Formats the value using the given formatter.

impl Default for Shape

fn default() -> Shape

Returns the “default value” for a type.

impl Div<u32> for Shape

Allows dividing the dimensions of a shape by a scalar.

type Output = Shape

The resulting type after applying the / operator.

fn div(self, divisor: u32) -> Shape

Performs the / operation.

impl PartialEq for Shape

fn eq(&self, other: &Shape) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Sub<Coordinates> for Shape

type Output = Shape

The resulting type after applying the - operator.

fn sub(self, coordinates: Coordinates) -> Shape

Performs the - operation.

impl Sub<Shape> for Coordinates

fn sub(self, shape: Shape) -> Coordinates

Subtracts a Shape (width, height) from the coordinate using saturating subtraction.

type Output = Coordinates

The resulting type after applying the - operator.

impl Sub<u32> for Shape

type Output = Shape

The resulting type after applying the - operator.

fn sub(self, value: u32) -> Shape

Performs the - operation.

impl Sub for Shape

type Output = Shape

The resulting type after applying the - operator.

fn sub(self, other: Shape) -> Shape

Performs the - operation.

impl Copy for Shape

impl Eq for Shape

impl StructuralPartialEq for Shape