PointXYZRGB Class Reference

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

Inheritance diagram for PointXYZRGB:

Public Member Functions
constexpr	PointXYZRGB ()=default
constexpr	PointXYZRGB (float x, float y, float z, uint16_t red, uint16_t green, uint16_t blue)
	Point constructor from x, y and z and color (R, G and B) metadata.
constexpr uint16_t	GetRed () const
	Returns the red metadata.
constexpr uint16_t	GetGreen () const
	Returns the green metadata.
constexpr uint16_t	GetBlue () const
	Returns the blue metadata.
constexpr bool	operator== (const PointXYZRGB &rhs) const
	operator peak_icv_point_xyzrgb () const
float	GetZ () const
	Returns the z coordinate.
	operator peak_icv_point_xyz () const
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
	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, z coordinates and color metadata.

Since

ids_peak_icv 1.4

Constructor & Destructor Documentation

PointXYZRGB() [1/2]

PointXYZRGB ( )

constexprdefault

PointXYZRGB() [2/2]

PointXYZRGB ( float x, float y, float z, uint16_t red, uint16_t green, uint16_t blue )

inlineconstexpr

Point constructor from x, y and z and color (R, G and B) metadata.

Parameters

x	x coordinate
y	y coordinate
z	z coordinate
red	overlay metadata
green	overlay metadata
blue	overlay metadata

Since

ids_peak_icv 1.4

Member Function Documentation

GetBlue()

uint16_t GetBlue ( ) const

inlineconstexpr

Returns the blue metadata.

Since

ids_peak_icv 1.4

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

GetGreen()

uint16_t GetGreen ( ) const

inlineconstexpr

Returns the green metadata.

Since

ids_peak_icv 1.4

GetRed()

uint16_t GetRed ( ) const

inlineconstexpr

Returns the red metadata.

Since

ids_peak_icv 1.4

GetX()

float GetX ( ) const

inlineconstexprinherited

Returns the x-coordinate (first component).

Returns

The value of the first coordinate.

Since

ids_peak_common 1.0

GetY()

float GetY ( ) const

inlineconstexprinherited

Returns the y-coordinate (second component).

Returns

The value of the second coordinate.

Since

ids_peak_common 1.0

GetZ()

float GetZ ( ) const

inlineinherited

Returns the z coordinate.

Since

ids_peak_icv 1.1

operator peak_icv_point_xyz()

operator peak_icv_point_xyz ( ) const

inlineinherited

operator peak_icv_point_xyzrgb()

operator peak_icv_point_xyzrgb ( ) const

inline

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

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

operator==() [2/2]

bool operator== ( const PointXYZRGB & rhs ) const

inlineconstexpr

PointXYZRGB equality operator

Since

ids_peak_icv 1.4