ev::Circ_< T > Struct Template Reference

This class defines a circle given its center and radius. More...

#include <types.hpp>

Public Member Functions
	Circ_ ()
	Circ_ (const cv::Point_< T > center, const T radius)
bool	empty () const
	Check if empty.
template<typename Te>
bool	contains (const Event_< Te > &e) const
	Check if the circle contains an event.
cv::Size	size () const
	Bounding square of the circle as a cv::Size (radius × radius).
double	area () const
	Compute the area of the circle.

Public Attributes
cv::Point_< T >	center
T	radius

Detailed Description

template<typename T>
struct ev::Circ_< T >

This class defines a circle given its center and radius.

Analogously to OpenCV library, the following aliases are defined for convenience:

using Circi = Circ_<int>;
using Circl = Circ_<long>;
using Circf = Circ_<float>;
using Circd = Circ_<double>;
using Circ = Circi;

Constructor & Destructor Documentation

Circ_() [1/2]

template<typename T>

ev::Circ_< T >::Circ_ ( )

inline

Default constructor.

Circ_() [2/2]

template<typename T>

ev::Circ_< T >::Circ_ ( const cv::Point_< T > center, const T radius )

inline

Constructor using center and radius.

Parameters

center	Center
radius	Radius

Member Function Documentation

area()

template<typename T>

double ev::Circ_< T >::area ( ) const

inlinenodiscard

Compute the area of the circle.

Area is computed as \( \pi r^2 \).

Returns

Area

contains()

template<typename T>

template<typename Te>

bool ev::Circ_< T >::contains ( const Event_< Te > & e ) const

inlinenodiscard

Check if the circle contains an event.

Parameters

e	Event to check

Returns

True if the event is inside

Warning

This function assumes that the boundary of the circle is inclusive.

empty()

template<typename T>

bool ev::Circ_< T >::empty ( ) const

inlinenodiscard

Check if empty.

Returns

True if empty

size()

template<typename T>

cv::Size ev::Circ_< T >::size ( ) const

inlinenodiscard

Bounding square of the circle as a cv::Size (radius × radius).

Returns

Size with width and height equal to the radius.

---

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

• modules/core/include/openev/core/types.hpp