Public Member Functions | List of all members
playrho::d2::SimplexEdge Class Reference

Simplex edge. More...

#include <SimplexEdge.hpp>

Public Member Functions

 SimplexEdge ()=default
 Default constructor. More...
 
PLAYRHO_CONSTEXPR SimplexEdge (const SimplexEdge &copy)=default
 Copy constructor. More...
 
PLAYRHO_CONSTEXPR SimplexEdge (Length2 pA, VertexCounter iA, Length2 pB, VertexCounter iB) noexcept
 Initializing constructor. More...
 
PLAYRHO_CONSTEXPR auto GetPointA () const noexcept
 Gets point A (in world coordinates). More...
 
PLAYRHO_CONSTEXPR auto GetPointB () const noexcept
 Gets point B (in world coordinates). More...
 
PLAYRHO_CONSTEXPR auto GetIndexA () const noexcept
 Gets index A. More...
 
PLAYRHO_CONSTEXPR auto GetIndexB () const noexcept
 Gets index B. More...
 
PLAYRHO_CONSTEXPR auto GetIndexPair () const noexcept
 Gets the index pair. More...
 

Detailed Description

Simplex edge.

This is the locations (in world coordinates) and indices of a pair of vertices from two shapes (shape A and shape B).

Note
This data structure is 20-bytes large (on at least one 64-bit platform).

Definition at line 36 of file SimplexEdge.hpp.

Constructor & Destructor Documentation

◆ SimplexEdge() [1/3]

playrho::d2::SimplexEdge::SimplexEdge ( )
default

Default constructor.

◆ SimplexEdge() [2/3]

PLAYRHO_CONSTEXPR playrho::d2::SimplexEdge::SimplexEdge ( const SimplexEdge &  copy)
inlinedefault

Copy constructor.

◆ SimplexEdge() [3/3]

PLAYRHO_CONSTEXPR playrho::d2::SimplexEdge::SimplexEdge ( Length2  pA,
VertexCounter  iA,
Length2  pB,
VertexCounter  iB 
)
inlinenoexcept

Initializing constructor.

Parameters
pAPoint A in world coordinates.
iAIndex of point A within the shape that it comes from.
pBPoint B in world coordinates.
iBIndex of point B within the shape that it comes from.

Definition at line 74 of file SimplexEdge.hpp.

Member Function Documentation

◆ GetPointA()

PLAYRHO_CONSTEXPR auto playrho::d2::SimplexEdge::GetPointA ( ) const
inlinenoexcept

Gets point A (in world coordinates).

Definition at line 54 of file SimplexEdge.hpp.

◆ GetPointB()

PLAYRHO_CONSTEXPR auto playrho::d2::SimplexEdge::GetPointB ( ) const
inlinenoexcept

Gets point B (in world coordinates).

Definition at line 57 of file SimplexEdge.hpp.

◆ GetIndexA()

PLAYRHO_CONSTEXPR auto playrho::d2::SimplexEdge::GetIndexA ( ) const
inlinenoexcept

Gets index A.

Definition at line 60 of file SimplexEdge.hpp.

◆ GetIndexB()

PLAYRHO_CONSTEXPR auto playrho::d2::SimplexEdge::GetIndexB ( ) const
inlinenoexcept

Gets index B.

Definition at line 63 of file SimplexEdge.hpp.

◆ GetIndexPair()

PLAYRHO_CONSTEXPR auto playrho::d2::SimplexEdge::GetIndexPair ( ) const
inlinenoexcept

Gets the index pair.

Definition at line 66 of file SimplexEdge.hpp.

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