BiRadialObject< t_dims, t_type, t_vertex >

An ellipse like shape (such as an oval or egg) with two points, where all points on the shape are equal distance between the two points (distanceTo(A) + distanceTo(B) = radius). More...

Public Member Functions
template<uint01 t_new_dims, class t_new_type>
constexpr BiRadialObject< t_new_dims, t_new_type >	as () const
constexpr t_vertex	center () const
constexpr bool	contains (const t_vertex &vector) const
constexpr t_type	radius () const

Detailed Description

template<uint01 t_dims, class t_type, class t_vertex = Vertex<t_dims, t_type>>
class BiRadialObject< t_dims, t_type, t_vertex >

An ellipse like shape (such as an oval or egg) with two points, where all points on the shape are equal distance between the two points (distanceTo(A) + distanceTo(B) = radius).

---

Definition at line 188 of file RadialObject.hpp.

Member Function Documentation

as()

template<uint01 t_dims, class t_type, class t_vertex = Vertex<t_dims, t_type>>

template<uint01 t_new_dims, class t_new_type>

BiRadialObject< t_new_dims, t_new_type > BiRadialObject< t_dims, t_type, t_vertex >::as ( ) const

inlineconstexpr

---

Gets as.

Author: Tyler Parke

Date: 2017-11-19

Returns

A RadialObject<t_new_dims,t_new_type>

Definition at line 260 of file RadialObject.hpp.

References as(), and cast().

Referenced by as().

center()

template<uint01 t_dims, class t_type, class t_vertex = Vertex<t_dims, t_type>>

t_vertex BiRadialObject< t_dims, t_type, t_vertex >::center ( ) const

inlineconstexpr

---

Gets the center.

Author: Tyler Parke

Date: 2017-11-19

Returns

The centerpoint of the Biradial object (Or the intersection of the major and minor axis);

Definition at line 275 of file RadialObject.hpp.

References cast().

contains()

template<uint01 t_dims, class t_type, class t_vertex = Vertex<t_dims, t_type>>

bool BiRadialObject< t_dims, t_type, t_vertex >::contains ( const t_vertex & vector ) const

inlineconstexpr

---

Query if this object contains the given vector.

Author: Tyler Parke

Date: 2017-11-19

Parameters: vector - The const Vector<t_dims,t_type>& to test for containment.

Returns

True if the object is in this collection, false if not.

Definition at line 230 of file RadialObject.hpp.

radius()

template<uint01 t_dims, class t_type, class t_vertex = Vertex<t_dims, t_type>>

t_type BiRadialObject< t_dims, t_type, t_vertex >::radius ( ) const

inlineconstexpr

---

Gets the radius.

Author: Tyler Parke

Date: 2017-11-19

Returns

A t_type.

Definition at line 246 of file RadialObject.hpp.

---

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

• Base/Headers/RadialObject.hpp