Vertex Set. More...
#include <VertexSet.hpp>
Public Types | |
using | const_pointer = const Length2 * |
Constant pointer type. More... | |
Public Member Functions | |
VertexSet (Area minSepSquared=GetDefaultMinSeparationSquared()) | |
Initializing constructor. More... | |
Area | GetMinSeparationSquared () const noexcept |
Gets the min separation squared. More... | |
bool | add (Length2 value) |
Adds the given vertex into the set if allowed. More... | |
void | clear () noexcept |
Clear this set. More... | |
std::size_t | size () const noexcept |
Gets the current size of this set. More... | |
const_pointer | data () const |
Gets the pointer to the data buffer. More... | |
const_pointer | begin () const |
Gets the "begin" iterator value. More... | |
const_pointer | end () const |
Gets the "end" iterator value. More... | |
const_pointer | find (Length2 value) const |
Length2 | operator[] (std::size_t index) const noexcept |
Indexed access. More... | |
Static Public Member Functions | |
static Area | GetDefaultMinSeparationSquared () |
Gets the default minimum separation squared value. More... | |
Detailed Description
Vertex Set.
This is a container that enforces the invariant that no two vertices can be closer together than the minimum separation distance.
Definition at line 35 of file VertexSet.hpp.
Member Typedef Documentation
◆ const_pointer
using playrho::d2::VertexSet::const_pointer = const Length2* |
Constant pointer type.
Definition at line 40 of file VertexSet.hpp.
Constructor & Destructor Documentation
◆ VertexSet()
|
inlineexplicit |
Initializing constructor.
Definition at line 49 of file VertexSet.hpp.
Member Function Documentation
◆ GetDefaultMinSeparationSquared()
|
inlinestatic |
Gets the default minimum separation squared value.
Definition at line 43 of file VertexSet.hpp.
◆ GetMinSeparationSquared()
|
inlinenoexcept |
Gets the min separation squared.
Definition at line 56 of file VertexSet.hpp.
◆ add()
|
inline |
Adds the given vertex into the set if allowed.
Definition at line 59 of file VertexSet.hpp.
◆ clear()
|
inlinenoexcept |
Clear this set.
Definition at line 70 of file VertexSet.hpp.
◆ size()
|
inlinenoexcept |
Gets the current size of this set.
Definition at line 76 of file VertexSet.hpp.
◆ data()
|
inline |
Gets the pointer to the data buffer.
Definition at line 82 of file VertexSet.hpp.
◆ begin()
|
inline |
Gets the "begin" iterator value.
Definition at line 85 of file VertexSet.hpp.
◆ end()
|
inline |
Gets the "end" iterator value.
Definition at line 88 of file VertexSet.hpp.
◆ find()
|
inline |
Finds contained point whose delta with the given point has a squared length less than or equal to this set's minimum length squared value.
Definition at line 92 of file VertexSet.hpp.
◆ operator[]()
|
inlinenoexcept |
Indexed access.
Definition at line 104 of file VertexSet.hpp.
The documentation for this class was generated from the following file:
- Common/VertexSet.hpp