This class represents a face used by AIFMesh objects. An AIFFace natively saves relations with its incident edges (AIFEdge). In addition, relations with its incident vertices (AIFVertex) are saved on demand.
More...
#include <AIFFace.hpp>
This class represents a face used by AIFMesh objects. An AIFFace natively saves relations with its incident edges (AIFEdge). In addition, relations with its incident vertices (AIFVertex) are saved on demand.
- See also
- AIFVertex
-
AIFEdge
Definition at line 45 of file AIFFace.hpp.
◆ edge_type
◆ EdgeContainerType
◆ FaceContainerType
◆ NormalCoordinateType
◆ ptr
◆ ptr_edge
◆ ptr_face
◆ ptr_vertex
◆ self
◆ vertex_type
◆ VertexContainerType
◆ AIFFace() [1/2]
| FEVV::DataStructures::AIF::AIFFace::AIFFace |
( |
| ) |
|
|
inlineprivate |
◆ AIFFace() [2/2]
| FEVV::DataStructures::AIF::AIFFace::AIFFace |
( |
const self & |
other | ) |
|
|
inlineprivate |
AIFFace copy constructor
Be careful, it create a new AIFFace with the same native
incidence relations AND the same index.
Definition at line 103 of file AIFFace.hpp.
◆ clear_vertex_incidency()
| void FEVV::DataStructures::AIF::AIFFace::clear_vertex_incidency |
( |
| ) |
|
|
inline |
Clear vertex incidency caching.
Definition at line 186 of file AIFFace.hpp.
◆ GetDegree()
| unsigned int FEVV::DataStructures::AIF::AIFFace::GetDegree |
( |
| ) |
|
|
inline |
Degree getter
- Returns
- The number of incident edges of the involved face.
Definition at line 173 of file AIFFace.hpp.
◆ GetIncidentEdges() [1/2]
| boost::iterator_range< EdgeContainerType::iterator > FEVV::DataStructures::AIF::AIFFace::GetIncidentEdges |
( |
| ) |
|
|
inline |
Native incidence relations getter
- Returns
- An iterator range on the incident edges (AIFEdge pointer) of the involved face.
Definition at line 163 of file AIFFace.hpp.
◆ GetIncidentEdges() [2/2]
| boost::iterator_range< EdgeContainerType::const_iterator > FEVV::DataStructures::AIF::AIFFace::GetIncidentEdges |
( |
| ) |
const |
|
inline |
Native incidence relations getter
- Returns
- An iterator range on the incident edges (AIFEdge pointer) of the involved face.
Definition at line 152 of file AIFFace.hpp.
◆ GetIncidentVertices()
| boost::iterator_range< AIFFace::VertexContainerType::const_iterator > FEVV::DataStructures::AIF::AIFFace::GetIncidentVertices |
( |
| ) |
|
|
inline |
Native incidence relations getter
- Returns
- An iterator range on the incident vertices (AIFVertex pointer) of the involved face.
Definition at line 47 of file AIFFace.inl.
◆ GetIndex()
| std::size_t FEVV::DataStructures::AIF::AIFFace::GetIndex |
( |
| ) |
const |
|
inline |
Index getter
- Returns
- The index of the involved face.
Definition at line 130 of file AIFFace.hpp.
◆ New() [1/2]
Static constructor method
- Returns
- A pointer to a new instance of AIFFace class.
Definition at line 19 of file AIFFace.inl.
◆ New() [2/2]
Static constructor method
- Parameters
-
- Returns
- A pointer to a new instance of AIFFace class.
Definition at line 27 of file AIFFace.inl.
◆ operator!=()
| bool FEVV::DataStructures::AIF::AIFFace::operator!= |
( |
const self & |
other | ) |
const |
|
inline |
difference operator
- Parameters
-
| other | The second face to compare with the current one. |
- Returns
- True if the current AIFFace is different from other one. Else return false;
Definition at line 214 of file AIFFace.hpp.
◆ operator<()
| bool FEVV::DataStructures::AIF::AIFFace::operator< |
( |
const self & |
other | ) |
const |
|
inline |
Less operator (natural ordering)
- Parameters
-
| other | The second face to compare with the current one. |
- Returns
- True if the current AIFFace is strictly less than the other one. Else return false;
Definition at line 200 of file AIFFace.hpp.
◆ operator<=()
| bool FEVV::DataStructures::AIF::AIFFace::operator<= |
( |
const self & |
other | ) |
const |
|
inline |
Less or equals operator
- Parameters
-
| other | The second face to compare with the current one. |
- Returns
- True if the current AIFFace is less or equal to other one. Else return false;
Definition at line 221 of file AIFFace.hpp.
◆ operator==()
| bool FEVV::DataStructures::AIF::AIFFace::operator== |
( |
const self & |
other | ) |
const |
|
inline |
equality operator
- Parameters
-
| other | The second face to compare with the current one. |
- Returns
- True if the current AIFFace is equal to other one. Else return false;
Definition at line 207 of file AIFFace.hpp.
◆ operator>()
| bool FEVV::DataStructures::AIF::AIFFace::operator> |
( |
const self & |
other | ) |
const |
|
inline |
Greater operator
- Parameters
-
| other | The second face to compare with the current one. |
- Returns
- True if the current AIFFace is strictly greater to other one. Else return false;
Definition at line 238 of file AIFFace.hpp.
◆ operator>=()
| bool FEVV::DataStructures::AIF::AIFFace::operator>= |
( |
const self & |
other | ) |
const |
|
inline |
Greater or equals operator
- Parameters
-
| other | The second face to compare with the current one. |
- Returns
- True if the current AIFFace is greater or equal to other one. Else return false;
Definition at line 231 of file AIFFace.hpp.
◆ Print()
| void FEVV::DataStructures::AIF::AIFFace::Print |
( |
| ) |
const |
|
inline |
Print the textual description of the involved face on the standard
output.
Definition at line 35 of file AIFFace.inl.
◆ SetIndex()
| void FEVV::DataStructures::AIF::AIFFace::SetIndex |
( |
std::size_t |
idx | ) |
|
|
inline |
Index setter
- Parameters
-
| The | index of the involved face. |
Definition at line 135 of file AIFFace.hpp.
◆ AIFTopologyHelpers
◆ m_Incident_PtrEdges
◆ m_Incident_PtrVertices
Container on incident vertices (AIFVertex pointer).
This container is filled only on demand and is modified if
necessary.
Definition at line 82 of file AIFFace.hpp.
◆ m_Index
| std::size_t FEVV::DataStructures::AIF::AIFFace::m_Index |
|
private |
◆ m_Is_Incident_PtrVertices_Computed
| bool FEVV::DataStructures::AIF::AIFFace::m_Is_Incident_PtrVertices_Computed |
|
private |
Face-incident-vertices cache validity flag.
Definition at line 87 of file AIFFace.hpp.
The documentation for this class was generated from the following files:
- /Users/mac/builds/efd823a3/0/MEPP-team/MEPP2/FEVV/DataStructures/AIF/AIFFace.hpp
- /Users/mac/builds/efd823a3/0/MEPP-team/MEPP2/FEVV/DataStructures/AIF/AIFFace.inl
