PointXYZ Class Reference

#include <peak_icv/types/geometry/peak_icv_point_xyz.hpp>

Inheritance diagram for PointXYZ:

Collaboration diagram for PointXYZ:

Public Member Functions
constexpr	PointXYZ ()=default
constexpr	PointXYZ (float x, float y, float z)
	Point constructor from x, y and z.
float	GetZ () const
	Returns the z coordinate.
constexpr float	GetX () const
	Returns the x-coordinate (first component).
constexpr float	GetY () const
	Returns the y-coordinate (second component).
constexpr bool	operator== (const PointXd< H, d > &rhs) const
	Equality operator for comparing integral coordinates.
constexpr bool	operator== (const PointXd< H, d > &rhs) const
	Equality operator for comparing floating-point coordinates.
constexpr bool	operator!= (const PointXd< H, d > &rhs) const
	Inequality operator for comparing coordinates.
constexpr std::array< float, dimension >	GetCoordinates () const
	Returns the coordinates of the point as an array.

Detailed Description

A point consists of x, y and z coordinate.

Warning

This function is still in development and not released.

Definition at line 40 of file peak_icv_point_xyz.hpp.

Constructor & Destructor Documentation

PointXYZ() [1/2]

PointXYZ ( )

constexprdefault

PointXYZ() [2/2]

PointXYZ ( float x, float y, float z )

inlineconstexpr

Point constructor from x, y and z.

Parameters

x	x coordinate
y	y coordinate
z	z coordinate

Warning

This function is still in development and not released.

Definition at line 56 of file peak_icv_point_xyz.hpp.

Member Function Documentation

GetCoordinates()

std::array< float, dimension > GetCoordinates ( ) const

inlineconstexprinherited

Returns the coordinates of the point as an array.

Returns

A copy of the internal coordinate array.

Since

ids_peak_common 1.0

Definition at line 170 of file peak_common_point.hpp.

GetX()

float GetX ( ) const

inlineconstexprinherited

Returns the x-coordinate (first component).

Returns

The value of the first coordinate.

Since

ids_peak_common 1.0

Definition at line 74 of file peak_common_point.hpp.

GetY()

float GetY ( ) const

inlineconstexprinherited

Returns the y-coordinate (second component).

Returns

The value of the second coordinate.

Since

ids_peak_common 1.0

Definition at line 86 of file peak_common_point.hpp.

GetZ()

float GetZ ( ) const

inline

Returns the z coordinate.

Warning

This function is still in development and not released.

Definition at line 65 of file peak_icv_point_xyz.hpp.

operator!=()

bool operator!= ( const PointXd< H, d > & rhs ) const

inlineconstexprinherited

Inequality operator for comparing coordinates.

Returns true if any coordinates of this point are not equal to the corresponding coordinates of the other point.

Template Parameters

H	The type of the other point's coordinates.
d	The dimensionality of the point.

Since

ids_peak_common 1.0

Definition at line 126 of file peak_common_point.hpp.

operator==() [1/2]

bool operator== ( const PointXd< H, d > & rhs ) const

inlineconstexprinherited

Equality operator for comparing integral coordinates.

Returns true if all coordinates of this point are exactly equal to the corresponding coordinates of the other point. This overload is used for integral coordinate types.

Template Parameters

H	The type of the other point's coordinates.
d	The dimensionality of the point.

Since

ids_peak_common 1.0

Definition at line 109 of file peak_common_point.hpp.

operator==() [2/2]

bool operator== ( const PointXd< H, d > & rhs ) const

inlineconstexprinherited

Equality operator for comparing floating-point coordinates.

Returns true if all coordinates of this point are approximately equal to the corresponding coordinates of the other point. Comparison is performed using a tolerance based on units in the last place (ULP), allowing for small floating-point inaccuracies.

Template Parameters

H	The type of the other point's coordinates.
d	The dimensionality of the point.

Since

ids_peak_common 1.0

Definition at line 150 of file peak_common_point.hpp.