NDEVR
API Documentation
RadialObject< t_dims, t_type, t_vertex >

A radial object. More...

Inheritance diagram for RadialObject< t_dims, t_type, t_vertex >:
[legend]

Public Member Functions

constexpr RadialObject (const t_vertex &vertex_a, const t_vertex &vertex_b, const t_vertex &vertex_c)
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
constexpr t_type radius () const

Detailed Description

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

A radial object.

Class: RadialObject

Author: Tyler Parke

Date: 2017-11-19

Definition at line 51 of file RadialObject.hpp.

Constructor & Destructor Documentation

◆ RadialObject()

template<uint01 t_dims, class t_type, class t_vertex = Vertex<t_dims, t_type>>
RadialObject< t_dims, t_type, t_vertex >::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.

Definition at line 73 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, class t_new_vertex = Vertex<t_new_dims, t_new_type>>
RadialObject< t_new_dims, t_new_type > RadialObject< 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 143 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>>
const t_vertex & RadialObject< t_dims, t_type, t_vertex >::center ( ) const
inlinenodiscardconstexpr

Gets the center.

Author: Tyler Parke

Date: 2017-11-19

Returns
A reference to a const t_vertex.

Definition at line 158 of file RadialObject.hpp.

Referenced by Bounds< 3, fltp08 >::contains(), and Bounds< 3, fltp08 >::intersects().

◆ contains()

template<uint01 t_dims, class t_type, class t_vertex = Vertex<t_dims, t_type>>
template<bool t_allow_bounds = true>
bool RadialObject< 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 t_vertex& to test for containment.

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

Definition at line 111 of file RadialObject.hpp.

◆ radius()

template<uint01 t_dims, class t_type, class t_vertex = Vertex<t_dims, t_type>>
t_type RadialObject< 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 129 of file RadialObject.hpp.

Referenced by Bounds< 3, fltp08 >::contains(), and Bounds< 3, fltp08 >::intersects().

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