v1::point2 Class Reference

#include <hikogui/geometry/point2.hpp>

Public Types
using	array_type = simd<float, 4>
using	value_type = array_type::value_type

Public Member Functions
constexpr	point2 (point2 const &) noexcept=default
constexpr	point2 (point2 &&) noexcept=default
constexpr point2 &	operator= (point2 const &) noexcept=default
constexpr point2 &	operator= (point2 &&) noexcept=default
constexpr	operator array_type () const noexcept
	Convert a point to its array_type-nummeric_array.
constexpr	point2 (array_type const &other) noexcept
	Construct a point from a array_type-simd.
constexpr	point2 () noexcept
	Construct a point at the origin of the coordinate system.
constexpr	point2 (float x, float y) noexcept
	Construct a 3D point from x, y and z elements.
constexpr float &	x () noexcept
	Access the x element from the point.
constexpr float &	y () noexcept
	Access the y element from the point.
constexpr float	x () const noexcept
	Access the x element from the point.
constexpr float	y () const noexcept
	Access the y element from the point.
constexpr point2 &	operator+= (vector2 const &rhs) noexcept
constexpr point2 &	operator-= (vector2 const &rhs) noexcept
constexpr bool	holds_invariant () const noexcept
	Check if the point is valid.

Friends
constexpr friend point2	operator+ (point2 const &lhs, vector2 const &rhs) noexcept
	Move a point along a vector.
constexpr friend point2	operator+ (vector2 const &lhs, point2 const &rhs) noexcept
	Move a point along a vector.
constexpr friend point2	operator- (point2 const &lhs, vector2 const &rhs) noexcept
	Move a point backward along the vector.
constexpr friend vector2	operator- (point2 const &lhs, point2 const &rhs) noexcept
	Find the vector between two points.
constexpr friend bool	operator== (point2 const &lhs, point2 const &rhs) noexcept
	Compare if two points are equal.
constexpr point2	midpoint (point2 const &lhs, point2 const &rhs) noexcept
constexpr point2	reflect (point2 const &lhs, point2 const &rhs) noexcept
	Reflect a point.
constexpr point2	min (point2 const &lhs, point2 const &rhs) noexcept
	Mix the two points and get the lowest value of each element.
constexpr point2	max (point2 const &lhs, point2 const &rhs) noexcept
	Mix the two points and get the highest value of each element.
constexpr point2	round (point2 const &rhs) noexcept
	Round the coordinates of a point toward nearest integer.
constexpr point2	ceil (point2 const &rhs) noexcept
	Round the coordinates of a point toward the right-top.
constexpr point2	floor (point2 const &rhs) noexcept
	Round the coordinates of a point toward the left-bottom.
constexpr point2	ceil (point2 const &lhs, extent2 rhs) noexcept
	Round the coordinates of a point toward the top-right with the given granularity.
constexpr point2	floor (point2 const &lhs, extent2 rhs) noexcept
	Round the coordinates of a point toward the left-bottom with the given granularity.
float	distance (point2 const &lhs, point2 const &rhs) noexcept
std::string	to_string (point2 const &rhs) noexcept
std::ostream &	operator<< (std::ostream &lhs, point2 const &rhs) noexcept

Detailed Description

A high-level geometric point Part of the high-level vec, point, mat and color types.

A point, for both 2D or 3D is internally represented as a 4D homogeneous vector. Which can be efficiently implemented as a __m128 SSE register.

Constructor & Destructor Documentation

point2() [1/3]

constexpr v1::point2::point2 ( array_type const & other )

inlineexplicitconstexprnoexcept

Construct a point from a array_type-simd.

point2() [2/3]

constexpr v1::point2::point2 ( )

inlineconstexprnoexcept

Construct a point at the origin of the coordinate system.

point2() [3/3]

constexpr v1::point2::point2 ( float x, float y )

inlineconstexprnoexcept

Construct a 3D point from x, y and z elements.

Parameters

x	The x element.
y	The y element.

Member Function Documentation

holds_invariant()

constexpr bool v1::point2::holds_invariant ( ) const

inlineconstexprnoexcept

Check if the point is valid.

This function will check if w is not zero, and with a 2D point is z is zero.

operator array_type()

constexpr v1::point2::operator array_type ( ) const

inlineexplicitconstexprnoexcept

Convert a point to its array_type-nummeric_array.

x() [1/2]

constexpr float v1::point2::x ( ) const

inlineconstexprnoexcept

Access the x element from the point.

Returns

a reference to the x element.

x() [2/2]

constexpr float & v1::point2::x ( )

inlineconstexprnoexcept

Access the x element from the point.

Returns

a reference to the x element.

y() [1/2]

constexpr float v1::point2::y ( ) const

inlineconstexprnoexcept

Access the y element from the point.

Returns

a reference to the y element.

y() [2/2]

constexpr float & v1::point2::y ( )

inlineconstexprnoexcept

Access the y element from the point.

Returns

a reference to the y element.

Friends And Related Symbol Documentation

ceil [1/2]

constexpr point2 ceil ( point2 const & lhs, extent2 rhs )

friend

Round the coordinates of a point toward the top-right with the given granularity.

ceil [2/2]

constexpr point2 ceil ( point2 const & rhs )

friend

Round the coordinates of a point toward the right-top.

floor [1/2]

constexpr point2 floor ( point2 const & lhs, extent2 rhs )

friend

Round the coordinates of a point toward the left-bottom with the given granularity.

floor [2/2]

constexpr point2 floor ( point2 const & rhs )

friend

Round the coordinates of a point toward the left-bottom.

max

constexpr point2 max ( point2 const & lhs, point2 const & rhs )

friend

Mix the two points and get the highest value of each element.

Parameters

lhs	The first point.
rhs	The first point.

Returns

A point that is the most right of both points, and most top of both points.

min

constexpr point2 min ( point2 const & lhs, point2 const & rhs )

friend

Mix the two points and get the lowest value of each element.

Parameters

lhs	The first point.
rhs	The first point.

Returns

A point that is the most left of both points, and most bottom of both points.

operator+ [1/2]

constexpr friend point2 operator+ ( point2 const & lhs, vector2 const & rhs )

friend

Move a point along a vector.

Parameters

lhs	The point to move.
rhs	The vector to move along.

Returns

The moved point.

operator+ [2/2]

constexpr friend point2 operator+ ( vector2 const & lhs, point2 const & rhs )

friend

Move a point along a vector.

Parameters

lhs	The vector to move along.
rhs	The point to move.

Returns

The moved point.

operator- [1/2]

constexpr friend vector2 operator- ( point2 const & lhs, point2 const & rhs )

friend

Find the vector between two points.

Parameters

lhs	The first point.
rhs	The second point.

Returns

The vector from the second to first point.

operator- [2/2]

constexpr friend point2 operator- ( point2 const & lhs, vector2 const & rhs )

friend

Move a point backward along the vector.

Parameters

lhs	The point to move.
rhs	The vector to move backward.

Returns

The moved point.

operator==

constexpr friend bool operator== ( point2 const & lhs, point2 const & rhs )

friend

Compare if two points are equal.

Parameters

lhs	The first point.
rhs	The second point.

Returns

True if both point are completely equal to each other.

reflect

constexpr point2 reflect ( point2 const & lhs, point2 const & rhs )

friend

Reflect a point.

Parameters

lhs	The point to be reflected
rhs	The anchor point.

Returns

The reflected point.

round

constexpr point2 round ( point2 const & rhs )

friend

Round the coordinates of a point toward nearest integer.

---

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

• hikogui/src/hikogui/geometry/point2.hpp