#include <hikogui/widgets/widget_layout.hpp>

Public Member Functions
constexpr	widget_layout (widget_layout const &) noexcept=default

constexpr	widget_layout (widget_layout &&) noexcept=default

constexpr widget_layout &	operator= (widget_layout const &) noexcept=default

constexpr widget_layout &	operator= (widget_layout &&) noexcept=default

constexpr bool	empty () const noexcept

constexpr	operator bool () const noexcept

constexpr bool	contains (point3 mouse_position) const noexcept
	Check if the mouse position is inside the widget.

constexpr aarectangle	rectangle () const noexcept

constexpr aarectangle	rectangle_on_window () const noexcept
	Get the rectangle in window coordinate system.

constexpr aarectangle	clipping_rectangle_on_window () const noexcept
	Get the clipping rectangle in window coordinate system.

constexpr aarectangle	clipping_rectangle_on_window (aarectangle narrow_clipping_rectangle) const noexcept
	Get the clipping rectangle in window coordinate system.

constexpr float	width () const noexcept

constexpr float	height () const noexcept

constexpr bool	left_to_right () const noexcept
	Check if the writing direction is left-to-right.

constexpr bool	right_to_left () const noexcept
	Check if the writing direction is right_to_left.

constexpr	widget_layout (extent2 window_size, gui_window_size window_size_state, hi::font_book &font_book, hi::theme const &theme, hi::subpixel_orientation subpixel_orientation, unicode_bidi_class writing_direction, utc_nanoseconds display_time_point) noexcept
	Construct a widget_layout from inside the window.

constexpr widget_layout	transform (aarectangle const &child_rectangle, float elevation, aarectangle new_clipping_rectangle, widget_baseline new_baseline=widget_baseline{}) const noexcept
	Create a new widget_layout for the child widget.

constexpr widget_layout	transform (aarectangle const &child_rectangle, float elevation=1.0f, widget_baseline new_baseline=widget_baseline{}) const noexcept
	Create a new widget_layout for the child widget.

constexpr widget_layout	transform (aarectangle const &child_rectangle, widget_baseline new_baseline) const noexcept
	Create a new widget_layout for the child widget.

constexpr widget_layout	override_clip (aarectangle new_clipping_rectangle) const noexcept
	Override e context with the new clipping rectangle.

Data Fields
matrix3	to_parent = {}
	This matrix transforms local coordinates to the coordinates of the parent widget.

matrix3	from_parent = {}
	This matrix transforms parent widget's coordinates to local coordinates.

matrix3	to_window = {}
	This matrix transforms local coordinates to window coordinates.

matrix3	from_window = {}
	This matrix transforms window coordinates to local coordinates.

extent2	size = {}
	Size of the widget.

extent2	window_size = {}
	Size of the window.

gui_window_size	window_size_state = gui_window_size::normal

hi::font_book *	font_book = nullptr

hi::theme const *	theme = nullptr

aarectangle	clipping_rectangle = {}
	The clipping rectangle.

extent2	sub_pixel_size = {1.0f, 1.0f}
	The size of a sub-pixel.

unicode_bidi_class	writing_direction = unicode_bidi_class::L
	The default writing direction.

utc_nanoseconds	display_time_point = {}
	The layout created for displaying at this time point.

float	baseline = 0.0f
	The base-line in widget local y-coordinate.

Static Public Attributes
static constexpr float	redraw_overhang = 2.0f
	The amount of pixels that the redraw request will overhang the widget.

Friends
constexpr friend bool	operator== (widget_layout const &, widget_layout const &) noexcept=default

Detailed Description

The layout of a widget.

This object is created by a container to position a child-widget within it.

The layout includes:

the size of the widget.
translation matrices between the parent and child widget.
translation matrices between the child widget and the window.
the clipping rectangle when the parent only wants to display a part the child.
if the widget should display itself in left-to-right or right-to-left language mode.
the baseline where text should be drawn.

Constructor & Destructor Documentation

◆ widget_layout()

constexpr hi::v1::widget_layout::widget_layout	(	extent2	window_size,
		gui_window_size	window_size_state,
		hi::font_book &	font_book,
		hi::theme const &	theme,
		hi::subpixel_orientation	subpixel_orientation,
		unicode_bidi_class	writing_direction,
		utc_nanoseconds	display_time_point )

inlineconstexprnoexcept

Construct a widget_layout from inside the window.

Member Function Documentation

◆ clipping_rectangle_on_window() [1/2]

constexpr aarectangle hi::v1::widget_layout::clipping_rectangle_on_window ( ) const

inlineconstexprnoexcept

Get the clipping rectangle in window coordinate system.

◆ clipping_rectangle_on_window() [2/2]

constexpr aarectangle hi::v1::widget_layout::clipping_rectangle_on_window ( aarectangle narrow_clipping_rectangle ) const

inlineconstexprnoexcept

Get the clipping rectangle in window coordinate system.

Parameters

narrow_clipping_rectangle A clipping rectangle in local coordinate system that will be intersected with the layout's clipping rectangle.

◆ contains()

constexpr bool hi::v1::widget_layout::contains ( point3 mouse_position ) const

inlineconstexprnoexcept

Check if the mouse position is inside the widget.

Parameters

mouse_position The mouse position in local coordinates.

Returns: True if the mouse position is on the widget and is not clipped.

◆ left_to_right()

constexpr bool hi::v1::widget_layout::left_to_right ( ) const

inlineconstexprnoexcept

Check if the writing direction is left-to-right.

◆ override_clip()

constexpr widget_layout hi::v1::widget_layout::override_clip ( aarectangle new_clipping_rectangle ) const

inlineconstexprnoexcept

Override e context with the new clipping rectangle.

Parameters

new_clipping_rectangle The new clipping rectangle.

Returns: A new context that is clipped..

◆ rectangle_on_window()

constexpr aarectangle hi::v1::widget_layout::rectangle_on_window ( ) const

inlineconstexprnoexcept

Get the rectangle in window coordinate system.

◆ right_to_left()

constexpr bool hi::v1::widget_layout::right_to_left ( ) const

inlineconstexprnoexcept

Check if the writing direction is right_to_left.

◆ transform() [1/3]

constexpr widget_layout hi::v1::widget_layout::transform	(	aarectangle const &	child_rectangle,
		float	elevation,
		aarectangle	new_clipping_rectangle,
		widget_baseline	new_baseline = widget_baseline{} ) const

inlineconstexprnoexcept

Create a new widget_layout for the child widget.

Parameters

child_rectangle	The location and size of the child widget, relative to the current widget.
elevation	The elevation of the child widget, relative to the current widget.
new_clipping_rectangle	The new clipping rectangle of the child widget, relative to the current widget.
new_baseline	The baseline to use by the child widget.

Returns: A new widget_layout for use by the child widget.

◆ transform() [2/3]

constexpr widget_layout hi::v1::widget_layout::transform	(	aarectangle const &	child_rectangle,
		float	elevation = 1.0f,
		widget_baseline	new_baseline = widget_baseline{} ) const

inlineconstexprnoexcept

Create a new widget_layout for the child widget.

Parameters

child_rectangle	The location and size of the child widget, relative to the current widget.
elevation	The relative elevation of the child widget compared to the current widget.
new_baseline	The relative baseline of the child widgets on the same row.

Returns: A new widget_layout for use by the child widget.

◆ transform() [3/3]

constexpr widget_layout hi::v1::widget_layout::transform	(	aarectangle const &	child_rectangle,
		widget_baseline	new_baseline ) const

inlineconstexprnoexcept

Create a new widget_layout for the child widget.

Parameters

child_rectangle	The location and size of the child widget, relative to the current widget.
new_baseline	The relative baseline of the child widgets on the same row.

Returns: A new widget_layout for use by the child widget.

Field Documentation

◆ baseline

float hi::v1::widget_layout::baseline = 0.0f

The base-line in widget local y-coordinate.

◆ clipping_rectangle

aarectangle hi::v1::widget_layout::clipping_rectangle = {}

The clipping rectangle.

This is the rectangle that all drawing must be clipped to. This rectangle often includes the margin, as widget may draw in their own margin.

The clipping rectangle may be smaller than the widget, or even empty when the widget is scrolled outside of the aperture of a scroll widget.

Note: widget's coordinate system.

◆ display_time_point

utc_nanoseconds hi::v1::widget_layout::display_time_point = {}

The layout created for displaying at this time point.

◆ from_parent

matrix3 hi::v1::widget_layout::from_parent = {}

This matrix transforms parent widget's coordinates to local coordinates.

◆ from_window

matrix3 hi::v1::widget_layout::from_window = {}

This matrix transforms window coordinates to local coordinates.

◆ redraw_overhang

constexpr float hi::v1::widget_layout::redraw_overhang = 2.0f

staticconstexpr

The amount of pixels that the redraw request will overhang the widget.

Widgets are allowed to draw inside their margins, in most cases this will just be a border.

◆ size

extent2 hi::v1::widget_layout::size = {}

Size of the widget.

◆ sub_pixel_size

extent2 hi::v1::widget_layout::sub_pixel_size = {1.0f, 1.0f}

The size of a sub-pixel.

Note: the sub-pixel-size is represented in the widget's coordinate system.

◆ to_parent

matrix3 hi::v1::widget_layout::to_parent = {}

This matrix transforms local coordinates to the coordinates of the parent widget.

◆ to_window

matrix3 hi::v1::widget_layout::to_window = {}

This matrix transforms local coordinates to window coordinates.

◆ window_size

extent2 hi::v1::widget_layout::window_size = {}

Size of the window.

◆ writing_direction

unicode_bidi_class hi::v1::widget_layout::writing_direction = unicode_bidi_class::L

The default writing direction.

Note: Must be either L or R.

The documentation for this class was generated from the following file:

hikogui/src/hikogui/widgets/widget_layout.hpp

Public Member Functions

Data Fields

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ widget_layout()

Member Function Documentation

◆ clipping_rectangle_on_window() [1/2]

◆ clipping_rectangle_on_window() [2/2]

◆ contains()

◆ left_to_right()

◆ override_clip()

◆ rectangle_on_window()

◆ right_to_left()

◆ transform() [1/3]

◆ transform() [2/3]

◆ transform() [3/3]

Field Documentation

◆ baseline

◆ clipping_rectangle

◆ display_time_point

◆ from_parent

◆ from_window

◆ redraw_overhang

◆ size

◆ sub_pixel_size

◆ to_parent

◆ to_window

◆ window_size

◆ writing_direction