RadialObject< t_dims, t_type, t_vertex > Class Template Reference

A radial object. More...

#include <RadialObject.hpp>

Public Member Functions
template<uint01 t_new_dims, class t_new_type , class t_new_vertex = Vertex<t_new_dims, t_new_type>>
constexpr RadialObject< t_new_dims, t_new_type >	as () const
constexpr const t_vertex &	center () const
template<bool t_allow_bounds = true>
constexpr bool	contains (const t_vertex &vector) const
bool	operator!= (const RadialObject &rad) const
bool	operator== (const RadialObject &rad) const
constexpr	RadialObject (const t_vertex &center, t_type radius)
constexpr	RadialObject (const t_vertex &vertex_a, const t_vertex &vertex_b, const t_vertex &vertex_c)
constexpr	RadialObject (t_type r=0)
constexpr t_type	radius () const

Detailed Description

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

A radial object.

---

Class: RadialObject

Author: Tyler Parke

Date: 2017-11-19

Constructor & Destructor Documentation

RadialObject() [1/3]

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

RadialObject ( t_type r = 0 )

inlineconstexpr

RadialObject() [2/3]

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

RadialObject ( const t_vertex & center, t_type radius )

inlineconstexpr

RadialObject() [3/3]

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

RadialObject ( const t_vertex & vertex_a, const t_vertex & vertex_b, const t_vertex & vertex_c )

inlineconstexpr

---

Constructor.

Author: Tyler Parke

Date: 2017-11-19

Parameters: parameter1 - The first parameter.

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 , class t_new_vertex = Vertex<t_new_dims, t_new_type>>

RadialObject< t_new_dims, t_new_type > as ( ) const

inlineconstexpr

---

Gets as.

Author: Tyler Parke

Date: 2017-11-19

Returns

A RadialObject<t_new_dims,t_new_type>

center()

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

const t_vertex & center ( ) const

inlinenodiscardconstexpr

---

Gets the center.

Author: Tyler Parke

Date: 2017-11-19

Returns

A reference to a const t_vertex.

contains()

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

template<bool t_allow_bounds = true>

bool 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 t_vertex& to test for containment.

Returns

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

operator!=()

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

bool operator!= ( const RadialObject< t_dims, t_type, t_vertex > & rad ) const

inline

operator==()

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

bool operator== ( const RadialObject< t_dims, t_type, t_vertex > & rad ) const

inline

radius()

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

t_type radius ( ) const

inlineconstexpr

---

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