BiRadialObject< t_dims, t_type, t_vertex > Class Template Reference

#include <RadialObject.hpp>

Public Member Functions
constexpr	BiRadialObject (t_type r=0)
constexpr	BiRadialObject (const t_vertex &p1, const t_vertex &p2, t_type radius)
constexpr bool	contains (const t_vertex &vector) const
constexpr t_type	radius () const
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 const t_vertex &	axisPoint (uint01 vertex) const
template<class t_ratio_type = fltp08>
t_ratio_type	minorToMajorRatio () const
template<class t_matrix_type = fltp08>
Matrix< t_matrix_type >	fromCircleTransform () const

Static Public Member Functions
template<class t_matrix_type = fltp08>
static BiRadialObject< t_dims, t_type, t_vertex >	fromCircleTransform (const Matrix< t_matrix_type > &mat)

Detailed Description

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

---

Class: BiRadialObject

A bi radial object.

Author: Tyler Parke

Date: 2017-11-19

Constructor & Destructor Documentation

BiRadialObject() [1/2]

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

BiRadialObject ( t_type r = 0 )

inlineconstexpr

BiRadialObject() [2/2]

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

BiRadialObject ( const t_vertex & p1, const t_vertex & p2, t_type radius )

inlineconstexpr

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 > as ( ) const

inlineconstexpr

---

Fn: constexpr BiRadialObject<t_new_dims, t_new_type> BiRadialObject::as() const

Gets as.

Author: Tyler Parke

Date: 2017-11-19

Returns: A RadialObject<t_new_dims,t_new_type>

axisPoint()

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

const t_vertex & axisPoint ( uint01 vertex ) const

inlineconstexpr

center()

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

t_vertex center ( ) const

inlineconstexpr

---

Fn: constexpr const t_vertex& BiRadialObject::center() const

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);

contains()

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

bool contains ( const t_vertex & vector ) const

inlineconstexpr

---

Fn: constexpr bool BiRadialObject::contains(const Vector<t_dims, t_type>& vector) const

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.

fromCircleTransform() [1/2]

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

template<class t_matrix_type = fltp08>

Matrix< t_matrix_type > fromCircleTransform ( ) const

inline

fromCircleTransform() [2/2]

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

template<class t_matrix_type = fltp08>

static BiRadialObject< t_dims, t_type, t_vertex > fromCircleTransform ( const Matrix< t_matrix_type > & mat )

inlinestatic

minorToMajorRatio()

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

template<class t_ratio_type = fltp08>

t_ratio_type minorToMajorRatio ( ) const

inline

radius()

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

t_type radius ( ) const

inlineconstexpr

---

Fn: constexpr t_type BiRadialObject::radius() const

Gets the radius.

Author: Tyler Parke

Date: 2017-11-19

Returns: A t_type.

---

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

• Base/Headers/RadialObject.hpp