Geometry

Types representing geometric concepts such as points, sizes, rectangles, and vectors. More...

Classes
class	peak::common::detail::PointXd< T, dimension >
	A point in space with configurable dimensionality and coordinate type. More...
class	peak::common::detail::PointT< T >
	2D point template type. More...
class	peak::common::detail::RectangleT< PointType, SizeType >
	A generic rectangle defined by a point and a size. More...
class	peak::common::detail::SizeT< T >
	Represents a two-dimensional size with non-negative width and height. More...

Typedefs
using	peak::common::Point = detail::PointT<int32_t>
	2D point with 32-bit signed integer coordinates.
using	peak::common::PointF = detail::PointT<float>
	2D point with single-precision floating-point coordinates.
using	peak::common::PointU = detail::PointT<uint32_t>
	2D point with 32-bit unsigned integer coordinates.
using	peak::common::Rectangle = detail::RectangleT<int32_t, uint32_t>
	Rectangle with integer coordinates and unsigned dimensions.
using	peak::common::RectangleF = detail::RectangleT<float, float>
	Rectangle with floating-point coordinates and dimensions.
using	peak::common::RectangleU = detail::RectangleT<uint32_t, uint32_t>
	Rectangle with unsigned coordinates and unsigned dimensions.
using	peak::common::Size = detail::SizeT<uint32_t>
	Size with unsigned 32-bit integer dimensions.
using	peak::common::SizeF = detail::SizeT<float>
	Size with floating-point dimensions.
using	peak::common::VectorF = peak::common::PointF
	Alias for a 2D point with floating point coordinates.

Detailed Description

Types representing geometric concepts such as points, sizes, rectangles, and vectors.

This subgroup focuses on types commonly used to represent and manipulate geometric data. It includes templates and type aliases for points, rectangles, sizes, and vectors, which are useful in image processing, spatial computations, and graphical applications.

Since

ids_peak_common 1.0

Typedef Documentation

Point

using peak::common::Point = detail::PointT<int32_t>

2D point with 32-bit signed integer coordinates.

Provides a stable and public alias for a 2D point type using signed 32-bit integers. This alias is intended for general use in user code.

Direct usage of detail::PointT<int32_t> is discouraged, as internal implementations may change. Always use this public alias for forward compatibility.

Since

ids_peak_common 1.0

PointF

using peak::common::PointF = detail::PointT<float>

2D point with single-precision floating-point coordinates.

Provides a stable and public alias for a 2D point type using single-precision floating-point values. This alias is intended for general use in user code.

Direct usage of detail::PointT<float> is discouraged, as internal implementations may change. Always use this public alias for forward compatibility.

Since

ids_peak_common 1.0

PointU

using peak::common::PointU = detail::PointT<uint32_t>

2D point with 32-bit unsigned integer coordinates.

Public alias for a 2D point type based on 32-bit unsigned integers. This alias is intended for general use in user code.

Direct usage of detail::PointT<uint32_t> is discouraged, as internal implementations may change. Always use this public alias for forward compatibility.

Since

ids_peak_common 1.0

Rectangle

using peak::common::Rectangle = detail::RectangleT<int32_t, uint32_t>

Rectangle with integer coordinates and unsigned dimensions.

Provides a stable and public alias for a rectangle type using int32_t for position and uint32_t for size.

This alias is intended for general use in user code.

Direct usage of detail::RectangleT<int32_t, uint32_t> is discouraged, as internal implementations may change. Always use this public alias for forward compatibility.

Since

ids_peak_common 1.0

RectangleF

using peak::common::RectangleF = detail::RectangleT<float, float>

Rectangle with floating-point coordinates and dimensions.

Provides a stable and public alias for a rectangle type using float for both position and size.

This alias is intended for general use in user code.

Direct usage of detail::RectangleT<float, float> is discouraged, as internal implementations may change. Always use this public alias for forward compatibility.

Since

ids_peak_common 1.0

RectangleU

using peak::common::RectangleU = detail::RectangleT<uint32_t, uint32_t>

Rectangle with unsigned coordinates and unsigned dimensions.

Provides a stable and public alias for a rectangle type using uint32_t for position and uint32_t for size.

This alias is intended for general use in user code.

Direct usage of detail::RectangleT<uint32_t, uint32_t> is discouraged, as internal implementations may change. Always use this public alias for forward compatibility.

Since

ids_peak_common 1.1

Size

using peak::common::Size = detail::SizeT<uint32_t>

Size with unsigned 32-bit integer dimensions.

Provides a stable and public alias for a size type where width and height are represented as uint32_t.

This alias is intended for general use in user code.

Direct usage of detail::SizeT<uint32_t> is discouraged, as internal implementations may change. Always use this public alias for forward compatibility.

Since

ids_peak_common 1.0

SizeF

using peak::common::SizeF = detail::SizeT<float>

Size with floating-point dimensions.

Provides a stable and public alias for a size type where width and height are represented as float, suitable for precise or fractional dimensions.

This alias is intended for general use in user code.

Direct usage of detail::SizeT<float> is discouraged, as internal implementations may change. Always use this public alias for forward compatibility.

Since

ids_peak_common 1.0

VectorF

using peak::common::VectorF = peak::common::PointF

Alias for a 2D point with floating point coordinates.

Represents a 2D vector or point using float precision.

Since

ids_peak_common 1.0