Polygon< PointType > Class Template Reference

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

Inheritance diagram for Polygon< PointType >:

Public Member Functions
	Polygon ()
	Creates an empty polygon.
	~Polygon () override
	Polygon (const std::vector< peak::common::detail::PointT< PointType > > &points)
	Creates a polygon from a set of points.
	Polygon (const Polygon &other)
	Polygon (Polygon &&other) noexcept
Polygon &	operator= (const Polygon &other)
Polygon &	operator= (Polygon &&other) noexcept
std::vector< peak::common::detail::PointT< PointType > >	GetPoints () const
	Provides the points from a polygon.
bool	IsClosed () const
	Checks if a polygon is closed. A closed polygon contains the same point as first and last point. Returns True if closed, False if open.

Detailed Description

template<typename PointType>
class peak::icv::detail::Polygon< PointType >

A polygon is a two-dimensional geometric shape that is made up of a finite number of straight line segments connected end-to-end to form an open or closed figure. A polygon is represented by the points where the line segments meet.

Since

ids_peak_icv 1.1

Constructor & Destructor Documentation

Polygon() [1/4]

template<typename PointType >

Polygon ( )

inline

Creates an empty polygon.

Since

ids_peak_icv 1.1

~Polygon()

template<typename PointType >

~Polygon ( )

inlineoverride

Since

ids_peak_icv 1.1

Polygon() [2/4]

template<typename PointType >

Polygon ( const std::vector< peak::common::detail::PointT< PointType > > & points )

inlineexplicit

Creates a polygon from a set of points.

Parameters

points

Vector of points representing the polygon.

Since

ids_peak_icv 1.1

Polygon() [3/4]

template<typename PointType >

Polygon ( const Polygon< PointType > & other )

inline

Since

ids_peak_icv 1.1

Polygon() [4/4]

template<typename PointType >

Polygon ( Polygon< PointType > && other )

inlinenoexcept

Since

ids_peak_icv 1.1

Member Function Documentation

GetPoints()

template<typename PointType >

std::vector< peak::common::detail::PointT< PointType > > GetPoints ( ) const

inline

Provides the points from a polygon.

Returns

Returns the points from a polygon.

Since

ids_peak_icv 1.1

IsClosed()

template<typename PointType >

bool IsClosed ( ) const

inline

Checks if a polygon is closed. A closed polygon contains the same point as first and last point. Returns True if closed, False if open.

Returns

Returns True if closed, False if open.

Since

ids_peak_icv 1.1

operator=() [1/2]

template<typename PointType >

Polygon< PointType > & operator= ( const Polygon< PointType > & other )

inline

Since

ids_peak_icv 1.1

operator=() [2/2]

template<typename PointType >

Polygon< PointType > & operator= ( Polygon< PointType > && other )

inlinenoexcept

Since

ids_peak_icv 1.1