An abstract description of a rectangle with integer coordinates. More...

#include <rect.hpp>

Inheritance diagram for rect:

Public Member Functions
constexpr	rect ()
	Explicitly initialize rects to 0. More...

constexpr	rect (const SDL_Rect &r)
	There's nothing extra when converting an SDL_Rect. More...

constexpr	rect (int x, int y, int w, int h)
	Specify via (x, y, w, h). More...

constexpr	rect (const point &pos, const point &size)
	Specify via top-left corner position and size. More...

constexpr point	pos () const

constexpr point	size () const

bool	operator== (const rect &r) const

bool	operator== (const SDL_Rect &r) const

constexpr rect	operator* (int s) const

constexpr rect &	operator*= (int s)

constexpr rect	operator/ (int s) const

constexpr rect &	operator/= (int s)

constexpr int	area () const
	The area of this rectangle, in square pixels. More...

bool	empty () const
	False if both w and h are > 0, true otherwise. More...

bool	contains (int x, int y) const
	Whether the given point lies within the rectangle. More...

bool	contains (const point &p) const

bool	contains (const SDL_Rect &r) const
	Whether the given rectangle is completely contained by this one. More...

bool	overlaps (const SDL_Rect &r) const
	Whether the given rectangle and this rectangle overlap. More...

rect	minimal_cover (const SDL_Rect &r) const
	Calculates the minimal rectangle that completely contains both this rectangle and the given rectangle. More...

rect &	expand_to_cover (const SDL_Rect &r)
	Minimally expand this rect to fully contain another. More...

rect	intersect (const SDL_Rect &r) const
	Calculates the intersection of this rectangle and another; that is, the maximal rectangle that is contained by both. More...

void	clip (const SDL_Rect &r)
	Clip this rectangle by the given rectangle. More...

void	shift (const point &p)
	Shift the rectangle by the given relative position. More...

Detailed Description

An abstract description of a rectangle with integer coordinates.

This is a thin wrapper over SDL_Rect, furnished with utility functions.

As for SDL_Rect, member variables x, y, w and h are public.

Definition at line 46 of file rect.hpp.

Constructor & Destructor Documentation

◆ rect() [1/4]

constexpr rect::rect ( )

inlineconstexpr

Explicitly initialize rects to 0.

Definition at line 50 of file rect.hpp.

Referenced by intersect().

◆ rect() [2/4]

constexpr rect::rect ( const SDL_Rect & r )

inlineconstexpr

There's nothing extra when converting an SDL_Rect.

Definition at line 53 of file rect.hpp.

◆ rect() [3/4]

constexpr rect::rect	(	int	x,
		int	y,
		int	w,
		int	h
	)

inlineconstexpr

Specify via (x, y, w, h).

Definition at line 56 of file rect.hpp.

◆ rect() [4/4]

constexpr rect::rect	(	const point &	pos,
		const point &	size
	)

inlineconstexpr

Specify via top-left corner position and size.

Definition at line 59 of file rect.hpp.

Member Function Documentation

◆ area()

constexpr int rect::area ( ) const

inlineconstexpr

The area of this rectangle, in square pixels.

Definition at line 101 of file rect.hpp.

References h, and w.

Referenced by draw_manager::expose(), and draw_manager::invalidate_region().

◆ clip()

void rect::clip ( const SDL_Rect & r )

Clip this rectangle by the given rectangle.

This rectangle will be reduced to the intersection of both rectangles.

Definition at line 99 of file rect.cpp.

References intersect().

Referenced by gui2::window::expose(), video::read_pixels(), and display::scroll().

◆ contains() [1/3]

bool rect::contains ( const point & p ) const

Definition at line 58 of file rect.cpp.

◆ contains() [2/3]

bool rect::contains ( const SDL_Rect & r ) const

Whether the given rectangle is completely contained by this one.

Definition at line 63 of file rect.cpp.

References h, and w.

◆ contains() [3/3]

bool rect::contains	(	int	x,
		int	y
	)		const

Whether the given point lies within the rectangle.

Definition at line 52 of file rect.cpp.

References p.

Referenced by gui::scrollarea::handle_event(), gui::scrollbar::handle_event(), controller_base::handle_event(), gui::textbox::handle_event(), display::hex_clicked_on(), location_palette_item::hit(), gui::tristate_button::hit(), gui::button::hit(), draw_manager::invalidate_region(), gui2::widget::is_at(), gui2::horizontal_scrollbar::on_positioner(), gui2::slider::on_positioner(), gui2::vertical_scrollbar::on_positioner(), help::help_text_area::item_at::operator()(), help::help_browser::process_event(), gui::widget::process_tooltip_string(), and events::mouse_handler::right_click_show_menu().

◆ empty()

bool rect::empty ( ) const

False if both w and h are > 0, true otherwise.

Definition at line 47 of file rect.cpp.

Referenced by font::floating_label::draw(), display::draw_minimap(), gui2::window::expose(), font::pango_draw_text(), display::recalculate_minimap(), display::render(), and gui2::widget::set_visible_rectangle().

◆ expand_to_cover()

rect & rect::expand_to_cover ( const SDL_Rect & r )

Minimally expand this rect to fully contain another.

Definition at line 84 of file rect.cpp.

Referenced by draw_manager::invalidate_region().

◆ intersect()

rect rect::intersect ( const SDL_Rect & r ) const

Calculates the intersection of this rectangle and another; that is, the maximal rectangle that is contained by both.

Definition at line 90 of file rect.cpp.

References rect().

Referenced by clip(), font::floating_label::draw(), display::draw_invalidated(), draw_manager::expose(), display::expose(), gui2::window::expose(), gui2::window::queue_rerender(), texture::set_src(), texture::set_src_raw(), and gui2::widget::set_visible_rectangle().

◆ minimal_cover()

rect rect::minimal_cover ( const SDL_Rect & r ) const

Calculates the minimal rectangle that completely contains both this rectangle and the given rectangle.

Definition at line 77 of file rect.cpp.

Referenced by draw_manager::expose(), and draw_manager::invalidate_region().

◆ operator*()

constexpr rect rect::operator* ( int s ) const

inlineconstexpr

Definition at line 72 of file rect.hpp.

References h, s, and w.

◆ operator*=()

constexpr rect& rect::operator*= ( int s )

inlineconstexpr

Definition at line 77 of file rect.hpp.

References h, s, and w.

◆ operator/()

constexpr rect rect::operator/ ( int s ) const

inlineconstexpr

Definition at line 86 of file rect.hpp.

References h, s, and w.

◆ operator/=()

constexpr rect& rect::operator/= ( int s )

inlineconstexpr

Definition at line 91 of file rect.hpp.

References h, s, and w.

◆ operator==() [1/2]

bool rect::operator== ( const rect & r ) const

Definition at line 37 of file rect.cpp.

◆ operator==() [2/2]

bool rect::operator== ( const SDL_Rect & r ) const

Definition at line 42 of file rect.cpp.

◆ overlaps()

bool rect::overlaps ( const SDL_Rect & r ) const

Whether the given rectangle and this rectangle overlap.

Definition at line 72 of file rect.cpp.

Referenced by font::floating_label::draw(), display::draw_all_panels(), display::draw_invalidated(), display::draw_label(), display::draw_minimap(), display::draw_panel(), display::draw_reports(), display::expose(), gui::widget::expose(), gui::widget::hidden(), gui2::listbox::list_item_clicked(), and halo::halo_impl::render().

◆ pos()

constexpr point rect::pos ( ) const

inlineconstexpr

Definition at line 64 of file rect.hpp.

Referenced by video::to_output(), and video::update_framebuffer().

◆ shift()

void rect::shift ( const point & p )

Shift the rectangle by the given relative position.

The point's X and Y coordinates will be added to the rectangle's.

Definition at line 104 of file rect.cpp.

Referenced by gui2::widget::draw_background(), gui2::widget::draw_children(), gui2::widget::draw_foreground(), gui2::window::expose(), and gui2::window::queue_rerender().

◆ size()

constexpr point rect::size ( ) const

inlineconstexpr

Definition at line 65 of file rect.hpp.

References h, and w.

Referenced by video::to_output(), and video::update_framebuffer().

The documentation for this struct was generated from the following files:

sdl/rect.hpp
sdl/rect.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ rect() [1/4]

◆ rect() [2/4]

◆ rect() [3/4]

◆ rect() [4/4]

Member Function Documentation

◆ area()

◆ clip()

◆ contains() [1/3]

◆ contains() [2/3]

◆ contains() [3/3]

◆ empty()

◆ expand_to_cover()

◆ intersect()

◆ minimal_cover()

◆ operator*()

◆ operator*=()

◆ operator/()

◆ operator/=()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ overlaps()

◆ pos()

◆ shift()

◆ size()