gf::Circ< T > Struct Template Reference

Utility class for manipulating circles. More...

#include <gf/Circ.h>

Inheritance diagram for gf::Circ< T >:

Public Member Functions
constexpr	Circ () noexcept
	Default constructor. More...
constexpr	Circ (const Vector< T, 2 > &circCenter, T circRadius) noexcept
	Construct the circle from center and radius. More...
constexpr Vector< T, 2 >	getTop () const noexcept
	Get the top of the circle. More...
constexpr Vector< T, 2 >	getBottom () const noexcept
	Get the bottom of the circle. More...
constexpr Vector< T, 2 >	getLeft () const noexcept
	Get the left of the circle. More...
constexpr Vector< T, 2 >	getRight () const noexcept
	Get the right of the circle. More...
Public Member Functions inherited from gf::Ball< T, 2 >
constexpr	Ball () noexcept
	Default constructor. More...
constexpr	Ball (const Vector< T, N > &ballCenter, T ballRadius) noexcept
	Construct the ball from center and radius. More...
constexpr Vector< T, N >	getCenter () const noexcept
	Get the center of the ball. More...
constexpr T	getRadius () const noexcept
	Get the radius of the ball. More...
constexpr bool	isEmpty () const noexcept
	Check if the ball is empty. More...
bool	contains (const Vector< T, N > &point) const noexcept
	Check if a point is insied a ball's area. More...
bool	intersects (const Ball< T, N > &other) const noexcept
	Check the intersection between two balls. More...

Related Functions
(Note that these are not member functions.)
template<typename T >
bool	operator== (const Circ< T > &lhs, const Circ< T > &rhs)
	Equality operator. More...
template<typename T >
bool	operator!= (const Circ< T > &lhs, const Circ< T > &rhs)
	Inequality operator. More...
template<typename Archive , typename T >
Archive &	operator| (Archive &ar, Circ< T > &circ)
	Serialize a circle. More...
Related Functions inherited from gf::Ball< T, 2 >
constexpr bool	operator== (const Ball< T, N > &lhs, const Ball< T, N > &rhs)
	Equality operator. More...
constexpr bool	operator!= (const Ball< T, N > &lhs, const Ball< T, N > &rhs)
	Inequality operator. More...
Archive &	operator| (Archive &ar, Ball< T, N > &ball)
	Serialize a ball. More...

Additional Inherited Members
Public Attributes inherited from gf::Ball< T, 2 >
Vector< T, N >	center
	Center of the ball. More...
T	radius
	Radius of the ball. More...

Detailed Description

template<typename T>
struct gf::Circ< T >

Utility class for manipulating circles.

A circle is defined by its center and its radius. It is a very simple class defined for convenience, so its member variables (center and radius) are public and can be accessed directly.

gf::Circ is a template and may be used with any numeric type, but for simplicity, some common typedef are defined:

• gf::CircI with int as T
• gf::CircU with unsigned as T
• gf::CircZ with std::size_t as T
• gf::CircF with float as T
• gf::CircD with double as T

So that you don't have to care about the template syntax.

Usage example:

  // Define a circle, with a center at  (10, 10) and a radius of 20
  gf::CircI c1({ 10, 10 }, 20);

  // Define a circle with a center at (0, 0) and a radius of 2
  gf::CircI c2({ 0, 0 }, 2);

  // Test intersections with the point (3, 1)
  bool b1 = c1.contains({ 3, 1 }); // true
  bool b2 = c2.contains({ 3, 1 }); // false

  // Test the intersection between c1 and c2
  bool b3 = c1.intersects(c2); // true

Constructor & Destructor Documentation

Circ() [1/2]

template<typename T>

constexpr gf::Circ< T >::Circ ( )

inlinenoexcept

Default constructor.

Creates an empty circle (it is equivalent to calling Circ({ 0, 0 }, 0).

Circ() [2/2]

template<typename T>

constexpr gf::Circ< T >::Circ ( const Vector< T, 2 > &  circCenter, T  circRadius  )

inlinenoexcept

Construct the circle from center and radius.

Parameters

circCenter	Center of the circle
circRadius	Radius of the circle

Member Function Documentation

getBottom()

template<typename T>

constexpr Vector<T, 2> gf::Circ< T >::getBottom ( ) const

inlinenoexcept

Get the bottom of the circle.

Returns

The bottom of the circle

getLeft()

template<typename T>

constexpr Vector<T, 2> gf::Circ< T >::getLeft ( ) const

inlinenoexcept

Get the left of the circle.

Returns

The left of the circle

getRight()

template<typename T>

constexpr Vector<T, 2> gf::Circ< T >::getRight ( ) const

inlinenoexcept

Get the right of the circle.

Returns

The right of the circle

getTop()

template<typename T>

constexpr Vector<T, 2> gf::Circ< T >::getTop ( ) const

inlinenoexcept

Get the top of the circle.

Returns

The top of the circle

Friends And Related Function Documentation

operator!=()

template<typename T >

bool operator!= ( const Circ< T > &  lhs, const Circ< T > &  rhs  )

related

Inequality operator.

Parameters

lhs	First circle
rhs	Second circle

Returns

True if the two circles are different

operator==()

template<typename T >

bool operator== ( const Circ< T > &  lhs, const Circ< T > &  rhs  )

related

Equality operator.

Parameters

lhs	First circle
rhs	Second circle

Returns

True if the two circles are the same

operator|()

template<typename Archive , typename T >

Archive & operator| ( Archive &  ar, Circ< T > &  circ  )

related

Serialize a circle.

Parameters

ar	The archive
circ	The circle to serialize

See also

gf::Serializer, gf::Deserializer