Struct PdfRect

pub struct PdfRect {
    pub bottom: PdfPoints,
    pub left: PdfPoints,
    pub top: PdfPoints,
    pub right: PdfPoints,
}

A rectangle measured in PdfPoints.

The coordinate space of a PdfPage has its origin (0,0) at the bottom left of the page, with x values increasing as coordinates move horizontally to the right and y values increasing as coordinates move vertically up.

Fields

bottom: PdfPoints

👎Deprecated since 0.8.28: Use the PdfRect::bottom() function instead of direct field access. Direct field access will be removed in release 0.9.0.

left: PdfPoints

👎Deprecated since 0.8.28: Use the PdfRect::left() function instead of direct field access. Direct field access will be removed in release 0.9.0.

top: PdfPoints

👎Deprecated since 0.8.28: Use the PdfRect::top() function instead of direct field access. Direct field access will be removed in release 0.9.0.

right: PdfPoints

👎Deprecated since 0.8.28: Use the PdfRect::left() function instead of direct field access. Direct field access will be removed in release 0.9.0.

Implementations

impl PdfRect

pub const ZERO: PdfRect

A PdfRect object with the identity value (0.0, 0.0, 0.0, 0.0).

pub const MAX: PdfRect

A PdfRect object that encloses the entire addressable PdfPage coordinate space of ([-PdfPoints::MAX], [-PdfPoints::MAX], PdfPoints::MAX, PdfPoints::MAX).

pub const fn new( bottom: PdfPoints, left: PdfPoints, top: PdfPoints, right: PdfPoints, ) -> Self

Creates a new PdfRect from the given PdfPoints measurements.

The coordinate space of a PdfPage has its origin (0,0) at the bottom left of the page, with x values increasing as coordinates move horizontally to the right and y values increasing as coordinates move vertically up.

pub const fn new_from_values( bottom: f32, left: f32, top: f32, right: f32, ) -> Self

Creates a new PdfRect from the given raw points values.

The coordinate space of a PdfPage has its origin (0,0) at the bottom left of the page, with x values increasing as coordinates move horizontally to the right and y values increasing as coordinates move vertically up.

pub const fn zero() -> Self

Creates a new PdfRect object with all values set to 0.0.

Consider using the compile-time constant value PdfRect::ZERO rather than calling this function directly.

pub const fn left(&self) -> PdfPoints

Returns the left-most extent of this PdfRect.

pub const fn right(&self) -> PdfPoints

Returns the right-most extent of this PdfRect.

pub const fn bottom(&self) -> PdfPoints

Returns the bottom-most extent of this PdfRect.

pub const fn top(&self) -> PdfPoints

Returns the top-most extent of this PdfRect.

pub fn width(&self) -> PdfPoints

Returns the width of this PdfRect.

pub fn height(&self) -> PdfPoints

Returns the height of this PdfRect.

pub fn contains(&self, x: PdfPoints, y: PdfPoints) -> bool

Returns true if the given point lies inside this PdfRect.

pub fn contains_x(&self, x: PdfPoints) -> bool

Returns true if the given horizontal coordinate lies inside this PdfRect.

pub fn contains_y(&self, y: PdfPoints) -> bool

Returns true if the given vertical coordinate lies inside this PdfRect.

pub fn is_inside(&self, other: &PdfRect) -> bool

Returns true if the bounds of this PdfRect lie entirely within the given rectangle.

pub fn does_overlap(&self, other: &PdfRect) -> bool

Returns true if the bounds of this PdfRect lie at least partially within the given rectangle.

pub fn transform(&self, matrix: PdfMatrix) -> PdfRect

Returns the result of applying the given PdfMatrix to each corner point of this PdfRect.

pub fn to_quad_points(&self) -> PdfQuadPoints

Returns the PdfQuadPoints quadrilateral representation of this PdfRect.

Trait Implementations

impl Clone for PdfRect

fn clone(&self) -> PdfRect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PdfRect

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

Formats the value using the given formatter.

impl Display for PdfRect

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

Formats the value using the given formatter.

impl Hash for PdfRect

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 PartialEq for PdfRect

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

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

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 Copy for PdfRect

impl Eq for PdfRect